Note
The mod is currently a work in progress! Please report any broken stuff you find!
Welcome to the repository for RimWorld Together
! Here you will find everything related to the project, a great place for the tech savvies!
Thanks to the way the server is built, there aren't any heavy hardware related dependencies, meaning that your hosting machine will only need to have an excellent network bandwith and a bit of everything else. Really, modern e-toasters could run it.
We provide helper scripts to build and run the official RimWorld-Together Container with buildah and podman
Build:
make build-container
Run:
make run-container
To access our documentation and deployment examples, please run the following command:
git submodule update --init --recursive
This will clone (or update) our Guide and Deployments project. You can also use the --recurse-submodules
flag on your initial clone to automatically pull the documentation at the same time.
Please read our contribution guide before contributing!
Please don't hesitate to create an issue on Github if you have any questions/issues with the mod. We are here for you! You can also contact us via our Discord server (see top of this page).