Skip to content

A simple pen & paper roleplaying Discord bot written in Java. The purpose of this bot is to supplement pen & paper roleplayers that use Discord.

License

Notifications You must be signed in to change notification settings

ivanskodje/RPBot

Repository files navigation

RPBot

A simple pen & paper roleplaying bot written in Java. The purpose of this bot is to supplement pen & paper roleplayers that use Discord.

Contributions are always welcome.

How to setup

Open the project in the IDE of your choice. It is assumed you know how to import new projects, as well as how to import libraries.

Setting up the Bot (Discordapp.com)

  1. Go to Discordapp.com and create a "New App"
  2. Note down the given ID if your App.
  3. Add your own App ID to the oAuth2 URL: https://discordapp.com/api/oauth2/authorize?client_id=&scope=bot&permissions=0
  4. Enter the URL into your browser, and select which channel you want the bot to connect.
  5. Done. The bot should now appear as "Offline" in the selected Discord channel.

Bot Login

  1. Go to Discordapp.com and copy the Token value of your bot
  2. Create a token.txt textfile and add it to the root of your project
  3. Open token.txt and store the token on the first line. NB: Never share your token file. If you do, other people can login as YOUR bot.
  4. Run Main.java and the bot should login. Test it by typing in '!roll 1d6'.

Available Commands

Command Description
help Displays available commands (!help)
roll Generates dices equal to the first number, and rolls values between 1 and the second number. (!roll 1d6)
calc Calculates mathematical expressions. (!calc (1*2)/2)
name Generates a female or male name. (!name female)
table Used to generate or display a row from a text file (!table short example 5)
list Used to create your own lists and items. Can create lists inside lists. Be careful when removing data.

Additional Information (Discord4J and Command4J)

Check out the documentation for Discord4J and the Discord4J Plugin: Command4J.

You can also ask for help on the official Discord4J Discord Server.

License

GPLv3 License

Copyright (C) 2016 Ivan P. Skodje

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

GPLv3

About

A simple pen & paper roleplaying Discord bot written in Java. The purpose of this bot is to supplement pen & paper roleplayers that use Discord.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published