shapestack

IMPORTANT: This bot is still in early development, so it's not yet fit for actual use. There are likely many ways to break it!

About

shapestack is a Discord bot featuring commands and utilities related to the open-source game shapez.io.

This bot is written in TypeScript. It's pretty cool!

Using

DISCLAIMER: While these instructions are relatively generic, I am not guaranteeing that following them will not cause any damage to your computer. Make sure you understand what you are doing!

This bot requires Node.js. I'm not sure the specific versions that work, but any 16.7+ should work fine.

Make sure you've created an application in the Discord Developer Portal and have added a bot. (Tutorial from the Discord.js Guide)

Editing

If you want to use this bot core or contribute:

1. Clone the repo with git.

2. Install dependencies by running npm install in the repo folder.

3. Rename secrets.example.json to secrets.json and fill in your application's bot token.

Now, you can launch the bot by running npm run dev. This uses nodemon to re-build and restart the bot whenever a change is made to the source directory src. You can also manually build with npm run build and run with npm start.

Commands can be added in src/commands. See the default commands and typedefs for syntax.