Documentation

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

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 experience using GDScript, the voxel API, and Lua mods
  5. Publish from the Studio plugin when ready

Publishing an Experience

Open your experience 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 experience 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 experiences (paginated)
GET/api/v1/registry/games/{id}Get experience details
POST/api/v1/registry/gamesPublish new experience
GET/api/v1/registry/search?q=Search experiences
GET/api/v1/social/friendsList friends
POST/api/v1/social/messagesSend message

Lua Mods

Experiences 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 experience lifecycle events.

Manifest Format

{
  "id": "com.example.my_game",
    "name": "My Experience",
  "version": "1.0.0",
  "engine_version": ">=0.1.0",
  "author": "Your Name",
    "description": "A short description of your experience.",
  "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
  }
}