Skip to content
Back to search

CharSheet

Build, track and play D&D 5e (2024) characters. A KDE desktop app in Rust, Qt 6 and Kirigami, with the SRD 5.2.1 built in and an MCP server.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/linkion--charsheet/badge.svg)](/listings/linkion--charsheet)

HTML

<a href="/listings/linkion--charsheet"><img src="/api/listings/linkion--charsheet/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

make install       # builds a release binary and installs to ~/.local
make uninstall     # removes it again; your characters are kept

This installs `~/.local/bin/charsheet` and `~/.local/bin/charsheet-mcp` plus the launcher, icon and AppStream metadata, so CharSheet shows up in the application launcher. Make sure `~/.local/bin` is on your `PATH`. For a system-wide install use `sudo make install PREFIX=/usr/local`. `DESTDIR` works for staged (packaging) installs.

Other targets: `make run`, `make test`, `make clean`.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 197 lines
  1. # CharSheet
  2. **A D&D 5e (2024) character sheet that does the math, rolls the dice and keeps up at the table.**
  3. CharSheet is a KDE desktop app written in Rust with Qt 6 and Kirigami
  4. ([cxx-qt](https://github.com/KDAB/cxx-qt)). Enter ability scores, classes and gear, and it
  5. works out everything else. Then play straight from the sheet: attack, cast, take damage,
  6. rest, and watch 3D dice tumble across the window.
  7. ![The main sheet, with the breakdown behind a saving throw](docs/screenshots/main-sheet.png)
  8. ## Why CharSheet
  9. - **Every number explains itself.** Modifiers, proficiency, saves, skills, AC, initiative,
  10. spell save DC and attack, and spell slots (including multiclassing and Pact Magic) are
  11. all derived. Hover any of them to see where it comes from.
  12. - **Click to roll.** Any modifier rolls, with advantage or disadvantage. 3D dice land on the
  13. rolled numbers, and the roll log splits every total by source and damage type.
  14. - **Built for combat.** The Combat tab is the play surface: the round counter, active
  15. effects and concentration, attacks with every bonus worked in, and every action grouped
  16. by Action, Bonus Action and Reaction.
  17. - **Gear that actually does things.** Items, features and spells carry modifiers and
  18. actions: damage riders, once-per-turn bonuses, toggles, ammunition and reloading,
  19. charges, healing and effects.
  20. - **The whole SRD 5.2.1 built in.** Search the compendium and add spells, items and
  21. features with their stats and rules text. Conditions, properties and masteries link
  22. straight to the rules.
  23. - **AI-ready.** An included MCP server lets an assistant such as Claude read, edit and play
  24. your characters, and the open sheet updates live.
  25. ## A tour
  26. ### Combat
  27. ![The Combat tab: HP, effects, attacks and actions](docs/screenshots/combat.png)
  28. HP with temp HP, resistances, damage and healing, and death saves sit next to the turn
  29. tracker and active effects. Equipped weapons become attacks with every modifier included:
  30. here a revolver with a switchable Fire mode, a radiant pendant, choosable ammunition and a
  31. once-per-turn Slash Draw rider that greys out once used.
  32. ### The roll log
  33. ![The roll log, breaking a damage roll down by type and source](docs/screenshots/roll-log.png)
  34. Every roll, including those made through the MCP server, lands in the log. Expand one to
  35. see each die and bonus, with damage grouped by type. Type any expression, such as
  36. `2d6+3` or `4d6kh3`, to roll it.
  37. ### Spells
  38. ![Spells with slots, casting and the compendium](docs/screenshots/spells.png)
  39. Spellcasting stats and slots are worked out per class. Each spell shows its casting time,
  40. concentration and ritual tags, free uses and a one-click **Cast** that spends the right slot.
  41. ### Inventory
  42. ![Inventory with currency, carrying capacity and usable items](docs/screenshots/inventory.png)
  43. Currency, carrying capacity and attunement are tracked. Items can be equipped, stacked,
  44. spent and used, so drinking a potion or throwing oil is a single click.
  45. ### Features
  46. ![Features and traits with their modifiers and uses](docs/screenshots/features.png)
  47. Class features, feats and species traits list their source, uses and the modifiers they
  48. apply. Values that scale, such as proficiency-bonus uses and cantrip dice, follow the
  49. character through **formulas**, and items that recharge at dawn roll for their charges on
  50. a long rest.
  51. ## Features at a glance
  52. - Full 2024 rules math: modifiers, proficiency and expertise, saves, skills, passives, AC,
  53. initiative, spell DC and attack, spell slots with multiclassing and Pact Magic
  54. - Tracking for HP, temp HP, hit dice, death saves, spell slots, feature uses, conditions
  55. and Exhaustion, with short and long rests
  56. - Modifiers for AC, attack and damage, damage riders (such as Hunter's Mark or Slash Draw),
  57. speed, saves, max HP, resistances and notes
  58. - Actions that spend uses, charges or quantity, roll dice, heal and apply effects
  59. - 3D dice (turn them off with **3D Dice** in the sheet's menu) and a detailed roll log
  60. - The SRD 5.2.1 compendium, with `srd:` links in Markdown text, such as
  61. `[Prone](srd:condition:prone)`, opening the rules
  62. - Three themes: *Stone*, styled after the 2024 character sheet, *Parchment*, styled after
  63. the Player's Handbook, and *System*, which uses your desktop's colors and fonts
  64. - JSON import and export to share characters
  65. Modifiers and actions are filled in from the SRD only where they're certain: from
  66. structured data, or from a hand-checked table that quotes the rules. Everything else stays
  67. as text.
  68. `examples/sable.json` is a complete level 6 Ronin Ranger, the character in the screenshots
  69. at an earlier level; import it from the library page to see everything in use.
  70. ## Building
  71. Fedora packages needed:
  72. ```sh
  73. sudo dnf install cargo gcc-c++ qt6-qtbase-devel qt6-qtdeclarative-devel qt6-qtquick3d-devel \
  74. kf6-kirigami kf6-qqc2-desktop-style kf6-kcolorscheme-devel kf6-kconfig-devel
  75. ```
  76. Set `KF6_INCLUDE_DIR` if the KDE Frameworks headers aren't in `/usr/include/KF6`.
  77. ```sh
  78. cargo run -p charsheet # debug build
  79. cargo test -p dnd-core # rules engine tests
  80. cargo build --release
  81. ```
  82. ## Installing for your user
  83. ```sh
  84. make install # builds a release binary and installs to ~/.local
  85. make uninstall # removes it again; your characters are kept
  86. ```
  87. This installs `~/.local/bin/charsheet` and `~/.local/bin/charsheet-mcp` plus the launcher, icon and AppStream metadata, so
  88. CharSheet shows up in the application launcher. Make sure `~/.local/bin` is on your `PATH`.
  89. For a system-wide install use `sudo make install PREFIX=/usr/local`. `DESTDIR` works for
  90. staged (packaging) installs.
  91. Other targets: `make run`, `make test`, `make clean`.
  92. ## Usage
  93. ```sh
  94. charsheet # open the character library
  95. charsheet --open "Brakka" --tab 1 # open a character by name or id on a tab (0-6)
  96. ```
  97. The ⋮ menu's Theme entry switches between the *Stone*, *Parchment* and *System* themes.
  98. Characters and their recent dice rolls are stored in a SQLite database at
  99. `~/.local/share/charsheet/charsheet.db`. Use Export/Import on the library page to share a
  100. character as a JSON file.
  101. ## MCP server
  102. `charsheet-mcp` is a [Model Context Protocol](https://modelcontextprotocol.io) server over
  103. stdio, so an AI assistant can read, edit and play your characters. To add it to Claude Code:
  104. ```sh
  105. claude mcp add charsheet -- ~/.local/bin/charsheet-mcp
  106. ```
  107. It works on the same library as the app (`--db <path>` picks another one). Changes are saved
  108. immediately, and the server tells any running app, so a character open there updates at
  109. once.
  110. - **Library:** `list_characters`, `create_character`, `duplicate_character`,
  111. `delete_character`, `import_character`, `export_character`
  112. - **Reading:** `get_character` (the whole sheet with derived values, or one part by JSON
  113. Pointer such as `/inventory` or `/derived/weapon_attacks`), `get_catalog` (valid choices)
  114. - **Rules:** `search_srd`, `get_srd`, and `add_from_srd` to put a spell, item or feature on
  115. a character
  116. - **Editing:** `set_field`, `append_item`, `remove_item`, `move_item` by JSON Pointer
  117. (`/hp/max`, `/skills/stealth`, `/inventory/2/modifiers`), and `apply_edits` for several
  118. at once, all or nothing
  119. - **Play:** `damage`, `heal`, `set_temp_hp`, `spend_hit_die`, `short_rest`, `long_rest`,
  120. `roll`, `get_rolls`, `clear_rolls`, `use_item_action`, `use_feature_action`,
  121. `cast_spell`, `weapon_attack`, `weapon_damage`, `reload`, `apply_effect`, `end_effect`,
  122. `new_turn`, `end_combat`
  123. ## Layout
  124. - `crates/dnd-core`: the model, rules (SRD 5.2 tables), dice, JSON-pointer edits, play
  125. actions, storage and the embedded SRD (`src/srd/`). It has no Qt dependency and is
  126. unit-tested.
  127. - `crates/charsheet`: the Qt app. `src/bridge/` exposes `CharacterLibrary`,
  128. `CharacterSheet` and `Srd` to QML, and `qml/` holds the Kirigami UI. `cpp/theme.h` applies the
  129. bundled color schemes in `theme/`, and `qml/SheetFrame.qml` and its neighbours draw the
  130. sheet decorations. `tools/make_textures.py` generates the background textures.
  131. - `packaging/`: the desktop launcher, icon and AppStream metadata, and
  132. `docs/screenshots/` the screenshots used here and in the metadata.
  133. - `crates/charsheet-mcp`: the MCP server, built on `dnd-core` with
  134. [rmcp](https://crates.io/crates/rmcp).
  135. - `data/srd`: the whole SRD 5.2.1 as structured, searchable JSON (spells, monsters, magic
  136. items, classes, equipment, rules text and more), generated from the SRD PDF by
  137. `tools/srd` with `make srd` and compiled into `dnd-core`. See `data/srd/README.md` for
  138. the format.
  139. ## License
  140. CharSheet is free software, licensed under the GNU General Public License, version 3 or
  141. (at your option) any later version. See [LICENSE](LICENSE).
  142. This work includes material from the System Reference Document 5.2.1 ("SRD 5.2.1") by
  143. Wizards of the Coast LLC, available at <https://www.dndbeyond.com/srd>. The SRD 5.2.1 is
  144. licensed under the Creative Commons Attribution 4.0 International License, available at
  145. <https://creativecommons.org/licenses/by/4.0/legalcode>. It has been reformatted as
  146. structured data, and the app's rules dialogs credit it.
  147. The bundled fonts in `crates/charsheet/fonts/` are Solbera's 5e font imitations (with fixes
  148. by Ryrok, Ners and LUCASTUCIOUS), licensed under CC-BY-SA-4.0; see the README there.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.