Skip to content

A Discord bot to control a Veloren server.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

Songtronix/veloren-server-bot

Repository files navigation

Veloren Server Bot

Discord bot to control a git based veloren server.

Example Status of the server

Using

  1. Create an discord application here.
  2. Under the bot section enable it and copy the token.
  3. On the server setup a folder with the docker-compose.yml
  4. Replace the build: . directive with the image you want to use.
  5. Start the bot via docker-compose up and let it create the settings.
  6. Adjust all values in settings.yaml as desired.
  7. Start again.
  8. Bot is ready. If you want to have live logs follow the next steps.
  9. Setup an reverse proxy like caddy/nginx.
  10. Setup password based access (do not leak server logs publically) to the frontail container (forward to 9001).
  11. Logs should now be accessible.

Features

  • Git based (deploy branches or commits)
  • Live logs (based on frontail)
  • Configure Environment variables, Gameserver and cargo arguments
  • View, update, delete veloren configuration and download the server database (keep in mind discords upload limits)

Security

Only allow trusted members to access it as the bot allows arbitrary code execution as long as they have push rights to the codebase and the server run in the same container as the bot itself.

Contributing

Please see the CONTRIBUTING.md file for more details.

License

Veloren Server Bot is licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.