Giter VIP home page Giter VIP logo

sb-editor's Introduction

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.

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.
  • viewerAccessRoles: List of role IDs permitted to use shape viewer.
  • antiSpamEnabled: Controls automatic spam detection.
  • antiSpamRole: If automatic spam detection is enabled, specify a role ID to assign here.

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.