Skip to content

this D&D tracker is a project made for school and all the Dungeon Masters out there. the main function is to track encounters for a dungeon master.

Notifications You must be signed in to change notification settings

tomkoevoets/BP2-dndTracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BP2 logo

D&D Tracker

Welcome to the noble repository of mine D&D tracker, ye seeker of adventure!

Creator JavaFX Java Maven


🌟 About the Project

Hark! The D&D Tracker be thy indispensable squire, aiding Dungeon Masters in their noble endeavors. This application doth bring order to the chaos of Dungeons & Dragons, allowing DMs to swiftly record session details, call forth monsters, NPCs, and items, all at a moment's notice. The Encounter Tracker dost ease the burden of managing battles, displaying turn order and tracking the status of thine champions.

For Dungeon Masters, swift access to vital knowledge is crucial. In times of adventure, DMs are ever engaged in seeking information, which may slow the flow of the game. Thus, this humble tool provideth a means to store all relevant matters in one place, so that thou mayst attend to the game with utmost efficiency.

The D&D Tracker lets you store and manage all campaign data, ensuring you can access critical details with ease during your sessions.


🧰 Installation Instructions

Follow these steps to get your D&D Tracker up and running:

Prerequisites

Make sure you have the following installed:

  • Any working operating system
  • Integrated Development Environment (IDE) such as IntelliJ IDEA
  • XAMPP for database management (Only if you want to develop locally using your own database)

Installation Steps (for running the desktop app)

  1. Download the repository: D&D Tracker GitHub Repository
  2. Extract the contents of the ZIP file.
  3. Run the application via the JAR file which is located in the following files: bp2-dnd-tracker > out > artifacts > bp2_dnd_tracker_jar > bp2-dnd-tracker.
  4. Optionally, place the JAR file on your desktop for quick access.

Installation Steps (for local database running)

  1. Download the repository: D&D Tracker GitHub Repository
  2. Extract the contents of the ZIP file.
  3. Open the project in your IDE (IntelliJ).
  4. Start XAMPP, and ensure both Apache and MySQL are running.
  5. Click on the 'admin' button to access phpMyAdmin.
  6. Import the database file into the localhost phpMyAdmin.
  7. Run the application via IntelliJ, or use the standalone D&D Tracker JAR.
  8. Optionally, place the JAR file on your desktop for quick access.

Requirements

  • Java Development Kit (JDK) version 21.0.1 or higher. Download it from Oracle's website.

🔧 Configuration

  • No specific configurable options are required for setup.
  • Java version 8 or higher is required.

📚 Usage Guide

Once the tracker is up and running, follow these steps to maximize your experience:

1. Homescreen

  • Read the welcome text to start your journey with the D&D Tracker.

2. Sessions

  • The session screen displays all saved sessions. To manage sessions:
    • Click on Sessions in the navbar.
    • Click on a session to view details, and choose Delete or Update as needed.
    • To add a new session, click the 'Add Session' button.

3. Monsters

  • The monster screen displays all saved monsters linked to your sessions. To manage monsters:
    • Click on Monsters in the navbar.
    • View, delete, link, or update monsters from the respective screens.
    • To link a monster to a session, use the menu button to select a session.
    • To add a new monster, click 'Add Monster' at the bottom of the screen.

4. NPCs

  • Similar to monsters, NPCs can be linked to sessions and managed as follows:
    • Click on NPCs in the navbar.
    • View, delete, link, or update NPCs from their respective screens.
    • Add NPCs using the 'Add NPC' button.

5. Items

  • The item screen allows you to manage all saved items. You can:
    • Click on Items in the navbar.
    • View, delete, or update items as necessary.
    • Add new items by clicking 'Add Item'.

6. Encounter Tracker

  • The encounter screen is vital for tracking combat during sessions. It provides:
    • Turn order and HP tracking for monsters, NPCs, and players.
    • Add characters and players to the initiative list, adjusting HP as needed.
    • Add items for quick access during encounters.

🧭 Roadmap

The future possibilities for expanding the D&D Tracker are endless:

  • Add Campaigns as an entity
  • Allow monsters, NPCs, and items to have associated images
  • Add cool widgets for map and picture generation
  • Add a tutorial on how to use the applictation

📝 Code Standards

For best practices, follow the Code Standards for this project.


💬 Contact


💎 Acknowledgements

Thanks to everyone who contributed to this project and to the D&D community for their continuous support and inspiration!

About

this D&D tracker is a project made for school and all the Dungeon Masters out there. the main function is to track encounters for a dungeon master.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published