danwizard208
/
charred-gold
1
0
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Wiki Activity

readme updates and version bump

Browse Source
pull/1/head
Michael Hansen 5 years ago
parent b2f0d4964d
commit 198cbc3363
5 changed files with 30 additions and 17 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 32
      README.md
  2. 2
      src/data/dark_elf/lifepaths.json
  3. 2
      src/public/js/server_settings.js
  4. 1
      src/views/index.erb
  5. 10
      src/views/partials/help.erb

32
README.md
Unescape View File

@ -4,6 +4,8 @@ The unofficial, online, Burning Wheel Gold (+Codex) character burner. Adapted fr
## Deploy Steps ## Deploy Steps
_This is mine, it won't work for you._
See: [Heroku - Container Registry and Runtime](https://devcenter.heroku.com/articles/container-registry-and-runtime) See: [Heroku - Container Registry and Runtime](https://devcenter.heroku.com/articles/container-registry-and-runtime)
``` ```
@ -28,13 +30,12 @@ of other gaming tools, but let's keep this tool focused on one thing and do it r
In order to keep the scope of my maintainership finite, I'm not planning to accept community-made lifepaths et al. for inclusion 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. The design of your lifepath 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 requirements and emotional attributes may not be supported by the editor, or may be convoluted to implement. Most importantly, deciding to include any community-made content makes me an arbiter of quality, and I'd prefer not to have the Enmity Clause invoked because I rejected
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.
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 **However**, 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 a server. This way, you can create data files to use with this tool and share them with your friends. If someone else
wants to keep a repository or forum thread of data files known to work with Charred Black, I'd happily to link to it in this wants to keep a repository or forum thread of data files known to work with Charred Black, I am happy to link to it in this
documentation and from the website itself. I don't want to discourage contributions, I just want do one thing well. documentation and from the website itself. I don't want to discourage contributions, I just want do one thing well.
### Keep It Mostly Stateless ### Keep It Mostly Stateless
@ -61,18 +62,19 @@ More guidelines:
## Contribution Best Practices ## Contribution Best Practices
### Capital Case ### Capital Case
No matter what's in the book, always use Capital Case for skills, traits, lifepaths and settings: No matter what's in the book, always use Capital Case for skills, traits, lifepaths and settings.
* Path Of Spite Subsetting
* Never A Moment Of Peace
* Ages Of The Etharch
* Reeks Of Alcohol
e.g. ### Hyphens
Path Of Spite Subsetting
Never A Moment Of Peace
Ages Of The Etharch
Reeks Of Alcohol
Hyphens: the word after the hyphen is not capitalized: The word after the hyphen is not capitalized.
Rabble-rouser * Rabble-rouser
Burden Of The Crown-wise * Burden Of The Crown-wise
### Lifepath Example ### Lifepath Example

2
src/data/dark_elf/lifepaths.json
Unescape View File

@ -31,7 +31,7 @@
"traits": [ "traits": [
2, 2,
"Filthy", "Filthy",
"Feral" "Feral Elf"
], ],
"requires": "Griever", "requires": "Griever",
"requires_expr": [ "requires_expr": [

2
src/public/js/server_settings.js
Unescape View File

@ -1,5 +1,5 @@
var serverSettings = { var serverSettings = {
'versionString' : '2.0.0', 'versionString' : '2.1.0',
'storageType' : 'client', 'storageType' : 'client',
'displayAttrMath' : 'false' 'displayAttrMath' : 'false'
} }

1
src/views/index.erb
Unescape View File

@ -18,6 +18,7 @@
<title>Charred - The Burning Wheel Gold Character Burner</title> <title>Charred - The Burning Wheel Gold Character Burner</title>
</head> </head>
<body> <body>
<a href="https://github.com/modality/charred-black" class="github-corner" target="_blank" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
<div class='container' ng-controller='BurningCtrl'> <div class='container' ng-controller='BurningCtrl'>
<nav class='navbar navbar-default' role='navigation'> <nav class='navbar navbar-default' role='navigation'>
<div class='navbar-header'> <div class='navbar-header'>

10
src/views/partials/help.erb
Unescape View File

@ -36,6 +36,9 @@
<li> <li>
<a href='#/help?scrollTo=wizards'>Hints for Wizards</a> <a href='#/help?scrollTo=wizards'>Hints for Wizards</a>
</li> </li>
<li>
<a href='#/help?scrollTo=dark_elves'>Hints for Dark Elves</a>
</li>
</ul> </ul>
</div> </div>
<div class='col-md-9'> <div class='col-md-9'>
@ -54,6 +57,9 @@
The first part of this guide goes over the main features of Charred in the order that they appear The first part of this guide goes over the main features of Charred in the order that they appear
in the main view. At the end is a description of some tricks for specific stocks. in the main view. At the end is a description of some tricks for specific stocks.
</p> </p>
<p>
The source code for this version can be found on Github: <a href="https://github.com/modality/charred-black" target="_blank">Charred Black source</a>.
</p>
<h2 id='tools'>Tools</h2> <h2 id='tools'>Tools</h2>
<p> <p>
This section of Charred contains features for uploading and downloading data: This section of Charred contains features for uploading and downloading data:
@ -215,6 +221,10 @@
The Court Summoner lifepath trait 'Frustrated' was changed to 'Disgruntled' to avoid a conflict with the Roden trait of the The Court Summoner lifepath trait 'Frustrated' was changed to 'Disgruntled' to avoid a conflict with the Roden trait of the
same name. same name.
</p> </p>
<h2 id='dark_elves'>Dark Elves</h2>
<p>
The Wastrel lifepath trait 'Feral' was changed to 'Feral Elf' to avoid a conflict with the character trait of the same name.
</p>
</div> </div>
</div> </div>
</div> </div>
Write Preview
Loading…
Cancel
Save