LordAshes-TurnCountersPlugin icon

TurnCountersPlugin

Provides custom turns increasing and decreasing counters

Last updated 2 weeks ago
Total downloads 830
Total rating 0 
Categories Tweaks Client-side Tools Integration
Dependency string LordAshes-TurnCountersPlugin-2.0.0
Dependants 1 other package depends on this package

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.5.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag that mods are installed for BouncyRock.

Preferred version: 2.5.0
LordAshes-FileAccessPlugin-1.7.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.7.1
LordAshes-AssetDataPlugin-3.4.0 icon
LordAshes-AssetDataPlugin

Dependency plugin for subscription/notification based data storage and message exchange.

Preferred version: 3.4.0
LordAshes-LoggingPlugin-1.0.1 icon
LordAshes-LoggingPlugin

Provides unified logging functionality

Preferred version: 1.0.1
HolloFox_TS-RadialUIPlugin-3.0.0 icon
HolloFox_TS-RadialUIPlugin

This is a developer tool based package used to manage and configure Radial UI Menus.

Preferred version: 3.0.0
LordAshes-CommonCustomsMenuPlugin-1.1.0 icon
LordAshes-CommonCustomsMenuPlugin

Common menu for custom content plugins to register with.

Preferred version: 1.1.0

README

Turn Counters Plugin

This unofficial TaleSpire plugin provides custom turn counters which can be used to track effects that last a set number of turns. Predefined counters can be added and removed from the CCM menu but ad-hoc counters can be added and removed using the radial menu. Supports either seeing all counters or seeing just the counters for the selected mini. Also supports GM counters which can be put on player minis but will show only to the GM.

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

Install

Use R2ModMan or similar installer to install this plugin.

Counter Configuration

To create counters that can be added and remove though the Common Custom Menu (CCM):

  1. Create text file with the name org.lordashes.plugins.turncounter.Counters.Name.txt where Name is replaced with a unique name for the counter.
  2. Insinde the file write a one line in the format: Name|start|stop or Name|start|stop|version for example a counter called Haste which goes from 10 down to 0 would be: Haste|10|0 or Haste|10|0|1.0.0
  3. Save the file in any File Access Plugin legal location.
  4. Run Talespire and the counter will appear in CCM under a Counter type.

Display Configuration

The configuration file for the plugin has many configurable parameters that defined the starting point of the turn counter display (Left, Top), the offset to each displayed item (name, start, current, end), and the Y offset for each item.

The background for the legend and each entry is contained in: org.lordashes.plugins.turncounters.legend.png and org.lordashes.plugins.turncounters.background. You can edit these PNG files to change the appearance of the item entries. There are similar icons for CCM and the radial menu which can be customized.

The Counters To Display allows the user to select between all and forMiniOnly. When the setting is set to all, all turn tokens will be displayed regardless which mini is selected and regardless which mini is in the turn order. If forMiniOnly is selecetd, only the turn tokens for the selected mini are displayed. It should be noted that this uses the selected mini and not the mini in the current turn order.

Usage

Common Customs Menu

  1. Select a mini
  2. Open CCM
  3. Select Counter as type
  4. Select a counter from the available options

If the selected mini already has that counter, it is removed. If not, it is added.

Ad-Hoc Radial Menu Counters

To add a counter:

  1. Select a mini
  2. Right click the mini to open the radial menu
  3. Select Counters
  4. Select Add Counter
  5. Enter the counter specs in the format name|start|end were start and end are integer numbers.

Note: If the name ends with a * the turn counter will be visible to GM only.

To remove a counter:

  1. Select a mini
  2. Right click the mini to open the radial menu
  3. Select Counters
  4. Select Remove Counter
  5. Enter the counter name

To edit a counter's value:

  1. Select a mini
  2. Right click the mini to open the radial menu
  3. Select Counters
  4. Select Edit Counter
  5. Enter the counter name and value in the format name|value

Limitations

  1. Ad-hoc counters will not be added to CCM automatically