Giter Club home page Giter Club logo

byond_discord's Introduction

Byond Discord Bot

Discord Bot which can communicate with Byond Game Servers and trigger the world/Topic() proc to execute server side code and retrieve information back from the server.

Requirements

Installation & Configuration

Before starting your bot you will need to invite it to your server first. I recommend using this for beginners: https://discordapi.com/permissions.html Your bot will need following permissions:

  • Read Messages
  • Embed Links
  • Read Message History
  • Send Messages
  • Attach Files
  • Mention @everyone

It's a bit more than the bot actually needs but if anything new is beeing added to the bot, it will already have the permissions to do it. Enter your bot client ID into the field down below in the Permission Calculator. You can get it from your bot application site where you created your bot. Next click on the link at the bottom and invite the bot to your server.

To configure the bot open the config.json file in the src folder and enter your bot token, globalCommandPrefix and ownerID. The byondTopic host settings have to be the address or domain of your byond game server, port is the port of your byond game server. the notifications settings contains role ID is to ping the user when he signed up to be notified for server startup. The last one byondImport is the settings for the webserver which listens to commands and messages from the byond game server, you can enable or disable it here and set the port it listens to.

Go into the Byond Discord root folder and type

npm prestart

To start the bot just simply type

npm start

Contributing

  1. Fork it (https://github.com/v0idp/byond_discord/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

byond_discord's People

Contributors

v0idp avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

allfd blinkuz

byond_discord's Issues

Additional Features

It would be nice to be able to have commands to see the crew manifest (for seeing if a job slot you want is open without logging in) and current round time (for seeing how long you (usually) have to wait before a new round starts) added to the bot for increased functionality.

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.