From e6057e449844017a20f278697f9bb8e3a327581a Mon Sep 17 00:00:00 2001 From: Max Wilson Date: Tue, 5 Dec 2023 08:34:30 -0800 Subject: [PATCH] Add changelog.md and initial mermaid doc placeholder --- CHANGELOG.md | 17 ++++++++++++++++ docs/DFRPG_Chargen.md | 45 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 docs/DFRPG_Chargen.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..88b1634 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +Add DFRPG character generation + +## [0.1.0] - 2020-12-01 +First release +Add priest spells for AD&D + +### Added +- This release already has lots of features + +[0.1.0]: https://github.com/MaxWilson/ShiningSword/releases/tag/v0.1.0 diff --git a/docs/DFRPG_Chargen.md b/docs/DFRPG_Chargen.md new file mode 100644 index 0000000..62e4c6b --- /dev/null +++ b/docs/DFRPG_Chargen.md @@ -0,0 +1,45 @@ +# DFRPG Chargen Design Doc + +## Requirements + +Supports all DFRPG Adventurers templates +Skills, advantages, disadvantages, quirks +Random attribute generation option +Doesn't double-charge for things that show up in multiple sections, like disadvantages or quirk buys + +```mermaid +stateDiagram-v2 + state Chargen { + [*] --> RollAttributes + RollAttributes --> ChooseProfession + RollAttributes --> ChooseRace + ChooseRace --> RollAttributes + ChooseProfession --> CompleteTemplate + ChooseProfession --> AddQuirks + CompleteTemplate --> BuyEquipment + BuyEquipment --> Save + AddQuirks --> Save + RollAttributes: Roll Attributes (optional) + ChooseRace: Choose Race (optional) + ChooseProfession: Choose Profession (radio buttons, collapsible, remember preference, allows random) + CompleteTemplate: Complete template (250 point budget) + AddQuirks: Add quirks (optional, raises budget) + BuyEquipment: Buy equipment + Save: Save character + Save --> [*] + } + state "Advancement" as Advancement { + Save2: Save character2 + [*] --> AddToTemplate + AddToTemplate --> BuyMoreEquipment + BuyMoreEquipment --> SaveAgain + SaveAgain --> [*] + AddToTemplate: Add more traits (above initial 250 point limit) + SaveAgain: Save changes + BuyMoreEquipment: Spend cash, buy more stuff + } + [*] --> Chargen + Chargen --> Advancement + Advancement --> Advancement + Advancement --> [*] +```