Code Monkey home page Code Monkey logo

themis-bot's Introduction

Build Status Coverage Status Known Vulnerabilities

Themis

A Simple Discord chat bot using the Discord.js API library.

Getting Started

Currently, you must host the bot somewhere consistently connected to the internet. In order to get your bot up and running you'll need a set of Discord app / bot credentials. You can obtain these by logging into Discord in your browser, then going to: https://discordapp.com/developers/applications/me

You will need to make an application, then make a bot for that application. Once you make a bot for the application, you can get the necessary token and client_id to allow your bot to connect. See below for details on putting these values into the bot's configuration files. Once your bot has connected, it will print out a URL you can use to invite the bot to servers you either own or administer. If during registration you had set your Discord App to "private", only you will be able to add the bot to servers, preventing other people from using it while you develop features.

Commands

  • !ping
  • !uptime
  • !roll syntax or !r syntax or !roll 1d20...

Local Development / installation

  • install [node.js]
  • Run npm install
  • Copy config/config.js.example to config/config.js
  • Enter any relevant authentication or API keys for your bot into config/config.js
  • Run npm start

Developing plugins

  1. Create a new javascript file under src/plugins/
  2. Pull in the Themis api:
const api = require('../api');
  1. Export a api.Plugin as your module's default export:
module.exports = new api.Plugin('myAwesomePlugin', commands, events, setupFunction);

If you would like your plugin to actually DO something, it should expose some commands or listen for some events.

Contributing

If you would like to contribute to this project, fork it, and send a pull request. See CONTRIBUTING.md.

License

GPL v3.0

themis-bot's People

Contributors

ryansn avatar bsredbeard avatar greenkeeper[bot] avatar

Watchers

James Cloos avatar

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.