Merge branch 'develop'

Author: TheSamLloyd

README.md

@@ -1,2 +1,81 @@
-# Elbie-Mk.-III
-Elbeanor rewritten from scratch for the third time, this time utilizing node.js to run her as a real "server-side" application, now deployed via Heroku.
+# Elbie (Landon Bot)
+An extensible [Discord](https://discordapp.com/) bot designed to facilitate running rules-lite [TTRPG](https://en.wikipedia.org/wiki/Tabletop_role-playing_game) systems, including [Dungeon World](http://dungeon-world.com/), [Fiasco](http://bullypulpitgames.com/games/fiasco/), and others.
+What makes Elbie distinct from many of the conventionally available Discord bots is her tight RPG integrations, capable of handling skills, inventory, dice rolls, and creating character summaries on the fly. She also has rudimentary (and in-progress) audio capabiities, with built-in support for character theme songs. 
+
+Elbie's purpose is to provide a wide array of tools and accessories and then get out of the way, letting the players and DM be able to act freely without having to constantly be referring to a character sheet. This enables better role-playing and more mentally present players.
+## Installation
+### Adding to a server
+Elbie lives in Heroku at present to make her available 24/7. To add Elbie to a Discord server, visit [this link](https://discordapp.com/oauth2/authorize?client_id=255390394219626496&scope=bot&permissions=1) and select a server in which you have the Manage Server permission. 
+### Installing Locally
+To run Elbie locally, fork this repository and clone it to your local machine. You'll need to register a Discord app to get a login token, and if you want her to report version information, you'll need a Github token as well. You'll need to add her to a server as well, which you can do while registering her as a Discord app.
+## Usage
+All of Elbie's commands start with a **prefix**, letting her know that you're talking to her. By default, this prefix is set to `+`, such that asking her to flip a coin is simply `+flip`. 
+
+Elbie is broken up into **modules**, each of which encapsulates several related commands. The "master" version of Elbie has all modules I've written installed, but writing one's own is fairly simple and lets Elbie be easily extensible. As it stands, the modules available in the master version are:
+* bot
+  * `+ping`: Returns "pong!" as proof-of-life.
+  * `+echo (String)`: Echoes back `(String)` as proof-of-life
+  * `+flip`: Returns either "heads" or "tails"
+* rpg
+  * `+r (Integer? modifier)`: Makes a single default roll as defined by whatever TTRPG system the channel is currently bound to (2d6 for PBtA games, 1d20 for most D&D/Pathfinder games, etc.) If `modifier` is provided, it will be added as a modifier
+  * `+bind (String shortname) (String name)`: Binds the current channel to a new campaign under the name `name` (which may contain spaces) and with abbreviated name `shortname` (which must not contain spaces) and assigns the player who issued the command as DM. Setup will need to be finished on the web interface, which is not, at present, publically available. (If you want to use Elbie in a campaign of yours, send me a message and I will manually finish setup.)
+  * `+who (String? name)`: Generates a character summary of either the current player if no name is provided, or if `name` is a player name (like "Sam"), a character name (like "Lurreka Al-Petarra"), or a nickname (like "Lurreka"), it will generate a summary of that character or the character assigned to that player. (For reference, if for some reason you have a player named "Sam" and a different player has a character named "Sam", `+who Sam` will refer to the player. If you are doing this, why?)
+  * `+listChar`: Lists all the characters in the current campaign with their player's name (e.g. "Amateotl Maikali, played by Sam")
+  * `+roll`: Accepts a comma-separated list of rolls and modifiers to perform in `xdy+z` format, e.g. `+roll 1d20+2d4+1d6+3,2d6+-2`. Note that it is crucial to preface any negative modifiers with a `+`, e.g. (`2d4+-1`).
+  * `+hp (Integer? amount)`: Adjusts the current character's HP by the given `amount`. Restricts to values between 0 and the character's maximum health. Not providing `amount` returns the character's current HP.
+  * `+mark (Integer? amount)`: Increases the current character's XP by `amount` if provided. Defaults to 1.
+  * `+s (String skill) (Integer? modifier)`: Rolls a "skill roll" with the appropriate modifier depending on the character's skill in that attribute. If `modifier` is provided, it will modify the result. `skill` must be an abbreviated skill name ("str", "con", etc.)
+  * `+levelup`: Increases the character's level by 1, if the character has enough XP. If not, fails.
+  * (`+theme`:) Immediately plays the current character's theme. (This command is not currently available in the master build.)
+* (audio)
+  * This module is not currently available in the master build. If you want to use this module, you must fork Elbie and compile her from the `audio` branch. Use at your own risk, as it is still actively in development and may change without warning.
+
+## Extending Elbie
+Elbie is written to be fully extensible. All you need to do to write your own module is create a folder inside of `bot_modules` titled for your new module, and inside that create `index.js`. You may want to import `common.js` from `bot_modules`, which provides several common functions required by modules. Then you'll need four components in `index.js`: 
+
+```javascript
+  const name = "your-module-name"
+  const desc = "My new module"
+  const functions = {
+    foo: (Command)=>{
+      Command.channel.send("Hello World")
+    }
+  }
+  const commands = {
+    'hello': functions.foo
+  }
+  module.exports = {name, desc, functions, commands}
+  ```
+To break this pattern down, `name` and `desc` are self-explanatory. `functions` is where all of your functions live, and their names may not be correlated with their command. That's why `commands` takes in a string (i.e. the command Elbie received) and returns a function, which she then executes by passing it the Command object she received. You are free to "alias" functions by having several keys in `commands` with the same function value. 
+
+Elbie automatically includes any modules in the bot_modules folder, so they should be available as soon as she starts.
+
+If you've done everything right, when you start up Elbie, she should log the modules she has installed in the console and you should see your module's name and description, as well as its commands, which you should be able to use.
+
+## Future Enhancements
+### Audio
+Audio is her next big step -- having her able to smoothly play music from youtube and possibly other sources would help her be a bot that can be used in a variety of circumstances. 
+### Web Interface
+There is a lot you can do with a text interface, but for our purposes, setting up a web interface for instantiating a campaign, adjusting character attributes, or making administrative changes to your TTRPG sessions is going to be easier for everyone.
+### Grid-based Movement
+Many TTRPGs use a game-board like grid for character positioning and line-of-sight determination. At present, there are no plans to include such a feature in Elbie. Get back to role-playing!! ;-)
+
+## Thanks & Tech
+* [discord-js](https://discord.js.org)
+* node
+* express
+* yarn
+* Mongoose
+* MongoDB
+* Heroku
+* ytdl
+_____
+* [Friends at the Table](http://friendsatthetable.net/)
+* [The Adventure Zone](http://www.maximumfun.org/shows/adventure-zone)
+* [Dungeon World](http://dungeon-world.com/)
+* The Pilgrims of Her Blue Flame
+
+## One Last Thing
+If you're a traditional D&D or Pathfinder player who has grown a little tired of the standard formula of "go into dungeon, kill goblin, walk out with treasure, repeat until dead", I urge you to check out any of the "Powered By the Apocalypse" games. Dungeon World is their D&D analogue, and since our group switched, we've seen better stories, more realistic role-playing, less focus on stats and skills and more focus on interpersonal connection. 
+
+If you've never played a TTRPG before, Dungeon World is a great place to start. There are few rules to memorize, lots of things you can do, and lots of ways to be an extraordinary person in a fantasy world. I'm blessed to work with the world's greatest Game Master, but there are lots of great published adventures that your group can run that don't involve writing a novel's worth of backstory.

api/discordauth.js

@@ -0,0 +1,50 @@
+// dependencies
+const ytdl = require('ytdl-core')
+
+// module information
+const name = 'audio'
+const desc = 'functions to allow Elbie to stream audio thru a voice channel'
+const audio = {
+  passes: 3,
+  volume: 0.5,
+  play: (Command) => {
+    if (!Command.server) {
+      Command.channel.send('You have to be in a server to use voice!')
+    } else {
+      if (Command.member.voiceChannel) {
+        console.log(`Connecting to voice in ${Command.server.name} in channel ${Command.channel.name}`)
+        Command.member.voiceChannel.join()
+          .then(connection => {
+            console.log('Successfully connected to voice channel.')
+            let stream = ytdl(Command.argument)
+            ytdl.getInfo(Command.argument, (err, info) => {
+              if (err) console.log(err)
+              else {
+                Command.channel.send(`Playing ${info.title}`)
+                const dispatcher = connection.playStream(stream, {audioonly: true})
+                dispatcher.on('end', () => {
+                  Command.member.voiceChannel.leave()
+                })
+              }
+            })
+          })
+      }
+    }
+  },
+  stop: (Command) => {
+    if (Command.member.voiceChannel) {
+      try {
+        Command.member.voiceChannel.leave()
+      } catch (err) {
+        console.log(err)
+        Command.channel.send("I can't stop if I'm not playing anything")
+      }
+    }
+  }
+}
+
+const commands = {
+  play: audio.play,
+  stop: audio.stop
+}
+module.exports = { audio, commands, name, desc }

bot_modules/audio/index.js

@@ -1,5 +1,5 @@
 // dependencies
-const common = require('./common.js')
+const common = require('../common.js')
 // basic bot commands
 const name = 'bot'
 const desc = 'basic bot commands'

bot_modules/bot.js bot_modules/bot/index.js

@@ -1,3 +1,5 @@
+const name = 'common'
+const desc = 'Common functions for use in other modules'
 // common commands for use in other elbie modules
 const common = {
   randInt (a, b) {
@@ -16,7 +18,7 @@ const common = {
   typed (arg) {
     if (isNaN(parseFloat(arg))) {
       return arg
-    } else if (Math.floor(parseFloat(arg)) == parseFloat(arg)) {
+    } else if (Math.floor(parseFloat(arg)) === parseFloat(arg)) {
       return parseInt(arg)
     } else return parseFloat(arg)
   },
@@ -27,4 +29,5 @@ const common = {
     return string.charAt(0).toUpperCase() + string.slice(1)
   }
 }
-module.exports = common
+const commands = {}
+module.exports = {name, desc, common, commands}

bot_modules/common.js

@@ -0,0 +1,9 @@
+const fs = require('fs')
+let modules = []
+fs
+  .readdirSync(__dirname)
+  .filter(file => file !== 'index.js')
+  .forEach(file => {
+    modules.push(require(`./${file}`))
+  })
+module.exports = modules

bot_modules/index.js

@@ -3,11 +3,12 @@ const common = require('../common.js')
 const gameList = {
   'Dungeon World': require('./dungeon-world.js')
 }
+const audio = require('../audio') || false
 
 const DB_URI = process.env.MONGODB_URI
 const mongoose = require('mongoose')
 const db = require('../../models/schema.js')
-mongoose.connect(DB_URI).then(
+mongoose.connect(DB_URI, {useNewUrlParser: true}).then(
   () => {
     console.log('DB connection ready')
   },
@@ -79,8 +80,7 @@ var Character = {
     Character.getChar(Command, (char) => {
       var attr = Command.args[0]
       try {
-        if (!char[attr] & char[attr] !== 0) cb(char[attr])
-        else Command.channel.send(`Could not fetch attribute ${attr} -- query returned undefined.`)
+        if (!char[attr] & char[attr] !== 0) { console.log(char[attr]); cb(char[attr]) } else Command.channel.send(`Could not fetch attribute ${attr} -- query returned undefined.`)
       } catch (err) {
         console.error(err)
         Command.channel.send('Could not fetch attribute ' + attr)
@@ -114,6 +114,20 @@ var Character = {
         } else Command.channel.send('Could not level up. Check EXP.')
       })
     })
+  },
+  theme: function (Command) {
+    if (audio) {
+      Character.getChar(Command, function (char) {
+        Command.argument = `https://www.youtube.com/watch?v=${char.get('theme')}`
+        console.log(char)
+        console.log(Object.keys(char))
+        console.log(char.get('theme'))
+        console.log(Command.argument)
+        audio.audio.play(Command)
+      })
+    } else {
+      Command.channel.send('audio module not installed or not working.')
+    }
   }
 }
 module.exports = {Character, gameList, db}

bot_modules/rpg/character.js

@@ -1,7 +1,7 @@
 // dependencies
-const common = require('./common.js')
+const common = require('../common.js').common
 const Discord = require('discord.js')
-const cInfo = require('./rpg/character.js')
+const cInfo = require('./character.js')
 const Character = cInfo.Character
 const db = cInfo.db
 
@@ -190,7 +190,8 @@ const commands = {
   hp: rpg.cast,
   mark: rpg.cast,
   s: rpg.statRoll,
-  levelup: Character.levelup
+  levelup: Character.levelup,
+  theme: Character.theme
 }
 // object to turn game strings into game objects
 module.exports = {rpg, commands, name, desc}

bot_modules/rpg.js bot_modules/rpg/index.js

@@ -3,18 +3,17 @@ require('dotenv').config()
 const Discord = require('discord.js')
 const client = new Discord.Client()
 const token = process.env.DISCORD_TOKEN
-const bot = require('./bot_modules/bot.js')
-const rpg = require('./bot_modules/rpg.js')
+const modules = require('./bot_modules')
 const axios = require('axios')
 const prefix = '+'
+const env = process.env.NODE_ENV || 'dev'
 
 // adding commands
-var modules = [bot, rpg]
 var commandList = {}
 modules.forEach(module => {
   Object.assign(commandList, module.commands)
-  console.log('Loaded commands for module ' + module.name)
-  console.log('>' + module.desc)
+  console.log('Loaded commands for module ' + module['name'])
+  console.log('>' + module['desc'])
 })
 console.log(commandList)
 
@@ -59,7 +58,7 @@ client.on('ready', function () {
       'status': 'online',
       'afk': false,
       'game': {
-        name: version,
+        name: env !== 'dev' ? `${version}` : `DEV -- ${version}`,
         type: 'PLAYING'
       }
     })
@@ -100,9 +99,11 @@ client.on('message', function (message) {
     var Command = {
       channel: clean(message.channel),
       auth: clean(message.author),
+      member: message.member,
       command: content[0],
       argument: content.slice(1).join(' '),
-      args: content.slice(1)
+      args: content.slice(1),
+      server: message.guild
     }
     // commands
     if (!Object.keys(commandList).includes(Command.command)) {

elbie.js

@@ -1,19 +1,26 @@
 {
   "name": "elbie",
-  "version": "3.3.2",
+  "version": "3.5.0",
   "description": "discord bot designed to handle dungeon world and a few other ttrpgs",
   "main": "elbie.js",
   "dependencies": {
     "axios": "^0.18.0",
-    "discord.js": "^11.3.2",
+    "bufferutil": "^3.0.3",
+    "discord.js": "^11.4.2",
     "dotenv": "^5.0.1",
     "ejs": "^2.6.1",
+    "erlpack": "discordapp/erlpack",
     "eslint": "^4.19.1",
     "express": "^4.16.3",
     "ffmpeg-binaries": "^3.2.2",
+    "fluent-ffmpeg": "^2.1.2",
     "fs": "0.0.1-security",
+    "libsodium-wrappers": "^0.7.3",
     "mongoose": "^5.0.17",
-    "node-fetch": "^2.1.2"
+    "node-fetch": "^2.1.2",
+    "node-opus": "^0.3.0",
+    "save": "^2.3.2",
+    "ytdl-core": "^0.20.4"
   },
   "devDependencies": {
     "eslint-config-standard": "^11.0.0",
@@ -23,7 +30,7 @@
     "eslint-plugin-standard": "^3.1.0"
   },
   "scripts": {
-    "start": "node index.js",
+    "start": "node elbie.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {