Skip to content

Commit 944424a

Browse files
committed
Update docs with suggestion for naming of alternate/ruthless trees and data json rename
1 parent 7c44465 commit 944424a

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

RELEASE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,12 @@ The JSON data and required skill tree assets should come in a `.zip` archive.
3737
Steps:
3838
1. Download the `.zip` archive.
3939
2. Create a new directory in `./src/TreeData` with the following schema:
40-
`<major_league_version>_<minor_league_version>`.
40+
`<major_league_version>_<minor_league_version>`. For alternate or ruthless gamemodes, add the suffixing as appropriate.
4141
For 3.14, the correct directory name would be `3_14`.
42+
For 3.25 Ruthless 'alternate' tree, the correct directory name would be `3_25_ruthless_alternate`.
4243
3. Copy the following file from the `.zip` archive root to the new directory:
4344
* `data.json`.
45+
Note for Ruthless for example, the exported data from GGG will be `ruthless.json`, and this file should be copied into the new directory and renamed to `data.json` for the following steps to pick it up.
4446
4. Copy the following files from the `assets` subdirectory in the `.zip` archive to the
4547
new directory:
4648
* `mastery-active-effect-3.png`
@@ -54,7 +56,7 @@ Steps:
5456
according to the file's format. This is important, otherwise the JSON data converter
5557
won't trigger.
5658
7. Restart Path of Building Community. This should result in a new file `tree.lua`.
57-
8. Remove `data.json` and `sprites.json` from the new directory. Do not commit these files.
59+
8. Remove `data.json` and `sprites.json` from the new directories. Do not commit these files.
5860

5961
## Timeless Jewel updates
6062

0 commit comments

Comments
 (0)