PathKit is a virtual GM (Game Master) screen for the tabletop role-playing game Pathfinder 2e. It provides a set of tools and features to assist GMs in running their game sessions smoothly and efficiently. This GitHub repository contains the source code for PathKit, and this README serves as a guide to help users understand its features and installation process.
View an example gameplay usage of prototype
View a demo for the Alpha Release
- Click on planned encounters: You can select an encounter you have planned to run the initiative screen and organize initiative for you.
- Add Players, NPCs, Structures, Hazards, and Monsters: You can create custom entities by using the creation menu in the upper left corner of the header.
- Add Planned Encounters or Exploration Paths: You can create custom plans by using the creation menu in the upper left corner of the header.
PathKit comes with the following major features:
- Physics-based Dice Roller: PathKit includes a physics-based dice roller that provides realistic and immersive rolling experience for GMs and players.
- GM Customization Options: GMs can customize various input options in PathKit, such as modifying dice rolls, adjusting character stats, and setting up encounter modes.
- Create Exploration or Encounter Modes: PathKit allows GMs to create exploration or encounter modes, where they can easily manage player and NPC actions, initiative order, and other game mechanics.
- Add Players/NPCs/monsters/Shops: PathKit provides an easy-to-use interface for GMs to add and manage players, NPCs, monsters, and shops within the game session.
- Integrated Search Engine: PathKit includes an integrated search engine that allows GMs to quickly search for rules, spells, items, and other game-related information.
- Notes Feature: PathKit has a built-in notes feature that enables GMs to take and manage session notes, campaign details, and other important information.
In addition to the major features, PathKit has the following stretch goals:
- Apply Damage to Parties Based on Rolls: PathKit includes a button that allows GMs to apply damage to parties based on rolls, providing a quick and convenient way to resolve combat and other situations. (available in future releases)
- Take Links from PathBuilder: PathKit integrates with PathBuilder, a popular character building tool for Pathfinder 2e, allowing GMs to easily import player builds into their game session. (currently included!)
- Tablet View: PathKit is designed to be responsive and compatible with tablet devices, providing a swipeable interface for easy navigation between different portions of the screen. (available in future releases)
Bonus features in PathKit include:
- Tutorial Tips and Beginner Walkthrough Panels: How-to modules are included in PathKit to make initial use of PathKit easier for new or veteran users.
- Information Panels: Information panels for Conditions, Income earned, and DC adjustment are included in PathKit as well. These are useful guides showing some of the standard information used in Pathfinder gameplay, which support activites such as in-game difficulty adjustments.
PathKit is built using the MVC (Model-View-Controller) architecture system, with the following technology stack:
- Model The responsibilities of Model classes include managing the data and business logic of the application, such as retrieving data from APIs or databases, processing data, and enforcing business rules. We are using SQLite.
- View The responsibilities of View components include rendering the user interface using React components, handling user input, managing component state, and updating the UI based on user interactions. We use a a react-ts Vite instance.
- Controller The responsibilities of Controller components include handling user input, updating the Model based on user actions, and triggering updates in the View to reflect changes in the data. They act as the glue between the Model and View components, facilitating communication and coordination. Our zustand store does this.
- Container It provides a bridge between the web-based UI components built with React, Vite, and TypeScript, and the native desktop environment, enabling a smooth and seamless user experience. We are using Tauri.
To install and run PathKit locally please look over our helpful Wiki user guide which we update with each release as needed.
Contributions to PathKit are welcome! If you would like to contribute to the development of PathKit, please follow the guidelines outlined in the developers guide in the wiki. Included are instructions on how to build, run, and test using our existing tools.
PathKit is released under the MIT License, which allows for free use, modification, and distribution of the software. Please refer to the LICENSE file for more details.
We want to thank our amazing professor for helping lead us through a complete production process and make our vision a reality! Thank you Nigini! We also want to thank our TA, Apollo, for all the work they put into reviewing our project to make it have more complete communication and well defined project goals.