Quartermaster Remastered

Create medals t-shirts and more with ease!

📖 Introduction

I began the development of the IRF Medal Bot in hopes to replace Quartermaster, which is annoying to use... I made a solid base for the bot and made sure it was very easy to use. Unfortunately, I'm leaving the "IRF" so development has been frozen. However, anyone can continue development. The bot runs, but it's missing various key features.

not an official IRF project

Features

Interaction with IRF's Trello to feed data to the bot. This way, it'd be much easier to handle new medals.
Type safety, is a lot better to maintain than Quartermaster, probably.
VERY user-friendly, I worked on grabbing the medals from any platform the user is on with ease. For PC, they can easily copy and paste the embed with a list of medals, including emojis. For mobile, they can take a picture of it, and the bot will use LOCAL, FREE, AND OPEN SOURCE image recognization to convert it into text, where the bot can understand it.
Easily change any stage level of a medal. All medal images must be sourced from a human, by manually cutting it out from the Medal_database.png file which can be found on IRF's Trello.

Watch the example on PC! (click the image, you can't embed videos in GitHub Readmes)

🤔 What's missing?

Followup embeds to tell the bot which medals should be hidden or only be shown as a ribbon.
T-shirt creation.
Veteran badges.
Proper citation support

🏗 Development

pnpm install
pnpm dev

If you want to use Nodemon to auto-reload while in development:

pnpm watch

💻 Production

pnpm install --prod
pnpm build
pnpm start

💻 OR USE PM2 for easy hosting (Production only)

pnpm install --prod
pnpm build
pm2 start build/main.js --name IRFMedalBot

🐋 Docker

To start the bot:

docker-compose up -d

To shut down the bot:

docker-compose down

To view the bot's logs:

docker-compose logs

For the full command list please view the Docker Documentation.

📜 Need help extending this bot?

romvnly-gaming / quartermaster-remastered Goto Github PK