Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.77 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.77 KB

ShapeBot Editor

This is a little bot to extend ShapeBot basic features (role management) with commands intended for the end user.

Setup

Requirements: Node.js, Yarnpkg. Depending on your operating system, a C/C++ compiler may be required.

  • Clone the repository.
  • Install dependencies by running yarn.
  • Copy and adjust the configuration file (config.json).
  • Finally, run the bot: node ..

Features

  • sbe:compress: Compress a JSON data into shapez.io savegame format.
  • sbe:decompress: Decode and decompress shapez.io savegame into human-readable JSON.
  • sbe:puzzle <key>: Display a puzzle using the short key.
  • sbe:reports <key/username>: View reports for a puzzle or by username.
  • sbe:puzzlesearch [search terms]: Search the puzzle collection.
  • sbe:xban <reason>: Ban a user in all servers where you have Ban Members permission.
  • sbe:unlock <keywords>: Show the level required to unlock a building/feature.

Configuration

  • token: Discord bot token, required to login.
  • apiToken: Token for shapez.io API, required to access puzzles.
  • puzzleWatchlist: List of channel IDs to automatically run sbe:puzzle in.
  • trustedRoles: List of role IDs permitted to use instruction viewer.
  • antiSpamEnabled: Enable or disable simple automated spam detection.
  • upvoteThreshold: Amount of emoji required to pin a message. Set to 0 in order to disable pins.
  • upvoteEmojis: List of emoji IDs required for a message to get pinned.
  • upvoteWatchlist: List of channel IDs where messages will be pinned.
  • disabledCommands: Disable specific commands for each server.

Licensed under GNU General Public License, Version 3. Assets are taken from the shapez.io GitHub repository.