Giter Club home page Giter Club logo

astralmod's Introduction

AstralMod

Discord Moderation Bot for bits & Bytes, theShell and many other servers

Commands

For a full list of commands, use am:help in a channel. Use am:help [command] to look up help for a specific command. To get help with terminal commands, type help into the terminal.

Running AstralMod yourself

  1. Make sure you have Node.js installed. If it's recent enough it should work.
  2. Clone this repository into your folder of choice.
  3. Run npm install in this directory to install all of AstralMod's dependencies.
  4. Create a new file in the root directory of AstralMod called consts.js. Fill it with this (and specify your own information where necessary):
module.exports = {
    keys: {
        token: "", // This is where the token for your bot account goes
        settingsKey: "", // This is the encryption key for the settings file. What you input here really doesn't matter - it should be about 32 characters (if you go any longer it will be truncated). Don't change it or else you won't be able to use your settings file again. 
        yandexKey: "" // This is the token used for the Yandex.Translate API. You can leave this blank, but 'am:tr' will be disabled. If you want to use 'am:tr' though, you can get a token at https://tech.yandex.com/translate/ and insert it here.
    },
    config: {
        prefix: "am:", // This is the default prefix used by AstralMod.
        bprefix: "am#", // This is the default prefix used by AstralMod when it is running as AstralMod Blueprint.
        pinToPinEmoji: "๐Ÿ“Œ", // This is used as the emoji for the Portable Pins and the Pin to Pin feature. You can generally leave this as the default, but if you have other bots that interpret the ๐Ÿ“Œ emoji as something else, you might want to change it.
        calcProcess: "/usr/bin/thecalculator", // This is a path to the compiled binary for theCalculator, used for calculating expressions in 'am:calc'. You can leave this blank, but 'am:calc' will be disabled. You can grab a copy of theCalculator at https://github.com/vicr123/thecalculator/releases.
        emojiServer: "" // This is the server ID of a server that has all of the AstralMod-specific emoji. More information about setting up the emoji can be found below. You can leave this blank, but all custom emoji will be replaced by โžก.
    },
    colors: { // These are the colors used for embeds.
        done: "#FFC000",
        info: "#1E3C8C",
        fail: "#FF5000",
        none: "#36393F"
    }
}
  1. Run the bot by running node bot.js with your preferred options.

AstralMod Emoji?

Set up a server and upload the the emoji in the /emoji folder to it. You can change the actual emoji picture to whatever you want, but make sure to keep the names the same. Then, invite your bot into it, and set the emojiServer value in the consts.js file to the server ID of that server.

Command line options

  • --blueprint Runs AstralMod as AstralMod Blueprint. The version number is replaced with "Blueprint" and the prefix is changed.
  • --debug Enables debugging output in the console
  • --nowelcome Disables the welcome message that AstralMod sends when it joins a new server
  • --novacuum Disables the periodic cleanup of the settings file

Developing AstralMod

If you wish to add a command, look at the plugins directory. Make your own plugin to include commands. If you wish to modify the actual program, look at bot.js, or the AstralMod source code.

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.