Latest revision as of 23:02, 21 September 2021

Page Updated:   2021-09-21

[edit] For Players

These sections cover specific mechanisms used during play in more detail.

[edit] Summary Page

Stores the character details and core stats. When filling in specific fields - listed below - it will auto generate certain information.

[edit] Resources

We base your health maximum on your iron stat. This will automatically increase as if your Iron increases. The 'Reset' button will only reset your current health to the maximum.

[edit] Stats

When first loading the character page you will have the option to update the 5 main stats. Once you click 'SET' it will change them into clickable buttons that will trigger a roll. They can be edited once again by clicking 'EDIT'.

When picking an ancestry if you type the chosen name into the checkbox it will automatically update the stats to reflect the base values from the rulebook. When adding an age - either number of years, eg: 28, or a descriptor, eg: young - It will automatically show the max values for each stat. Note: These are not enforced since custom assets and other factors can effect those values.

[edit] Moves Page

The move page expands on the Ironsworn Sheet example though offering 2 modes. Search and Preview. On the search mode you have a compact view of all the moves in the game. With a search bar that will highlight any moves that matches the text typed. You can then click on that skill and be taken to a preview page, where it will show the move text along with the roll buttons. Currently the search page does not have roll buttons, but this may change based on user feedback.

[edit] Site Page

The Site worksheet was mostly ported straight from the Ironsworn sheet, but now includes the Theme/Domain within them.

[edit] Macro Makers

[edit] Custom Oracles

These can be done by first making a rollable table from the roll20 Game and then add this macro.

&{template:ironcrunch_oracles} 
header=name-of-oracle 
custom-oracle=[[1t[name-of-table]]]

[edit] For Sheet Authors

Part of the aim of this sheet is to use as much of the same code between it and the Ironsworn sheet to allow users to be able to switch between the two with minimal context change. Though some values required updating along with attribute renames.

[edit] Tooling

• Node Package Manager: Used for maintaining all the other tools and running the build scripts.
• pugjs: HTML Templating language. It allows for removing most of the duplication you need to deal with when handling Pure HTML sheets.
• Stylus: A CSS templating language allows splitting of styles into components so they can be maintained alongside their html components.

[edit] Coding conventions

• Variables/mixins should be written in camelCase. (no spaces and all words should be capitalised aside from the first)
• JSON/Object keys should use underscores: `just_like_me`
• .pug files in /components should be reusable.
• Content such as moves should be in the /content directory
• New Oracles or Moves should be added to the /data directory.
• Keep duplication to a minimum.
• Comment on hard to understand code using the example included in the README.md

[edit] Feature Roadmap

• Implement Companion Sheet
• Implement Group Sheet
• Implement Foe Sheet
• Full Condition Support
• Resource Roll Buttons
• Refactor Oracles to use new template
• Ancestries: Move - Automated Modifiers
• Ancestries: List Addtional info
• Effort Automation (If possible)
• Equipment Autofill
• Custom Motivations
• Owl Companion Support
• Theat Support
• Mutiple Theme/Domains
• Auto select Theme and Domain using text fields.
• Nested Oracles

[edit] Changelog

• 05/05/2020 - Ironcrunch Sheet Submitted