Skip to main content

Quick Start

Here are the steps to create a world project using XRift CLI and start the development server.

Creating a New Project​

xrift create my-world

You will configure the project name and other settings interactively. You can skip the interaction with the -y option.

Project Structure​

The created project already contains a sample world:

my-world/
├── src/
│   ├── World.tsx        # Main world component
│   └── components/      # Sample components
├── public/              # Assets (models, textures, etc.)
├── package.json
└── vite.config.ts

Starting the Development Server​

cd my-world
npm run dev

Open http://localhost:5173 in your browser to see the sample world.

Next Steps​