Skip to content

Commit

Permalink
Add changelog.md and initial mermaid doc placeholder
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxWilson committed Dec 5, 2023
1 parent 3d9dee9 commit e6057e4
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
45 changes: 45 additions & 0 deletions docs/DFRPG_Chargen.md
Original file line number Diff line number Diff line change
@@ -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 --> [*]
```

0 comments on commit e6057e4

Please sign in to comment.