diff --git a/build.gradle b/build.gradle index 1a7e49639..33a99a066 100644 --- a/build.gradle +++ b/build.gradle @@ -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' diff --git a/src/handbook/data/README.md b/src/handbook/data/README.md index c39e19b8d..a891fcb54 100644 --- a/src/handbook/data/README.md +++ b/src/handbook/data/README.md @@ -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`