Giters

for-the-new-order / SWEotE-Discord-Dice-Roller

Discord Bot Companion for the SW:EotE RPG

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SWEotE-Discord-Dice-Roller

CREDIT: Vampwood for conceiving the bot, and SkyJedi for substantial contributions to the project.

A Discord Bot Companion for the SW:EotE RPG

#Usage Commands:

  • !roll rolls any combination of SWRPG dice and returns the cancelled results

    • You may add " " at the end of the line to give the roll a name like Initiative
    • Dice results and cancellations are computed by the bot so you don't have to!
    • Only the remaining symbols will be displayed.

    DICE IDENTIFIERS

    • y/pro = Yellow/Proficiency

    • g/a = Green/Ability

    • b/boo = Blue/Boost

    • blk/k/sb/s = Black/Setback

    • r/c = Red/ Challenge

    • p/diff = Purple/ Difficulty

    • w/f = White/Force

      • note: if you use the !roll yyyggbbd method you must use the single character dice identifiers

    EXAMPLES - !roll yyyggbbd "Blast Him!" - !roll 3pro 2a 2boo 2dif 2sb "Delusions of Grandeur" - !roll "Get to the ship" 2y 1g 1r 1p

  • !Poly: rolls any combination of polyhedral dice with modifier

EXAMPLES - !poly 1d4 2d6+1 1d100-60

  • !d100 rolls a d100 with optional modifier and displays result.

    • !d100 +X
    • !d100 + X
    • !d100 -X
    • !d100 - X

  • !destiny sets and manages the Destiny Balance for the group

    • !destiny view the destiny pool
    • !destiny roll rolls one Force Die and adds it to current destiny pool
    • !destiny l/light uses light side point
    • !destiny d/dark uses dark side point
    • !destiny set #l #d sets destiny pool
    • !destiny set lldd sets destiny pool
    • !destiny reset resets the destiny pool

  • !crit rolls a d100 with optional modifier and displays result of the critical hit.

    • !crit +X
    • !crit + X
    • !crit -X
    • !crit - X

  • !shipcrit rolls a d100 with optional modifier and displays result of the ship critical hit.

    • !shipcrit +X
    • !shipcrit + X
    • !shipcrit -X
    • !shipcrit - X

  • !char Simple character stat manager

    • !char setup characterName maxWound maxStrain credits Setup a new character
    • !char wound/w characterName +X/-X increases/decreases wounds for characterName by X
    • !char strain/s characterName +X/-X increases/decreases Strain for characterName by X
    • !char credits/c characterName +X/-X increases/decreases credit balance for characterName by X
    • !Char Modify CharacterName +X/-X MaxStrain/MaxWounds increases/decreases selected stat for characterName by x
    • !Char Crit CharacterName +X/-X adds/removes critical injuries for characterName
    • !Char obligation/o CharacterName +X/-X obligationName adds/removes obligations for characterName
    • !char status characterName current status for characterName
    • !char remove characterName removes characterName
    • !char list lists all characters
    • !char reset resets all characters

  • !Init initiative tracker and roller

    • !Init: shows current initiative order
    • !Init Roll Dice NPC/PC: rolls your initiative dice and adds character to the order
    • !Init Next: moves to next initiative slot
    • !Init Previous: moves to previous initiative slot
    • !Init Set: manually set initiative order before any turns occur
    • !Init Modify: manually alter initiative order mid-round
    • !Init Reset: resets the initiative order
    • !Init Remove X: remove a slot where is is the position

  • !Species/!Gleepglop: picks a random species

  • !Obligation: gathers all the obligations entered with !Char and rolls to trigger

  • !Reroll: modifies the previous roll

    • !Reroll Same: rolls the same pool again
    • !Reroll Add DiceIdentifiers: roll additional dice and adds them to the pool
    • !Reroll Remove DiceIdentifiers: remove random dice of the designated color
    • !Reroll Select DiceColor/DicePosition: rerolls specified dice ie !Reroll Select Y3 P1: rerolls only the 3rd yellow die and the 1st purple die in the current dice pool
    • !Reroll Fortune Show DiceColor/DicePosition: shows adjacent sides for the specified die ie !Reroll Fortune Show Y1 P2 (shows the adjacent side for the 1st yellow and 2 purple dicefaces)
    • !Reroll Fortune Swap DiceColor/DicePosition AdjacentFace (From !Reroll Fortune Show Command): swaps the current face for an adjacent one ie !Reroll Fortune Swap 2Y 3: swaps the current die face on the 2nd yellow with option 3 of the adjacent sides

  • !help Type '!help topic for further information'

    • !roll rolls any combination of SWRPG dice and returns the canceled results
    • !d100 rolls a d100 with optional modifier and displays result
    • !destiny sets and manages the destiny balance for the group
    • !crit rolls a d100 with optional modifier and displays result of the critical hit
    • !shipcrit rolls a d100 with optional modifier and displays result of the ship critical hit
    • !char simple character stat manager
    • !help displays help for topics
    • !init initiative tracker and roller
    • !ver displays bot version

  • ADMIN ONLY

    • !stats Displays # of servers/users bot is currently has.

