KernelPanic92 / dungeon-paper-app

A Dungeon World character sheet app written with Flutter

Dungeon Paper

Dungeon World players, this is the app for you!

Keep all your characters' bio, stats, moves and possessions with this interactive character sheet. Join for smoother, zero-hustle Dungeon World campaigns!

Dungeon Paper is an interactive character sheet for your Dungeon World characters. This is the source of this app, but to fully use it you must set up your own firebase credentials and sign your own app. Once that is properly set up, the app should create entities based on logins to the app, so nothing else should be created for the database beforehand. No one in this repository will provide any secret keys to anyone, ever.

Features

• Unlimited number of character sheets
• Create your own classes and races to use for your characters
• Add basic details (character name, image, race and alignment)
• Set and view stats and modifiers, life, experience, armor and damage dice
• Add moves and spells from the playbook, or add your own homebrew
• Keep track of inventory items, coins and load
• Add notes, moves, spells, and other custom content with rich text, checkboxes and tables using Markdown
• Roll any dice or roll your actions directly

Development Set Up

1. Download Flutter

   Use whatever Flutter channel you deem necessary, this should be compatible with master and beta, dev breaks a lot so no commitment. More information on Flutter.dev.

2. Connect your Firebase credentials for the app

   • Android Instructions
   • iOS Instructions

3. Build & Run the project

---

Contributing

I am developing this package on my free time, so any support, whether code, issues, or just stars is very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate just a small amount to help sustain this project, I would be very very thankful!

I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature, don't hesitate to open an appropriate issue and I will do my best to reply promptly.

Help with code

1. Fork this repository
2. Run the project, and make your changes.
3. Do your best to make sure nothing breaks. There are minimal tests so try QAing the change yourself before proceeding
4. Create a PR once you have a stable contribution

As mentioned above, Firebase secret keys must be your own, and so are the databases and services related to them. This project uses Firebase auth, Firestore, and Crashlytics.

Help by bug reporting or requesting features

• Feel free to use the GitHub issues to post one of the issue templates.
• We are also active on Discord