tomhobson / sergen

A discord chat bot and docker controller to create game servers easily.

Sergen

This discord bot will create servers that run out of the box.

Simply typing -run Minecraft will generate you a server on the latest version of minecraft with a world that is located within /opt/Sergen/serverfiles/{discordserverid}/Minecraft

All the supported images below will work with no issues. There are some work in progress game servers, but I haven't fully tested them so there's no guarantee they'll work.

Try it out here: https://discord.gg/aJpFaS2U

Supported Servers

• Minecraft Java Edition
• Minecraft Bedrock Edition
• Factorio
• Valheim
• OpenTTD

If there's any servers you'd desperately like to see, feel free to open an issue.

Requirements

• Windows/Linux (Not tested on a mac)
• Docker
• Dotnet 6.0 runtime

Installation

A systemd service is the recommended way to run Sergen. I create and run the service within the install scripts. If you don't want it setup this way, don't use the install scripts.

• Download the latest build from the releases section. Extract it, then run ./Install.sh
• Clone the git repo and run BuildAndInstall.sh

Setup

You'll need to setup a bot with discord, found here: https://discord.com/developers/applications

Here's an article on how to do it: https://www.howtogeek.com/364225/how-to-make-your-own-discord-bot/ (just do up before the Node.js part)

Get your token and update https://github.com/tomhobson/Sergen/blob/master/src/Sergen.Main/appsettings.json. Replace PUTBOTTOKENHERE with the token generated from https://discord.com/developers/applications.

You'll need to restart the service and invite your bot, which can be done with this link: https://discord.com/oauth2/authorize?client_id=123456789&scope=bot

Replace 123456789 with your bot's client id.

Allowlists

Sergen has allowlist implementation, for if you're running this on a big server and want to make sure only certain users can start and stop servers.

To enable this run: -allowlist enable

To add a user to the allowlist run: -allowlist add @discorduser

Only the server owner will be able to manage the allowlist.

Troubleshooting

Feel free to open an issue if you're having trouble setting this up, I'll be happy to help.

sergen's Issues

Create master and slave projects

Setup Nginx

Decide on license

GPL, MIT, GNU? Beerware???

Default config for game server

With factorio the default config is to be public and force user authentication.

Sergen should allow a 'default' config file or even whole directory (whole dir would allow persistent game saves) to be used when creating a new game server.

Add Minecraft Bedrock Edition

Actually version the releases

Configurations for gamservers

We could have some multi-selection options for each game server.

Eg: Minecraft: Skyblock, Hardcore, Flatland and Vanilla
Terraria: Small, Medium, Large
Factorio: Railworld, biter world.

And so on.

readme needed

Setup slave setup documentation

Pre-configure some settings

Instead of just a json file we should have a directory with some pre setup configs.

This would also mean we need an extra parameter on the game server (take the default if no parameter is supplied)

We'll need to work out how to handle spaces in the server names etc

Eg minecraft -- creative flatland, survival, hardcore

Factorio -- railworld, normal

ksp -- sandbox, survival and career

Allow pass through environment variables from docker image

To be able to setup a server like starbound we need a steam username and password. So we need a way for a slave to configure this for themselves then we can use this when creating the docker image

Setup RCON interface to allow for commands sent to game servers that support it

Add Connection between main and secondary (GRPC?)

Setup bot documentation

Don't lie and say starting when we're not starting

-run SomethingThatsNotAGameServer

Sergen responds starting when it's not doing anything

Should respond along the lines
Image could not be found. Find all possible game servers with -possible

Add Database (Still haven't decided which one)

Handle steam username + password

Setup auto deploy from github actions to UAT Url

Handle Multiple Ports

If game servers are renamed or moved. Currently the install script duplicates them

I'd like to support custom json for servers (ie if someone has their own docker image) so I wouldn't like to purge the game servers every time. But i'd really like them to stay as json within the project.

I think we need another 'custom-gameservers' directory and then purge gameservers every time we reinstall

Add basic web interface

Add Tekkit to server collection

Obtain current ip to post server availability

Setup FTP on server

Terraria won't run

This is due to not binding to the stdin and stdout. Will need to get this working in docker dotnet.

unsure if we should have a parameter on the game server json or if we just do it for all of them to keep the configs neat and uniform.

Move secrets out of projects

secrets in project = bad.

See if we can move to a different method for secrets. Should probably just add the appsetting.json and appsettings.development.json to be removed of secrets