Skip to content
non-player-character directory-builder
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
controllers further investigation Aug 2, 2018
models More commands than actually necessary Jul 19, 2018
.gitignore More commands than actually necessary Jul 19, 2018
LICENSE Initial commit Jun 28, 2018
Procfile Procfile Aug 2, 2018
README.md Update README.md Dec 15, 2018
index.js roll test cleanup Aug 14, 2018
package-lock.json More commands than actually necessary Jul 19, 2018
package.json More commands than actually necessary Jul 19, 2018

README.md

rollodex

A simple non-player-character directory-builder bot for discord !

How to use

Some Assembly Required

I wrote this out so you could implement your own copy of Roll-o-Dex for your at-home table-top role-playing game. The code is all here but there are some other steps you will need to follow if you want this to work for you and your group. I will write it all out more step-by-step at a later date, but basically you will need to download and set up these libraries/database/etc:

You will also need to set up a Discord account and create an application so you can get a token, which you will put in your .gitignore file. Lastly, you can run the whole thing through Heroku

Basic Idea

Your player-characters will meet many, many non-player characters during the course of your ongoing table-top rpg campaign, and sometimes it can be difficult to keep them all straight. They often have strange names, and at some point it becomes difficult to remember who is allied whom, and where these NPCs are from. Rollodex uses the term 'Faction' as a catch-all for various ways NPCs may be organized. Guilds, families, businesses, even countries can be factions. So what you have to do is populate your world with NPCs and Factions, and combine the two, all using the commands below. Then you can call up anyone you want and learn about them! NPCs may belong to any number of factions, but too many may get confusing to you!

Commands

Please note that currently, all names are case sensitive. Also, for now NPC names must be two words, and faction names must be one word.

NPC:

  • !npc list - List of all NPCs
  • !npc get *npc name* - pulls up info on requested npc
  • !npc newnpc name npc description - creates a new npc
  • !npc describe npc name new npc description - replaces the old description with the new description
  • !npc rename npc old name npc new name - renames npc
  • !npc recruit npc name faction name - recruits existing npc into existing an faction
  • !npc kill npc name - removes npc from database

Faction:

  • !faction list - List of all NPCs
  • !faction get faction name - pulls up info on requested faction
  • !faction newfaction name npc description - creates a new faction
  • !faction describe faction name new faction description - replaces the old description with the new description
  • !faction rename faction old name faction new name - renames faction
  • !faction recruit faction name npc name - recruits existing npc into existing an faction
  • !faction members faction name - pulls up a list of members of said faction
  • !faction kill faction name - removes faction from database

Other

there are and/or will be a couple others !

Issues

Have a feature in mind? Having trouble with something? Let me know. Feel free to open an issue, and I will try to respond promptly.

Contribute

Want to contribute to Rollodex? Awesome! Open a pull request.

License

You can’t perform that action at this time.