EN ‐ Gamemaster Mode

From the releases of this repository you can download a peculiar application, called Egobalego at Home.

This is the "Gamemaster Console," a web app that allows anyone with permission to take control of the mod in another player's instance and perform actions such as controlling the spawn of structures, dialogues, and exchanges of the researcher, executing commands, and much more!

To use it, you first need to have Python installed (tests have been conducted with Python 3.10 and 3.12, and dependencies have been frozen to avoid future issues).

Once that is done, download the zip file corresponding to the version of the mod you want to use from the releases, extract the folder contained within it, and run the start-server-english.bat script. A terminal window should pop up, that you can close to stop the program.

The first launch will take some time (for the techies: as it needs to create a Python virtual environment within the folder and install the dependencies to run the web app). This should take care of installing everything required, without needing technical knowledge. Once finished, the console will open in the browser, and from there you can follow the guides on the various pages.

One of the simplest methods to make the server accessible externally is by using Ngrok.

Brief guide for Ngrok

• Go to the dashboard on the Ngrok website (it should open on the "Setup & Installation" page; you need to create an account to access it);
• Install Ngrok from the terminal with the command choco install ngrok or by directly downloading the .exe file (under the "Download" tab next to "Chocolatey"), if the previous command doesn’t work;
• Copy the command starting with ngrok config add-authtoken and run it in the terminal to log in (if you've downloaded the .exe file, run it first to set the terminal to the correct folder);
• From the domains section of the Ngrok dashboard claim your free static domain and save it somewhere;
• To open the server, simply use the command ngrok http --url=<YOUR-STATIC-DOMAIN> 5000 (5000 is the port on localhost where the console runs) in the same way every time you use Egobalego at Home.

Moving on to the mod configuration for those who will connect to the endpoint, it is recommended that you configure the mod on their behalf to avoid spoilers. Here are the steps to follow:

• Open the game to generate the ruins-of-growsseth.jsonc configuration file in the config folder of your modded instance.
• Disable the spawn of all structures in the structures category.
• Go to the web section, enable web synchronization (first option), and set the URL of your server (if you are using Ngrok it's your static domain).
  If you think it might be useful, also enable the remote commands setting to execute any type of vanilla command (it is assumed that the person relying on you trusts you not to cause any harm), and the Live Update service to make use of the websocket functionality (it allows sending events in real time instead of waiting for the mod to reload every x minutes; enable it and put the same URL of the web sync setting to use it).
• Pass the config file and have it placed in the instance of the person who will be playing, and you can finally start!

If you are a server admin, you can also use the /gmaster command to do the configuration in-game from your server, if you prefer that. It also allows to monitor the Gamemaster mode status and connections.

Important note: Always remember to test the various events in a test world before the actual session!

Another important note: Spawning a structure generates the corresponding map trade.