Skip to content

Combat Companion is a simple web-based companion app for Dungeon Masters that allows robust initiative, HP, and round tracking along with statblock viewing, editing, and saving for Dungeons & Dragons

License

Notifications You must be signed in to change notification settings

timblegoorn/Combat-Companion

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Combat Companion - Dungeons & Dragons DM Tool to Track Combat

Description

Combat Companion is a simple web-based app that allows combat/encounter tracking and features for Dungeons & Dragons. You can view the latest release live here: Combat-Companion.Nexodus.net

Present notable features include:

  • Connected to Open5E API to access predefined statblocks. By default, shows all statblocks in alphabetical order, but can also search by keyword.
  • Create your own statblocks for enemies or PCs
  • Initiative tracking
  • Styled display of current combat and recreated statblocks
  • Loading and saving current combat (to local storage)
  • Turn and round tracking
  • Status effect tracking (with optional feature to set status effect for set turns that decrements on each turn)
  • Encounter XP tracking (total available, earned, and amount divided between PCs)
  • Current HP modification

image

Future features will include:

  • Dynamic and improved saving and loading system to save and access a list of custom PCs and monsters with option to export and import
  • Keeping track of special features like breath weapons
  • Apply damage in bulk (e.g., fireball cast, mark which enemies are hit, roll Dex saves, and automatically apply damage appropriately)
  • Further implementation of the Open5E API to access spell descriptions dynamically
  • Polish

Getting Started

Installing

  • Combat Companion is designed to be simple and lightweight. As a result, it uses vanilla Javascript, HTML, and CSS with minimal dependencies
  • It can be installed by cloning the folder wherever you would like and unzipping if necessary

Running the Program

  • Open "Index.html" in a modern web browser
  • Internet access is required to access the Open5E API, but otherwise the app is still fully functional offline
  • Can also be accessed live at Combat-Companion.Nexodus.net with an internet connection

Help

Combat Companion is designed for a minimum screen resolution of 940px wide for optimal display. It will not display properly if used at a lower resolution.

Make sure to use a Javascript enabled modern web browser, such as the latest version of Firefox, Chrome, Edge, Opera, or Safari.

Authors

Version History

  • v0.3
    • Statblocks can be "popped out" and dragged around the screen for quick reference
    • New "Quick Info" panel that displays relevant information about the currently selected unit and/or the current unit's turn with the option to heal or damage in bulk.
    • New flow of adding units to combat with option to edit and add prebuilt statblocks as before, or perform a "Quick Add" which allows users to provide only the bare minimum information to add a unit to combat if they do not wish to customize a statblock.
    • Added support for death saving throws for player characters. A new window opens on a player character's turn that forces the DM to perform a death saving throw. On 3 failed saves, the PC dies.
    • Additional action buttons in the table to clone or delete existing units.
    • Added "Notes" section for all units
  • v0.2
    • Functional implementation connected to Open5E API
    • Stylized statblocks and initiative tracking
    • Status effect tracking, XP tracking, HP modification, full statblock modification
    • Turn & round tracking
  • v0.1
    • Initial Release. Basic initiative ordering

License

This project is licensed under the GPL-3.0 license - see the License File

Wizards of the Coast content provided under the terms of the Open Gaming License Version 1.0a

Acknowledgements