https://github.com/liyard-tls/GravitationioCardinal
https://github.com/liyard-tls/GravitationioCardinal
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/liyard-tls/GravitationioCardinal
- Owner: trixie-dev
- Created: 2024-06-07T17:40:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T15:41:31.000Z (about 2 years ago)
- Last Synced: 2024-12-30T20:13:24.808Z (over 1 year ago)
- Language: Go
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Starter Game Template
This repository contains a starter World Engine project that you can use as a scaffold for your project.
## Installing World CLI
To begin your development journey with World Engine, you install
[World CLI](https://github.com/Argus-Labs/world-cli) a tool for creating, managing, and deploying World
Engine projects.
Install the latest world-cli release by running:
```bash
curl https://install.world.dev/cli! | bash
```
### Docker
Docker is used to make it easy to run the World Engine stack and its dependencies. If you don't already have Docker
installed, you can find instructions for your platform here:
[Installation instructions for Docker Desktop](https://docs.docker.com/compose/install/#scenario-one-install-docker-desktop)
## Getting Started
To use this template to start your own project, navigate to the directory where you want your project to live
and run:
```bash
world create
```
You will be prompted for a game name. A copy of the starter-game-template will be created in the current directory.
### Running Development Mode
World Engine dev mode provides a fast and easy way to run and iterate on your game shard.
To use it, navigate to your project directory and run
```bash
world cardinal dev
```
### Running World Engine E2E
To run the World Engine stack end-to-end (i.e. in production and game engine integration), run:
```bash
world cardinal start
```
This command will use the `world.toml` config specified in your root project directory to run both World Engine's
Cardinal game shard and Nakama relayer (for game engine integration).
Make sure to set `CARDINAL_MODE="production"` in world.toml to run the stack in production mode and obtain the best performance.
### Cardinal Editor
The Cardinal Editor is a web-based companion app that makes game development of Cardinal easier. It allows you to inspect the state of Cardinal in real-time without any additional code.
To access it, run `world cardinal start` or `world cardinal dev`
Then, open the [Cardinal Editor](https://editor.world.dev) in a web browser.
After you create some entities in your game, it will show up on the Cardinal Editor.
## Developing Your Game
For more details on how to create the game of your dream, visit the [World Engine documentation](https://world.dev)