Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.93 KB

README.md

File metadata and controls

68 lines (44 loc) · 3.93 KB

IniTUItive Tracker

application image

Table of Contents

  1. Introduction
  2. Installation
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

Introduction

IniTUItive Tracker is a simple RPG turn-order tracker for tabletop role-playing games. It allows you to track players and monsters in combat, and easily manage their initiative order with only a terminal interface. IniTUItive Tracker is designed with Pathfinder 2nd Edition in mind.

Installation

To install IniTUItive Tracker, simply clone the GitHub repository. You can run the application by executing go run main.go or by running run.sh. This means you must have go installed to use this application.

Usage

IniTUItive Tracker is meant to be easy to use and understand. Each command has an assigned key as a shortcut, and the commands are listed in each panel. From the Commands panel, you can see all the available commands and their keys:

Commands:
 n: Add a new combatant
 l: Navigate to the Initiative List panel
 q: Quit

From the Initiative List panel, you can see all the combatants in the current initiative order, and you can edit or delete a combatant by selecting their entry and pressing Enter. You can also see the available commands:

Commands:
 r: Return to the Commands panel

When adding or editing a character, you can enter their name, initiative bonus, and any other relevant information. The Initiative and HP fields accept integers only. The Team field is optional and can be used to group combatants together. The four Teams are Player (blue), Enemy (red), Ally (green), and Neutral (yellow), and the selected Team will cause that character's name to render in the terminal with that color. In Pathfinder 2e, in the case of a tie, Enemies attack first, so the program will automatically sort the initiative order to reflect this. Should two characters have the same initiative, you may set their order manually by entering a number in the Priority field. The higher the number, the earlier the character will act in the case of a tie. The buttons following the input fields are Save and Clear, respectively. Save will save the character to the initiative order, and Clear will clear the input fields for re-entry.
image showing input fields and team labels When selecting a character for editing, a new button will appear: Delete. This button will remove the selected character from the initiative order.

image showing example with priority input and visible delete button

There are a few other sample images in the img directory.

Contributing

If you would like to contribute to IniTUItive Tracker, please submit a pull request. I welcome any contributions, including bug fixes, feature enhancements, and translations. If you have any questions or feedback, please feel free to contact us.

License

IniTUItive Tracker is licensed under the MIT License. You are free to use, modify, and distribute this software as you see fit. I only ask that you include the original license and attribution in your distribution.

Contact

If you have any questions or feedback about IniTUItive Tracker, please feel free to submit an issue. You can also contact the author, KirbyPaint, on Discord (@kirbypaint)

Acknowledgements

I would like to thank the following individuals and organizations for their contributions to IniTUItive Tracker: