Installation

CloudVoxel is a flexible software. You can download it on any machine as soon as you can install Bun (see Bun Installation). You can start right away by installing bun and running this install script:

# This will download the code and install all the dependencies for you
curl -fsSL https://raw.githubusercontent.com/OpenVoxelStudios/CloudVoxel/refs/heads/main/install.sh | bash

Or you can run the following (it will do the same process):

git clone https://github.com/OpenVoxelStudios/CloudVoxel.git
cd CloudVoxel

# Prepare all the config files
cp .env.example .env.production
cp .env.example .env.development
cp clientconfig.example.ts clientconfig.ts
cp config.example.ts config.ts

# This will install dependencies and run post install scripts
bun install
bun pm trust --all

# This will create an empty database ready to use
bun run db.generate
bun run db.migrate

And there you go! Your instance is (almost) ready!

Visit Configuration for the next steps!