Skip to content

MaxGog/characterbook

Repository files navigation

Flutter Dart License

🎭 CharacterBook

Cross‑platform app for creating and managing characters in tabletop RPGs.

Want to keep all your player characters and NPCs organised in one place? CharacterBook helps you quickly build detailed characters using flexible templates, sort them into folders and tags, and then export them as beautiful PDF sheets.

Google Play Microsoft Store GitHub Release

✨ Key Features

  • 🎲 Flexible character creation: Use built‑in templates (D&D 5e, universal) or build your own with the template constructor!
  • 🗂️ Smart organisation: Arrange characters into folders, add tags, and use search for instant access.
  • 📄 Export to PDF and Word: Turn your characters, races, and templates into ready‑to‑print sheets (PDF) or editable documents (DOCX) with a single click.
  • 📱 Cross‑platform: The app works seamlessly on Android, Windows, and macOS. Web and iOS versions are in development.
  • 💯 Free and ad‑free: All features are available without any limitations or hidden fees.

🚀 Quick Start

📥 For Users

Simply download the app from your preferred store:

Platform Link
Android Google Play or RuStore
Windows Microsoft Store or GitHub Releases
macOS GitHub Releases (beta)

🛠️ For Developers

To build and run the project locally:

  1. Clone the repository:
    git clone https://github.com/maxgog/characterbook.git
    cd characterbook
  2. Install dependencies:
    flutter pub get
  3. Run the app:
    flutter run

For detailed information, see our installation guide.

🧱 Tech Stack

  • Framework: Flutter (3.13+).
  • Language: Dart (3.7+).
  • Database: Hive for fast local storage.
  • State management: Provider and flutter_bloc.
  • Document generation: pdf, printing, and docs_gee for creating PDF and DOCX files.

For a full list of dependencies and architectural details, refer to the ARCHITECTURE.md file.

👥 Contributing

We welcome any suggestions and help in developing the project! Please read CONTRIBUTING.md for information on how to report bugs, suggest improvements, and submit Pull Requests.

⚖️ License

Distributed under the GNU General Public License v3.0. See the LICENSE file for details.

💖 Support the Project

If you like CharacterBook, you can support its developer:

Boosty

📞 Contacts