diff --git a/docs/workadventure.en.md b/docs/workadventure.en.md new file mode 100644 index 0000000000000000000000000000000000000000..34850930eb507bf55df246f08d94a68da846d6ee --- /dev/null +++ b/docs/workadventure.en.md @@ -0,0 +1,32 @@ +HowTo WorkAdventure +=== + +On this page we are trying to explain how we build the world and collect ressources how one can build an own world. + +## Software used + +The software we used is called [workadventure](https://workadventu.re), you can find the [sourcecode at github](https://github.com/thecodingmachine/workadventure). + + +## Setting up an own server + +The software is build to run in docker and comes with a docker-compose file, but currently it is not as easy as just bringing it up with `docker-compose up` as the readme states. + +### Step-by-step guide + +As the software changes very fast we can't provide an always up to date howto, but there is an [issue](https://github.com/thecodingmachine/workadventure/issues/574) mentioning some of the steps necessary as well as a [pad](https://pad.riseup.net/p/step_by_step_prod) trying to build such a guide. They are also working on [easing the deployment](https://github.com/thecodingmachine/workadventure/pull/698). + +[techinc.nl](https://wiki.techinc.nl/Work-Adventure/install) provides a pretty comprehensive install guide. + + +### Community forks + +There are several community forks, trying to ease deployment or integrating stale MRs: + +* https://github.com/tabascoeye/workadventure +* https://gitlab.hasi.it/herzi/project/workadventure +* https://git.binary-kitchen.de/noby/workadventure + +There is also a fork trying to build a federated version: + +* https://gitlab.com/fediventure/fediventure diff --git a/mkdocs.yml b/mkdocs.yml index 12842b54f2768f2642a16e65a8e2d84638f19a00..fe0286c86f30446143aeb1cdd63299b6b483372d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,7 @@ theme: nav: - Styleguide: 'styleguide.md' - Maps: maps.md - - Maschinenraum: 'maschinenraum.md' +# - Maschinenraum: 'maschinenraum.md' + - Workadventure: 'workadventure.en.md' - Play: 'play.md' - Sponsoring: 'sponsoring.md'