https://github.com/emeraldblock/shapestack
A Discord bot about shapez.io.
https://github.com/emeraldblock/shapestack
Last synced: about 1 year ago
JSON representation
A Discord bot about shapez.io.
- Host: GitHub
- URL: https://github.com/emeraldblock/shapestack
- Owner: EmeraldBlock
- License: gpl-3.0
- Created: 2021-10-09T17:18:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-09T17:20:14.000Z (over 4 years ago)
- Last Synced: 2025-02-12T19:48:09.134Z (over 1 year ago)
- Language: TypeScript
- Size: 1.87 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/tobspr/shapez.io/).
This bot is written in [TypeScript](https://www.typescriptlang.org/). 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](https://nodejs.org/). I'm not sure the specific versions that work, but any 16.7+ should work fine.
Make sure you've created an [application](https://discord.com/developers/applications) in the Discord Developer Portal and have added a bot. ([Tutorial](https://discordjs.guide/preparations/setting-up-a-bot-application.html) from the Discord.js Guide)
### Editing
If you want to use this bot core or contribute:
1. Clone the repo with [git](https://git-scm.com/).
2. Install dependencies by running `npm install` in the repo folder.
3. Rename [`secrets.example.json`](src/config/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](https://nodemon.io/) to re-build and restart the bot whenever a change is made to the source directory [`src`](src). You can also manually build with `npm run build` and run with `npm start`.
Commands can be added in [`src/commands`](src/commands). See the default commands and typedefs for syntax.