Code Monkey home page Code Monkey logo

timblegoorn / combat-companion Goto Github PK

View Code? Open in Web Editor NEW
6.0 1.0 0.0 4.79 MB

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

Home Page: https://combat-companion.nexodus.net

License: GNU General Public License v3.0

HTML 2.52% JavaScript 86.16% CSS 11.31%
dnd dnd-characters dnd-kit dnd-tools dnd5e dnd5e-tools dm-tool dm-tools dungeons-and-dragons dungeon-master initiative-tracker combat-companion javascript open5e

combat-companion's Introduction

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

combat-companion's People

Contributors

timblegoorn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

combat-companion's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.