EMCS-Rewritten

A rewritten version of the EarthMC Stats Discord bot in Go.
This rewrite aims to make the bot self-hostable, with the EMCS Rewritten Discord bot being one of these instances.

Why the rewrite?

I started this bot in hopes that it will be more powerful than EMCS with massive improvements to performance and stability. The database will be local, so you are responsible for upkeep of data. For 24/7 uptime, use a VPS or self-host with a Raspberry Pi etc.

EMCSRW should be much easier to maintain and has been designed around the Official API mainly, rather than outdated map data. While map data may still be used in certain cases or if the OAPI goes down, I believe this rewrite was necessary as the previous bot had too much technical debt to make it worth the time and effort of updating, as well as the Firestore DB being severely limited with it being so popular as read/writes were almost always maxed out.

Development

1. Clone this repository.

2. Create a Discord bot and put its Client Token in an .env file in the project root like so:

   export BOT_TOKEN=yourTokenHere

3. Authorize and invite your bot to a guild or install it as a user app.

4. Start the bot with go run main.go.

Custom API

Warning

Only serve an API if you know what you are doing. If your reverse proxy throws errors, ensure it is properly reloaded and the port is open!

By default, a custom API is not served. To serve one, simply add the following variable to your .env file. After that, you must make sure you have a reverse proxy set up to port localhost:7777 (configurable in future).

export ENABLE_API=true

For example, here is a small Caddyfile you can use if you already have Caddy set up.

your.domain.com {
	# Set this path to your site's directory.
	# root * /usr/share/caddy

    # where the reverse proxy should listen.
	reverse_proxy localhost:7777

	# compression
	encode zstd gzip

	# headers perms. by default a GET request is allowed from any origin
	header {
        Access-Control-Allow-Methods GET
		Access-Control-Allow-Origin *
		# Access-Control-Allow-Headers *
	}
}

Contributing

If you know Golang and the basics of the discordgo library, I encourage you to create pull requests or suggest features. You can also fork this project and use it as a base if you so desire, but the GPL license requires you to keep the source code available.

Project Structure

• main.go -> Project entrypoint. Responsible for loading env and passing bot token to bot.Run.
• bot -> Where the bot runs from. Contains all bot logic for commands, events, discord and db init etc.
  • events -> The package where discord event handlers like OnReady are run and are handled.
  • bot.go -> The file the bot actually runs from, responsible for setting up discord, opening connections and handling bot exit.
• api -> Contains packages relating to APIs. Contains funcs that interact with both where necessary.
  • mapi -> For interacting with the map API. (Currently Squaremap)
  • oapi -> For interacting with the Official API.
  • capi -> Serves a Custom API using info from the database package. NOT REQUIRED IF FORKING.
• database -> For all code that relates to or interacts with a DB or store/cache.
• db -> Where permanent data such as alliances are intended to be stored. Git ignored.
• shared -> For things that can be shared, e.g. constants or embed related funcs/vars.
• utils -> Contains packages for reusable funcs like helpers for strings, slices, http, logging etc.