LibreAdventure is a fork of the last freely licensed version of WorkAdventure, plus a map and small changes for use at LibrePlanet 2021/2022. Renaming is incomplete.
At FSF, we mainly want to fix a bug for LibrePlanet 2022 (https://todo.sr.ht/~iank/libreadventure/1), and if we can find some other improvements to make that would be good too.
#fsfsys on libera.chat and the SourceHut mailing list for this project are the main place to ask questions and coordinate. Yes, we know there are little to no posts on the mailing list yet, don't let that stop you.
There exists an instance of this code at an FSF server,
play.libreadventure.org. If you want to help with LibreAdventure, FSF
tech team is giving access to test changes there to people they think are
trustworthy (they have done some work volunteering or something). If you
think you one of those people, email email@example.com with your public
ssh key and join
#fsfsys and say that you've emailed your key and want to help with
LibreAdventure. The FSF tech team will add your key to the server.
Before making changes to the server please say something on #fsfsys in
order to make coordinate with any other volunteer who may be working on
it. The main way to run the software on the FSF server is with
cd /srv/libreadventure-deployment; docker-compose restart, then browse to
https://play.libreadventure.fsf.org. The standard out of docker-compose
is useful for development, so if multiple people want to work on it at
the same time, you will probably need to coordinate to make it visible
to multiple people, like sharing an tmux or screen, or redirecting it to
a log file that can be tailed.
Feel free to have a look at the upstream version of WorkAdventure and explore improvements made there. We should not copy any code because the upstream is under an incompatible license.
This package is licensed AGPLv3. There is no indication in the repo of whether the original authors meant AGPLv3 or later or only. We are waiting to hear from them. Any contribution you make is assumed to be dual licensed AGPLv3 only and AGPLv3 or later, so that when the original license gets clarified, we will distribute under that.
Work Adventure is a web-based collaborative workspace for small to medium teams (2-100 people) presented in the form of a 16-bit video game.
In Work Adventure, you can move around your office and talk to your colleagues (using a video-chat feature that is triggered when you move next to a colleague).
The environment will start.
You should now be able to browse to http://workadventure.localhost/ and see the application.
Note: on some OSes, you will need to add this line to your
If you want to design your own map, you can use Tiled.
A few things to notice:
In order to define a default start position, you MUST create a layer named "start" on your map. This layer MUST contain at least one tile. The players will start on the tile of this layer. If the layer contains many tiles selected, the players will start randomly on one of those tiles.
In order to place an exit on your scene that leads to another scene:
/<map folder>/<map>.json. Be careful, if you want the next map to be correctly loaded, you must check that the map files are in folder
back/src/Assets/Maps/<your map folder>. The files will be accessible by url
<HOST>/map/files/<your map folder>/....
exitSceneUrland have tiles that represent exits to another scene.
Often your map will have several exits, and therefore, several entry points. For instance, if there is an exit by a door that leads to the garden map, when you come back from the garden you expect to come back by the same door. Therefore, a map can have several entry points. Those entry points are "named" (they have a name).
In order to create a named entry point:
If you are using MacOS, you can increase Docker performance using Vagrant. If you want more explanations, you can read this medium article.
Create a config file
cp Vagrantfile.template Vagrantfile
VM_HOST_PATH with the local project path of your machine.
#VM_HOST_PATH# => your local machine path to the project
pwd and copy the path in this variable)
To start your VM Vagrant, run:
To connect to your VM, run:
To start project environment, run
You environment runs in you VM Vagrant. When you want stop your VM, you can run:
If you want to destroy, you can run
Vagrant up: start your VM Vagrant.
Vagrant reload: reload your VM Vagrant when you change Vagrantfile.
Vagrant ssh: connect on your VM Vagrant.
Vagrant halt: stop your VM Vagrant.
Vagrant destroy: delete your VM Vagrant.
You have more details of features developed in back README.md.