Giter VIP home page Giter VIP logo

sweote-discord-dice-roller's Introduction

SWEotE-Discord-Dice-Roller

CREDIT: Vampwood for conceiving the bot. A Discord Bot Companion for the SW:EotE RPG

#Usage

  • !roll [1y 2g 3b 4blk 5r 6p 7d 7w "A Comment for this Roll"]
    Parameters are usable in any order and all parameters are optional.

    For Example:

    • !roll 3g 2blk "Attack on Trooper 1"
    • !roll 2blk "Attack on Trooper 1" 3g

    Both command structures are treated the same way by the bot.

    Dice results and cancellations are computed by the bot so you don't have to!
    Only the remaining symbols will be displayed. #Installation and Setup

  1. First you will need to have NodeJS installed on your machine. You can find the latest version here
  2. Next create a discord account for your bot. You can do this here
  3. Click "New App"
  4. Provide a Name (this is the name people will see when the bot joins a channel) and Description
  5. Click "Create App"
  6. On the new screen click "Create a Bot User"
  7. Open Notepad
  8. Under the heading "App Bot User" you will see "Token:click to reveal" Click to reveal it and copy the resulting text and paste it in notepad. Be sure to keep this token private.
  9. Under the heading "App Details" Copy the number after "Client ID:" and paste this in notepad as well.
  10. Replace "CLIENT_ID_GOES_HERE" in the following link with the Client ID you copied in the above step https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID_GOES_HERE&scope=bot&permissions=0
  11. Paste the edited link into a web browser, select the discord server you wish to add the bot to, and click "Authorize".
  12. Click "Clone or Download" at the top of this page. Click "Download Zip" and extract the files.
  13. Open Config.json with a text editor program of your choice.
  14. Replace "BOT TOKEN" with your bot token you copied in step 2.6 and save the file
  15. Your bot is now configured and ready to launch.

#Running the bot

Before you first launch the bot you need to run the file "Run this before first launch". You can't miss it. This will install all the dependencies that bot needs to run.

To run the bot, Just execute the file "EotE Dice Roller.lnk". You can copy/move this file to any location you want. However, do not move "start.bat" out of the installation folder.

#Configuration File config.json

config.json has four properties

  1. token
  • this is the login token for your bot
  1. prefix
  • this is the symbol the bot uses to recognize commands. This is set to "!" by default
  1. descriptorPrenpend
  • Any text you place between the double quotes following this property will be prepended to the text provided in the comment parameter. Example: if "descriptorPrepend" is set to "Targeting: ", then the command !roll 2g 2blk "Soldier 1" is called, the bot will respond with: Targeting: Soldier 1 Astrydax roll results: Success: 1 Threat: 1
  1. maxRollsPerDie
  • This is the max number per dice type that can be rolled in a given roll command. Set to 20 by default. Commands that don't respect the roll limit will be aborted and send an error message to the discord chat.

#Dice Suffixes

y = Yellow/Proficiency
g = Green/Ability
b = Blue/Boost
blk = Black/Setback
r = Red/ Challenge
p = Purple/ Difficulty
d/w = White/Destiny/Force

sweote-discord-dice-roller's People

Watchers

 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.