pbartkowiak-dev / discord-dice-ui

Discord Dice UI Webhook Bot Connector
https://discord-dice-ui.herokuapp.com/
13 stars 6 forks source link

[Discord Dice Ui]()

🎲 Discord Dice UI

Discord Dice UI is a website based app which can be integrated easily with Discord server. In short, it offers a neat interface to roll dice and provides more advanced functions and dice manipulations for the supported systems. I conceived it as a simpler alternative to more complex VTTs, and as a more advanced alternative to traditional, command driven Discord bots.

Table of content:

🎲 The App Overview

The App interface:
[App interface]()

Sample results inside a Discord Chat:
[Sample Chat Results]()

Sample results inside the App:
[Sample App Results]()

Call of Cthulhu 7e

After selecting the mode in the Roll Options a dedicated modal will be shown for rolling d100 skill tests - with option to Push the roll and guidelines for optional spending luck.

[Call of Cthulhu 7e Mode 2]()

Skill values can be stored in build-in character sheet:

[Call of Cthulhu 7e Character Sheet Icon]()

[Call of Cthulhu 7e Character Sheet]()

Warhammer

The app offers special support for rolling Success Levels in Warhammer 2e, Warhammer 4e and Dark Heresy II.

[WFRP Mode - app]()

The app can also help with adding and subtracting gold crowns, silver shillings and brass pennies:

[Warhammer Money Converter Info]()

[Warhammer Money Converter]()

Wrath & Glory

[Wrath and Glory UI]()

[Wrath and Glory Results]()

Conan 2d20

This mode adds special modal for testing abilities, generating Hit Location and rolling Combat Dice:

[Conan 2d20 Mode general interface]()

In the modal one can define Focus, Target Number, Difficulty, select amount of dice rolled, focus and so on:

[Conan 2d20 Mode modal]()

Damage Dice Result (with option to reroll selected dice):

[Conan 2d20 Mode Combat Dice roll results]()

Infinity 2d20

[Infinity 2d20 Mode general interface]()

Dune 2d20

[Dune 2d20 Mode general interface]()

Legend of the Five Rings 1e (classical Roll and Keep)

Roll and Keep Results:
[Roll and Keep Results Modal]()

Legend of the Five Rings 5e

Allows to roll Skill and Ring Dice and to modify the results:
[L5R Pool Builder]()

Roll Results:
[L5r Results Modal]()

Narrative Dice

Allows to build a custom dice pull from popular space opera RPG series:
[Narrative Dice Pool Builder]()

Roll Results:
[Narrative Dice Pool Builder]()

Fate

[Fate dice]()

The One Ring 2e

The app now allows to roll unique TOR dice. It calculates the roll results automatically and takes into the consideration factors:

Interface:
[TOR Interface]()

Skill Test:
[TOR Skill Test]()

Results Modal:
[TOR Results Modal]()

Results on Discord:
[TOR Results on Discord]()


⚔️ Combat Tracker

The Combat Tracker lets you organize the combat and share the current state of the battlefield with other players on Discord. It supports:

[Combat Tracker UI]()

[Combat Tracker on Discord]()


X-Card

The X-Card is an optional tool created by John Stavropoulos that allows anyone in your game to edit out any content anyone is uncomfortable with as you play.

[X-Card Modal]()

[X-Card Submitted on Discord]()

You'll find more details on the X-Card under the following link: http://tinyurl.com/x-card-rpg


🔧 Discord Configuration

In order to get started, Discord's server admin has to create a Webhook and share a special link with other users. Read below how to do it.

  1. As a server's admin open your chat's context menu. how-to-1

  2. Select Server Settings from the context menu. how-to-2

  3. Select Webhooks in the left side menu and then press the button Create Webhook. how-to-3

  4. Name your Webhook and provide an icon (optionally). Copy a link to obtain your unique Webhook url and press Save button to close the modal. how-to-4 🛑 Never share your Webhook link publicly and keep it a secret. You don't want to allow strangers to publish messages in your chat.

  5. Now you can share the Webhook url with other players in two ways:

    1. Via link param.
      Provide your players a link to an app which looks like this:
    https://discord-dice-ui.herokuapp.com/?q=UNIQUE_CODE_FROM_YOUR_DICORD_WEBHOOK

    💡 HINT: You can generate the link using Copy App Link button in the Setting Modal:

    how-to-5

    1. Manually.
      Alternatively, every user has to enter the provided Webhook link url in the Settings modal inside the app. Entering the username is required as well. how-to-5
  6. Saving the Webhook in the app will connect the app with the Discord server.


🔗 Query Parameters

Several settings can by passed directly in the URL in the following format:

discord-dice-ui.herokuapp.com/?q=foo123&username=Django&sl=fast&mode=cthulhuMode

Available parameters:


👨‍💻 Developers' Info

Production build

  1. npm run build
  2. npm run start (serve -s build command is required by Heroku).

For local environment development run:

To run the app:

npm run dev`

To run Prettier globally:

npm run  prettier