Handbook documentation & build flow fixes

This commit is contained in:
KingRainbow44 2023-09-13 21:03:32 -04:00
parent 8db1f597ce
commit 6108a3bb37
No known key found for this signature in database
GPG Key ID: FC2CB64B00D257BE
2 changed files with 30 additions and 0 deletions

View File

@ -386,6 +386,12 @@ tasks.register('generateHandbook') {
return
}
// Install dependencies before building.
exec {
workingDir 'src/handbook'
commandLine npm, 'install'
}
// Build the handbook.
exec {
workingDir 'src/handbook'

View File

@ -1,6 +1,30 @@
# Handbook Data
Use Grasscutter's dumpers to generate the data to put here.
# Generating Data
When you have Grasscutter set up, you can use the following commands to generate the data:
- Commands - `grasscutter.jar -dump=commands,en-us`
- Items - `grasscutter.jar -dump=items,EN`
- Avatars - `grasscutter.jar -dump=avatars,EN`
- Quests - `grasscutter.jar -dump=quests,EN`
- Entities - `grasscutter.jar -dump=entities,en-us`
- Areas - `grasscutter.jar -dump=areas,EN`
- Scenes - `grasscutter.jar -dump=scenes,en-us`
Grasscutter being "set up" means:
- A Java runtime is installed
- Resources are provided in the working directory
## Language Locales
You can replace `en-us` or `EN` using the language locale which matches the format.
| Grasscutter Language Locale | Handbook Language Locale |
|-----------------------------|--------------------------|
| en-us | EN |
## Files Required
- `mainquests.csv'
- `commands.json`