Warning: This project should be considered alpha maturity and is intended for early evaluation. Config files and worker directories are not laid out as best practice or as an example of good project layout - instead, they're laid out to demonstrate the flexibility now available in the project layout.
This is a simple SpatialOS project with two C# server workers (HelloWorker and DiceWorker) and one C# client worker (Client).
It doesn't require any specific locations for the SpatialOS files - you can put them anywhere in the project as long as you reference them in the spatialos.json file.
Note: SpatialOS expects the workers to be pre-built, and only contains information on how to run them. This means the
spatial worker buildcommand is unavailable - you're responsible for building your workers (see Building the project below).
See the SpatialOS documentation to set up the spatial CLI.
Run spatial update to ensure you have the latest version of the spatial command line tool which includes the features required for this example project.
Mac users: ensure that xbuild is on your PATH. xbuild is provided by Mono.
Windows users: ensure that MSBuild.exe is on your PATH. MSBuild.exe is provided by the .NET Framework.
Bash is required for running the build script, although as an alternative you can complete these steps manually. There are several options to install bash on Windows, although we recommend GitBash.
We've tested the project with the following:
- Mono 4.4 (Mac)
- .NET Framework 4.5 (Windows)
- GitBash 2.18 (Windows)
The custom layout is enabled by the spatial tool detecting a new-format spatialos.json file.
spatial local launch and spatial cloud launch work differently for a flexible project. You only get access to the new versions of these commands when you are either:
- inside a directory containing a new-format
spatialos.json, or - when referencing a new-format
spatialos.jsonusing the--main_configflag
Both spatial local launch and spatial cloud launch have a new parameter, --world, which points to a world configuration file. This flag is required to launch a deployment, although by default a file named world.json in the current working directory will be used if you don't pass the flag in.
You can access this information at any time by using the --help flag in the spatial command line tool.
Run ./build.sh to build the workers and compile the schema descriptor. You can complete these steps manually if required.
Workers are built in their own bin directories:
- HelloWorker:
HelloWorker/bin - DiceWorker:
OtherWorkers/DiceWorker/bin - Client:
OtherWorkers/Interactive/client/bin
Run ./clean.sh to delete all build files, including worker binaries and any intermediate files generated during the build process.
To launch a local instance of SpatialOS running the project, run spatial local launch from the SpatialOS directory (or from any location by specifying the --main_config=\<path to spatialos.json\> flag). This starts SpatialOS locally and runs the server workers HelloWorker and DiceWorker.
You can find the client binaries in OtherWorkers/Interactive/client/bin/x64/ReleaseWindows (or ReleaseMacOS for Mac).
Connect your client by opening a second terminal to run the binary directly (from inside the ReleaseWindows or ReleaseMacOS directories):
- Windows:
./Client.exe localhost 7777 <client_id> - macOS:
mono --arch=64 Client.exe localhost 7777 <client_id>
This connects a client that pings the HelloWorker and DiceWorker every few seconds and then prints the response.