You are viewing a potentially older version of this package. View all versions.
LordAshes-ChatRandomizerPlugin-3.1.0 icon

ChatRandomizerPlugin

Roll custom random stuff from chat.

Date uploaded 3 years ago
Version 3.1.0
Download link LordAshes-ChatRandomizerPlugin-3.1.0.zip
Downloads 113
Dependency string LordAshes-ChatRandomizerPlugin-3.1.0

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0
LordAshes-FileAccessPlugin-1.4.1 icon
LordAshes-FileAccessPlugin

Provides standardized methods for accessing both local file and url resources. Automatically handles searching local folders for assets.

Preferred version: 1.4.1
LordAshes-ChatService-2.3.0 icon
LordAshes-ChatService

Dependency plugin to add services to the chat.

Preferred version: 2.3.0
LordAshes-GUIMenuPlugin-1.0.0 icon
LordAshes-GUIMenuPlugin

Add text/icon menus that appear in centre of screen or slide out the right side. Support for multi-layer hierarchy.

Preferred version: 1.0.0

README

Char Randomizer Plugin

This unofficial TaleSpire plugin for randomly determining items from a list. Supports real time lists and named pre-configured lists.

This plugin, like all others, is free but if you want to donate, use: http://LordAshes.ca/TalespireDonate/Donate.php

Change Log

3.1.0: Added tally (total) support
3.0.0: Added multiple randomization per request
3.0.0: Added optional named randomization
3.0.0: Added added soft dependency for chat whisper so result can be whispered
2.1.3: Initial release

Install

Use R2ModMan or similar installer to install this plugin.

Usage

There are four types of rolls. Generic rolls, Named rolls, Generic Rolls with Tally and Named rolls with Tally. Each of which can use pre-defined rolls (configured in a configuration file ahead of time) or real-time list (specified when rolling).

To perform a generic roll, use the /cr (Custom Roll) function. For example:

/cr RPS

or

/cr Rock Paper Scissors

To perform a named roll, use the /cnr (Custom Named Roll) function. For example:

/cnr Gesture RPS

or

/cnr Gecture Rock Paper Scissors

When using the named functionality the first item in the list is treated as the name. This is what is displayed instead of "Roll" when displaying the result. It should be noted that if the verbose setting is turned off the result is not prefixed by the name but a cnr roll will still consume the first entry for the name.

To use the tally (total the value) version, add an t as the last letter of the command. When using the tally functions the results need to be numeric. Non-numeric sides will be counted a 0.

/crt 0 0 1 1 2 3

or

/cnrt Fluff 0 0 1 1 2 3

Multiple Rolls

Multiple rolls can be requested in a single request by separating the rolls with a / character. Note that if using the custom named roll, a new name is used for each set of randomize options. For example:

/cr Miss Hit / Low Med High

or

/cnr Attack Miss Hit / Damage Low Med High

Multiple rolls are supported by all 4 of the functions (/cr, /cnr, /crt and /cnrt).

Whisper Rolls

This plugin is compatible with Chat Whisper plugin if it is installed. You can whisper the results of a roll to another user that has the Chat Whisper plugin installed. For example,

/w GM /cr Rock Paper Scissors

See the Chat Whisper plugin for more details on using Chat Whisper.

Pre-Configure Lists

To make rolling dice with a complex number of sides easier, custom dice can be defined in the Custom_Dice.json file. The file is a JSON with the roll name as the key and the roll sides as the value. For example:

{
	"RPS": "Rock Paper Scissors",
	"Half6": "- - - 0 0 0",
	"TriTen": "0 0 0 0 1 1 1 1 1 2"
}

To roll a named roll, use the cr (Custom Roll) command. Type: /cr name such as /cr RPS.