Documentation

Everything you need to build, publish, and extend SolisVox games

Navigation

Getting Started

  1. Download the SolisVox engine from the launcher or website
  2. Open the engine and create a new project
  3. Add a manifest.json to your project root
  4. Build your game using GDScript, the voxel API, and Lua mods
  5. Publish from the Studio plugin when ready

Publishing a Game

Open your game project in the SolisVox editor. The Studio plugin auto-detects your project and reads manifest.json. Log in with your SolisVox account, then click "Publish". Your game will be packaged as an SVP file and uploaded to the registry.

REST API

All API endpoints are under /api/v1/.

MethodPathDescription
POST/api/registerRegister new user
POST/api/loginLog in, get session token
GET/api/meGet current user profile
GET/api/v1/registry/gamesList games (paginated)
GET/api/v1/registry/games/{id}Get game details
POST/api/v1/registry/gamesPublish new game
GET/api/v1/registry/search?q=Search games
GET/api/v1/social/friendsList friends
POST/api/v1/social/messagesSend message

Lua Mods

Games can include Lua mods in a mods/ directory. Each mod needs a mod_manifest.json and an init.lua. Mods can register chat commands, custom blocks, crafting recipes, and hook into game lifecycle events.

Manifest Format

{
  "id": "com.example.my_game",
  "name": "My Game",
  "version": "1.0.0",
  "engine_version": ">=0.1.0",
  "author": "Your Name",
  "description": "A short description of your game.",
  "category": "sandbox",
  "tags": ["multiplayer", "crafting"],
  "entry_scene": "res://scenes/main.tscn",
  "multiplayer": {
    "enabled": true,
    "max_players": 32
  },
  "terrain": {
    "enabled": true,
    "type": "voxel",
    "chunk_size": 32
  }
}