You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
-
## Pf2e.Tools
2
-
[](https://github.com/Pf2eToolsOrg/Pf2eTools/actions/workflows/main.yml)
1
+
# Pf2e.Tools
2
+
3
+
[](https://github.com/Pf2eToolsOrg/Pf2eTools/actions/workflows/pages/pages-build-deployment)[](https://github.com/Pf2eToolsOrg/Pf2eTools/actions/workflows/main.yml)
3
4
4
5
Visit the main site (not yet) or go to the unofficial GitHub [mirror](https://pf2etools.com).
5
6
@@ -12,40 +13,50 @@ Please see [our Discord server](https://discord.gg/2hzNxErtVu) for FAQs, install
12
13
---
13
14
14
15
## Developer Notes
16
+
15
17
### Data Sources and Versioning
18
+
16
19
Only "official" (that is, published by Paizo) data is to be included in the site. Anything else should be added to the homebrew repository.
17
20
18
21
Prioritise RAW above all else. Aim to provide a 1:1 copy of the original data. Obvious typos (for instance, mathematical errors in creature statblocks) may be corrected at the discretion of the maintainer(s).
19
22
20
23
Aim to use the latest version of any published material. Older versions which are sufficiently different (and relevant to community interests) can be moved to the homebrew repository.
21
24
22
25
### Target JavaScript Version
26
+
23
27
Targeting ES6 was the original intent, but more modern features have long since crept into the code. Therefore, if something is available as standard in both Chrome and Firefox (preferably in versions dating back at least a couple of months), and isn't bleeding-edge, one can reasonable justify using it. As with all things, use common sense.
24
28
25
29
### Style Guidelines
30
+
26
31
#### Code
32
+
27
33
- Use tabs over spaces.
28
34
29
35
#### CSS
36
+
30
37
- The [BEM](http://getbem.com/) ("Block Element Modifier") naming strategy should be used where possible.
31
38
32
39
#### Data/Text
40
+
33
41
- Format JSON to match the default output of JavaScript's `JSON.stringify` (using tabs for indentation), i.e. one line per bracket and one line per value. JSON files programmatically generated from other JSON files (i.e. those stored in `data/generated`) should be minified, however.
34
42
35
43
- When "tagging" references in data (e.g. `{@creature goblin}`), the following rules apply:
36
-
- Only tag references which are _intended as references_. For example, the Wizard class in `You gain one cantrip of your choice from the wizard spell list` should be tagged, whereas the Wizard class in `Together, a group of seven powerful wizards sought to contain the demon` should not be tagged. One is a reference to the mechanical class, one is merely the casual usage of the word "wizard."
37
-
- In a similar vein, never tag anything within a `quote`-type block. Even if the quote directly refers to a specific creature, we can assume the quote is from a universe/perspective in which (for example) statblocks don't exist, and therefore the tag should be omitted to maintain the flavour of the quote.
38
-
- Within data from a source, avoid referencing content from a source printed after the publication of that source.
44
+
- Only tag references which are _intended as references_. For example, the Wizard class in `You gain one cantrip of your choice from the wizard spell list` should be tagged, whereas the Wizard class in `Together, a group of seven powerful wizards sought to contain the demon` should not be tagged. One is a reference to the mechanical class, one is merely the casual usage of the word "wizard."
45
+
- In a similar vein, never tag anything within a `quote`-type block. Even if the quote directly refers to a specific creature, we can assume the quote is from a universe/perspective in which (for example) statblocks don't exist, and therefore the tag should be omitted to maintain the flavour of the quote.
46
+
- Within data from a source, avoid referencing content from a source printed after the publication of that source.
39
47
40
48
### JSON Cleaning
49
+
41
50
#### Trailing commas
51
+
42
52
To remove trailing commas in JSON:
43
53
44
54
Find: `(.*?)(,)(:?\s*]|\s*})`
45
55
46
56
Replace: `$1$3`
47
57
48
58
#### Character replacement
59
+
49
60
-`’` should be replaced with `'`
50
61
-`“` and `”` should be replaced with `"`
51
62
-`—` (em dash) should be replaced with `\u2014` (Unicode for em dash)
@@ -55,24 +66,29 @@ Replace: `$1$3`
55
66
- the only Unicode escape sequences allowed are `\u2014`, `\u2013`, and `\u2212`; all other characters (unless noted above) should be stored as-is
56
67
57
68
#### Convention for dashes
69
+
58
70
-`-` (hyphen) should **only** be used to hyphenate words, e.g. `60-foot` and `18th-level`
59
71
-`\u2014` should be used for parenthetical dash pairs, or for marking empty table rows.
60
72
-`\u2013` should be used for joining numerical ranges, e.g. `1-5` should become `1\u20135`.
61
73
-`\u2212` should be used for unary minus signs, in the case of penalties. For example, `"You have a -5 penalty to..."` should become `"You have a \u22125 penalty to..."`.
62
74
- any whitespace on any side of a `\u2014` should be removed
63
75
64
76
#### Convention for measurement
77
+
65
78
- Adjectives: a hyphen and the full name of the unit of measure should be used, e.g. dragon exhales acid in a `60-foot line`
66
79
- Nouns: a space and the short name of the unit of measure (including the trailing period) should be used, e.g. `blindsight 60 ft.`, `darkvision 120 ft.`
67
80
- Time: a slash, `/`, with no spaces on either side followed by the capitalised unit of time, e.g. `2/Turn`, `3/Day`
68
81
69
82
#### Convention for Dice
83
+
70
84
Dice should be written as `[X]dY[ <+|-|×> Z]`, i.e. with a space between dice and operator, and a space between operator and modifier. Some examples of acceptable formatting are: `d6`, `2d6`, or `2d6 + 1`.
71
85
72
86
#### Convention for Item Names
87
+
73
88
Item names should be title-case, with the exception of units in parentheses, which should be sentence-case. Items who's volume or amount is specified by container (e.g. `(vial)`) treat the container as a unit.
74
89
75
90
### Mouse/Keyboard Events
91
+
76
92
Avoid binding ALT-modified events, as these are not available under MacOS or various Linux flavors. Binding SHIFT-/CTRL-modified events is preferred.
Copy file name to clipboardExpand all lines: data/ancestries/ancestry-poppet.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -213,7 +213,7 @@
213
213
"source": "LOTGB",
214
214
"page": 63,
215
215
"entries": [
216
-
"You have the form of a child's tiny toy or doll, but you don't let your small size impede your joy of life. Instead of {@trait Small}, your size is {@trait Tiny}. Like other {@trait Tiny} creatures, you don't automatically receive lesser cover from being in a larger creature's space, but circumstances might allow you to {@action Take Cover}. You can purchase weapons, armor, and other items for your size with the same statistics as normal gear, except that melee weapons have a reach of 0 for you (or a reach 5 feet shorter than normal if they have the {@trait reach} trait). You can enter another creature's space, which is important because you must usually enter a creature's space to attack it with melee {@action Strike||Strikes}! {@quickref Remember to adjust the Bulk of items and your Bulk limit for Tiny size||1|Items and Sizes}. The information on how to handle {@trait Tiny} PCs, including rules for attempting to ride on other characters, appears on page 66 of the Pathfinder Lost Omens Ancestry Guide."
216
+
"You have the form of a child's tiny toy or doll, but you don't let your small size impede your joy of life. Instead of {@trait Small}, your size is {@trait Tiny}. Like other {@trait Tiny} creatures, you don't automatically receive lesser cover from being in a larger creature's space, but circumstances might allow you to {@action Take Cover}. You can purchase weapons, armor, and other items for your size with the same statistics as normal gear, except that melee weapons have a reach of 0 for you (or a reach <5 feet> shorter than normal if they have the {@trait reach} trait). You can enter another creature's space, which is important because you must usually enter a creature's space to attack it with melee {@action Strike||Strikes}! {@quickref Remember to adjust the Bulk of items and your Bulk limit for Tiny size||1|Items and Sizes}. The information on how to handle {@trait Tiny} PCs, including rules for attempting to ride on other characters, appears on page 66 of the Pathfinder Lost Omens Ancestry Guide."
Copy file name to clipboardExpand all lines: data/ancestries/ancestry-sprite.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -126,7 +126,7 @@
126
126
"page": 128,
127
127
"name": "Tiny PCs",
128
128
"entries": [
129
-
"PCs are typically Small or Medium size, but most sprite PCs are Tiny instead! Being Tiny comes with its own set of rules about space and reach. Your Tiny sprite can enter another creature's space, which is important because your melee {@action Strike||Strikes} typically have no reach, meaning you must enter their space to attack them. Like other Tiny creatures, you don't automatically receive lesser cover from being in a larger creature's space, but circumstances might allow you to {@action Take Cover}. You can purchase weapons, armor, and other items for your size with the same statistics as normal gear, except that melee weapons have a reach of 0 for you (or a reach 5 feet shorter than normal if they have the reach trait). Remember to adjust the {@table Bulk Conversions||Bulk of items and your Bulk limit for Tiny size}."
129
+
"PCs are typically Small or Medium size, but most sprite PCs are Tiny instead! Being Tiny comes with its own set of rules about space and reach. Your Tiny sprite can enter another creature's space, which is important because your melee {@action Strike||Strikes} typically have no reach, meaning you must enter their space to attack them. Like other Tiny creatures, you don't automatically receive lesser cover from being in a larger creature's space, but circumstances might allow you to {@action Take Cover}. You can purchase weapons, armor, and other items for your size with the same statistics as normal gear, except that melee weapons have a reach of 0 for you (or a reach <5 feet> shorter than normal if they have the reach trait). Remember to adjust the {@table Bulk Conversions||Bulk of items and your Bulk limit for Tiny size}."
Copy file name to clipboardExpand all lines: data/archetypes.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@
35
35
"entries": [
36
36
"The flow of time is an unstoppable force. Most are carried downstream inexorably, like a leaf floating on a river. You, however, somehow fell out of the flow of time, if only for an instant, but in doing so gained a perspective that few others have.",
37
37
"Now you stand on the banks of the river, watching the flow, choosing where to dive in, or even defying the current, at least for a short while, as you skim its surface and skip from moment to moment. As a chronoskimmer, time is yours to exploit.",
38
-
"You have the means to see the timelines of all creatures, including your own. You can use this insight to manipulate the flow of time for creatures, much like you can pluck the leaf from the river and place it elsewhere. Manipulating timelines can be dangerous, however, and the Dimension of Time isn't wont to allow these transgressions against time to stand forever. The threat always looms of time dimensionals coming to correct your actions or of you becoming removed from time forever."
38
+
"You have the means to see the timelines of all creatures, including your own. You can use this insight to manipulate the flow of time for creatures, much like you can pluck the leaf from the river and place it elsewhere. Manipulating timelines can be dangerous, however, and the {@place Dimension of Time} won't allow these transgressions against time to stand forever. The threat always looms of time dimensionals coming to correct your actions or of you becoming removed from time forever."
0 commit comments