#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. If you have a swrpg and genesys server to enable all dice invite bot to both servers.
  13. Setup Firebase
  14. https://console.firebase.google.com
  15. Click "Add Project"
  16. Name project whatever you want, click Create
  17. Database...Rules....
    1. change to { "rules": { ".read": "true", ".write": "true" } }
  18. Overview....Click the reddish circle labeled "Add Firebase to your web app"
  19. Copy everything between var config = { }
  20. Click "Clone or Download" at the top of this page. Click "Download Zip" and extract the files.
  21. Type @ into your channel to get you userID
  22. Open config.js with a text editor program of your choice.
  23. Replace "BOT TOKEN" with your bot token you copied in step 2.6
  24. Replace "ADMIN_ID" with the NUMBERS of your userID from step 5.
  25. Paste into var firebaseconfig = { }
  26. Get Discord ServerID from Discord Server Settings...Widget...ServerID for both swrpg and genesys servers
  27. Paste ServerID into correct slots ("swrpg" and "genesys") in config.js (paste the same number in both slots if only one set of dice will be used)
  28. Save file
  29. upload custom emoji from emoji folder to the server. https://support.discordapp.com/hc/en-us/articles/207619737-Adding-Emoji-Magic
  30. Your bot is now configured and ready to launch.

#Running the bot

To run the bot, Just execute the file "start.bat" on a windows or "start.command" on mac.

#Updating the bot

To update the bot, Just execute the file "UPDATE.bat" on a windows or "UPDATE.command" on mac. Your config.js file will be backed up and restored automatically

#Configuration File config.js

config.js has properties

  1. firebaseconfig -firebase token

  2. token

    • this is the login token for your bot

  3. adminID

    • the user discordID for the Admin

  4. prefix

    • this is the symbol the bot uses to recognize commands. This is set to "!" by default

  5. 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.

  6. 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

  7. swrpg

    • server ID for SWRPG Dice emoji

  8. Genesys

    • server ID for Genesys Dice emoji

#Amazon EC2 install

  1. Connect to your ubuntu Linux instance using SSH.

  2. Install node

  3. Download and unzip latest build wget https://github.com/Astrydax/SWEotE-Discord-Dice-Roller/archive/master.zip unzip master.zip cd SWEotE-Discord-Dice-Roller-master

  4. Install npm for the bot npm install

  5. Configure the bot sudo nano config.json

  6. launch bot (this will launch the bot and let you close the terminal window) nohup nodejs bot.js &>/dev/null & disown

About

Discord Bot Companion for the SW:EotE RPG

License:MIT License

Languages

Language:JavaScript 97.3%Language:PowerShell 1.2%Language:Batchfile 0.7%Language:Shell 0.5%Language:Dockerfile 0.3%