Tocu Laboratories

This is the code of the semi-official Transformice module #toculabs. It is used to test and publish useful stuff. An example, is the room-gateway script, which is currently in use in the youtube submode, hosted at #toculabs0youtube.

How does the code run in Transformice?

As you can see, here it is splitted in different files to make the development easier and organized. Before sending it to Transformice, we need to turn it into a single file. This process is called building and is automatically done via a Github workflow everytime we push something with the [build] keyword in a commit. You can find the latest build here, or you might also check older builds here. After it is built, if the commit has a [host] keyword it will also host it in Transformice. You can check the hosted build here.

You can also check our builder here and our hoster here. Remember it runs along with a workflow that is here. Our builder follows the instructions of the init.lua script, specified with tags. Currently there is a single tag with many variations (require-file, require-dir, require-package). If you require a package like modes/youtube, it'll read modes/youtube/package.json and execute its content as tags.

Can I host something here too?

Of course you can. Feel free to fork the repository, add your own submode and once you're done, create a pull request. If it requires to run a bot you will need to host it yourself (or use heroku.com), but you will need to post the source code of it here. Remember to use environment variables for your credentials and sensitive data!
You can also use tools listed here, such as room-gateway.lua, located here.
You can do the same if you want to translate anything. Find all the translations here.

How is the repository structure?

In the builds directory you'll find all the module builds.
In the bots directory you'll find all the bots used for the module.
In the global directory you'll find essential scripts used on the whole module.
In the modes directory you'll find all the module modes.
In the tech directory you'll find useful libraries.
In the translations directory you'll find the module translations.
The builder.py file is what we use to build the module.
The hoster.py file is what we use to host the module ingame.
The init.lua file is the main file containing most of the build instructions.
The Procfile file is a file to host the bots in heroku.
The requirements.txt file contains all the python requirements for the bots.

You will find README.md files containing information of where you are inside most of the directories.