Skip to content

soulflyman/Optodice

Repository files navigation

Optodice

Dice roller for Discord that uses your character from Optolith

With Optodice you can role Atribute and Skill checks on the values from your character.

Attention:
This software is still in an alpha state! The build from the Github Actions are only for test purposes!

Optodice does not modify your characters, it operates in read only mode on your characters.


Usage

Before you can use Optodice you have to install Optolith Character Creator and create or import a character.

After that you just need to know the URL of the Discord Webhook.

See the How-To section of this readme on how to get the Webhook URL and for more details about the functions of Optodice.


How-To

1.) Creat a Discord Webhook

To create a webhook for an Discord channel you need to have the rights to do so. If you are not the owner/admin of the channel, ask the administrator if he can create a webhook for your party channel. To create a webhook just right click the channel for which you want to create a webhook. Then Edit Channel -> Integrations -> Create Webhook You don't have to change Name and Avatar but be sure to that the correct channel is selected. Then copy the webhook URL and save it for late or send it to the other players. Optodice will ask you for this URL at the first start.

Example setup the developers use:

  • one voice/video channel for the gameplay
  • one channel for adventure/story related data (maps, portraits, names of characters, quest log, etc.)
  • one channel for Optodice output (check results, character status...)

2.) Use your Avatar

This is Optional but recomended.

The easiest way to use the avatar of the selected Hero with the Discord Webhook is the Optodice avater upload script.

You must have a Webspace with PHP support. Create a subfolder on your webspace and put the script into this subfolder.

The script is called upload-avatar.php and can be found in the GitHub respository of Optodice in the folder php-avatar-script.

Example

Your domain example.com points to your htdocs folder of your webspace. Then create a subfolder in htdocs called optodice and upload the upload-avater.php script into this folder. For this example, when Optodice asks you for your Upload-Script URL you would enter it like: http://example.com/optodice/avatar-upload.php

If everything works correct, the avatar of the selected character will be uploaded with the help of the upload script and is used for every message Optodice sends to the Discord Webhook in the name of your character.

3.) Role Checks

To role a Check on a attribute, skill or attack, you just have to klick the dice button in that corosponding row. To Add some dificulty modification just add the number in the text box beside the dice button. Positive number (5, 2, +2, +1) lower the dificulty level, negative number (-1, -3) raise the dificulty level of that check.

4.) Send Character Status

To send the status of your character to Discord, just left click on the avater.


Roadmap (some sort of)

  • Select from multiple characters
  • Send data to a Discord Webhook
  • Role checks on attributes
  • Role checks on skills
  • Role checks on attacks
  • Display every check result in discord with the avatar of the character
  • Support automatic uploads of avatars (upload via php script workds, sftp upload is missing)
  • Role single dice
  • Role custom checks
  • Display avatar in Optodice
  • Keep track of health
  • Keep track of pain level
  • Keep track of money
  • Keep track of fate points
  • Keep track of arcane energy
  • Support Windows
  • Support Linux
  • Support MacOS (github action builds are compiling, still not testet)
  • i18n (sorry, only a german UI is available at the moment, with the exception of the settings, these are in english)
  • Settings view
  • Option to autorole critical success/fails events
  • Option to autorole battle damage
  • Cumulative Group Checks Using Multiple Skills
  • Save character state when switching characters or restarting the application
  • Role checks on spells
  • Support all kind of magic (at the moment not all types of magic are supported)
  • Do a search over all rolleable checks

Screenshots

Optodice UI
Screenshot of the Optodice UI

How it looks in Discord when you role a check
Screenshot of the Optodice messages in a Discord channel

About

Dice roller for Discord that uses your Optolith Character https://github.com/elyukai/optolith-client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published