Skip to content

Apexal/rpi-bot

Repository files navigation

RPI Bot

RPI - Registered Personnel Identifier

A simple Discord bot for college servers to allow students to publicly share their name, graduation year, major, dorm, etc. (all optionally)

Install

In order to keep your data private, its strongly recommended to host the bot yourself. You must have NodeJS and SQLite installed.

  1. Clone this repository: $ git clone git@github.com:Apexal/rpi-bot.git
  2. Install dependencies $ npm install
  3. Create config.json based on config_example.json
  4. Run the bot $ node index.js
  5. Add the bot to your server by going to the invite link the bot says on startup.

If you don't want to/cannot and you understand that I will be able to see all info saved you can add my hosted version to your server just by click here.

Commands

Default prefix is !

  • !help - Shows a list of commands. Use !help <command> for a description and example uses.
  • !who - Shows a summary of a student with all given info.
  • !name - Get/sets a user's real name.
  • !dorm - Get/sets a user's dorm.
  • !major - Get/sets a user's major
  • !grad - Get/sets a user's graduation year coming soon

Examples

setting info who command

Contributing

Fork and submit pull requests! This is an ongoing project.

Releases

No releases published

Packages

No packages published