From b2f0d4964d3e805a8bdf2f4d4fa9359126507694 Mon Sep 17 00:00:00 2001 From: Michael Hansen Date: Fri, 12 Jul 2019 08:47:33 -0700 Subject: [PATCH] update documentation --- CHANGELOG.md | 42 ++++++++++++++++++++++++++++++++++++ deploy.md => README.md | 48 +++++++++++++++++++++--------------------- 2 files changed, 66 insertions(+), 24 deletions(-) create mode 100644 CHANGELOG.md rename deploy.md => README.md (76%) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1491ffd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,42 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](changelog), +and this project adheres to [Semantic Versioning](semver). + +## [Unreleased] +- Troll stock +- Add emotional attributes to the PDF +- Add a page to the pdf for Health + Steel questions +- Add a page to the pdf for trait descriptions +- Add weapon info to the pdf based on some educated guesses (e.g. do you have the arms resource and the Spear skill?) +- Write a guide on creating your own JSON data files +- Custom upload for your own data files +- Updates to Roden and Great Wolves files (currently the data comes from Monster Burner and not Codex) + +## [2.1.0] - 2019-07-11 +### Added +- Dark Elf lifepaths and Spite emotional attribute. +- README.md and CHANGELOG.md + +### Changed +- Spite is calculated using the Grief value, and this required some updates to the + +## [2.0.1] - 2019-07-10 +### Fixed +- First Mate LP is now selectable with 2 seafaring LPs. Previously: if Son of a Gun was the first LP, it was not selectable. Example: Son of a Gun -> Officer's Mate -> First Mate. + +## [2.0.0] - 2019-07-09 +### Added +- Use the Gold character sheet +- Display the trait descriptions next to the traits +- Added the Wizard Burner lifepaths +- Updated the color scheme so you know you're using the new one + +### Changed +- Charred Black release. Most of the frontend code is the same as Charred, but the backend is completely rewritten (out of necessity). +- Emotional attributes are calculated but not yet shown on the character sheet. + + +[changelog]: https://keepachangelog.com/en/1.0.0/ +[semver]: https://semver.org/spec/v2.0.0.html \ No newline at end of file diff --git a/deploy.md b/README.md similarity index 76% rename from deploy.md rename to README.md index e4e7ed2..3e5441c 100644 --- a/deploy.md +++ b/README.md @@ -1,25 +1,18 @@ -Deploy ------- +# Charred Black -https://devcenter.heroku.com/articles/container-registry-and-runtime +The unofficial, online, Burning Wheel Gold (+Codex) character burner. Adapted from [Charred](https://charred.herokuapp.com/). +## Deploy Steps + +See: [Heroku - Container Registry and Runtime](https://devcenter.heroku.com/articles/container-registry-and-runtime) + +``` heroku login heroku container:login heroku container:push web -a charred-black heroku container:release web -a charred-black heroku open - -## Changelog - -2.0.1 - update - -First Mate LP should be selectable with 2 seafaring LPs. If Son of a Gun is the first LP, it is not selectable. -Example: Son of a Gun -> Officer's Mate -> First Mate. - -2.0.0 - Charred Black release -gold character pdf -wizard burner lifepaths - +``` ## Beliefs @@ -34,8 +27,10 @@ of other gaming tools, but let's keep this tool focused on one thing and do it r ### Stick To Published Material In order to keep the scope of my maintainership finite, I'm not planning to accept community-made lifepaths et al. for inclusion -in this codebase. Each additional data set increases Charred Black's startup time and memory requirements. Additionally, that -makes me an arbiter of quality, and I'd prefer not to have the Enmity Clause invoked because I rejected someone's homebrew content. +in this codebase. Each additional data set increases Charred Black's startup time and memory requirements. The design of your lifepath +requirements and emotional attributes may not be supported by the editor, or convoluted to implement. Finally, deciding to include +community-made content would make me an arbiter of quality, and I'd prefer not to have the Enmity Clause invoked because I rejected +someone's homebrew content. I am working on a solution for uploading lifepaths et. al which would be stored locally in your browser and not permanently on a server. This way, you can make your data files and share them around with your friends for use with this tool. If someone else @@ -63,11 +58,10 @@ More guidelines: * Only .pdf and .char file formats should be returned as responses when getting data out of the cache. I'll consider other formats on a case-by-case basis: for example, I'd be open to a format which could be used with Roll20. -## Guide - -### Best Practices +## Contribution Best Practices -No matter what's in the book, always Capital Case for skills, traits, lifepaths and settings: +### Capital Case +No matter what's in the book, always use Capital Case for skills, traits, lifepaths and settings: e.g. Path Of Spite Subsetting @@ -80,7 +74,13 @@ Hyphens: the word after the hyphen is not capitalized: Rabble-rouser Burden Of The Crown-wise -Anatomy of a lifepath +### Lifepath Example + +Some notes: +1. The best way to create new lifepaths is by following the same advice that Burning Wheel gives you: look at something similar that already exists and adapt it. +1. In the `stat` block below, you'd get both a mental and physical stat point for taking this lifpath. If you want either/or, use `[1, "pm"]`. + + ``` { "Example Setting": { @@ -100,7 +100,7 @@ Anatomy of a lifepath "skills": [ [ 3, - "Inconspicuous" + "JSON-wise" ], [ 1, @@ -109,7 +109,7 @@ Anatomy of a lifepath ], "traits": [ 1, - "" + "Plucky" ], "requires": "", "requires_expr": [