Skip to content

EarthMC-Toolkit/EarthMC-Stats

Repository files navigation

EarthMC Stats

Discord Static Badge

The most popular Discord bot for EarthMC is now open source!

EarthMC Stats provides useful commands and info relating to players, towns, nations, alliances and more.
This bot relies heavily on the purpose-made NPM Library which handles the parsing and caching of map data automatically.

Notes

  • Duplicated code is slowly being phased out in favour of helper classes found in the common folder.
  • To reduce reads/writes, an in-memory cache is used alongside Firestore - please don't mess with this.
  • This repo is meant for viewing and attribution, hosting it yourself will NOT work.

Features

✅ Written in TypeScript for type-safety and intellisense.
✅ Uses modern ESM format which provides a nicer syntax and better module compatibility.
DiscordJS commands and events have their own files for clarity and maintainability.
Firestore database is used, allowing EMCS to be used seamlessly when EarthMC goes down.
✅ Fast responses via an in-memory cache and fast HTTP client thanks to Undici.

Disclaimer

This project has the Attribution-NonCommercial-ShareAlike 4.0 license.

You are free to:

Share - Copy and redistribute the material in any medium or format
Adapt - Remix, transform, and build upon the material

Under the following terms:

Attribution
You must give appropriate credit, provide a link to the license, and indicate if changes were made.
You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

NonCommercial
You may not use the material for commercial purposes.

ShareAlike
If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.