Skip to content

Commit 044601a

Browse files
authored
update docs for GroovyScript 1.3.2 (#54)
* update docs to 1.3.2 * remove duplicate content * note iingredient is imported * update valid packid * add new reload functionality
1 parent 402dc82 commit 044601a

File tree

502 files changed

+8126
-3630
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

502 files changed

+8126
-3630
lines changed

docs/groovy-script/content/block.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/groovy-script/content/creative_tab.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/groovy-script/content/fluid.md

Lines changed: 0 additions & 82 deletions
This file was deleted.

docs/groovy-script/content/index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/groovy-script/content/item.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

docs/groovy-script/getting_started/groovy_modifications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import groovy.util.*
2323
GroovyScript adds the following additional imports:
2424

2525
```groovy:no-line-numbers
26+
import com.cleanroommc.groovyscript.api.IIngredient
2627
import net.minecraft.world.World
2728
import net.minecraft.block.state.IBlockState
2829
import net.minecraft.block.Block

docs/groovy-script/getting_started/run_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ Let's go through it bit by bit:
4949

5050
The name of the pack.
5151
The pack name can be anything. It's the name that will show up in JEI in tooltips on items you created.
52-
Important for [content](../content/index.md).
52+
Important for [content](../minecraft/helpers/content.md).
5353
- Can be accessed in a script via `getPackName()`.
5454

5555
## `packId`
5656

5757
The id of the pack.
5858
- Can be accessed in a script via `getPackId()`.
5959
The pack id is very important.
60-
It must only consist of lower case letters and `_`.
61-
It is required for most forms of adding recipes and all forms of creating new [content](../content/index.md).
60+
It must only consist of lower case letters, numbers, and `_`.
61+
It is required for most forms of adding recipes and all forms of creating new [content](../minecraft/helpers/content.md).
6262

6363
::: info Failure {id="failure"}
6464
If some mod tries to use the pack id internally and the pack id is not specified a fatal message will logged.

docs/groovy-script/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ GroovyScript can be downloaded on
5353
- Get started with [Getting Started](./getting_started/index.md)
5454
- Read about the basics of the [Groovy](./groovy/index.md) coding language.
5555
- Learn how to interact with [Vanilla Registries](./minecraft/index.md).
56-
- Create your own custom items, blocks, and fluids via the [Content](./content/index.md) compat.
56+
- Create your own custom items, blocks, and fluids via the [Content](./minecraft/helpers/content.md) compat.
5757
- Read the documentation for over 25 [Mods](./mods/index.md)
5858
- Create your own [External Compat](./getting_started/external_compat.md) for GroovyScript!

docs/groovy-script/minecraft/commands/index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,22 @@ The [Language Server](../../getting_started/editors.md) can be started in multip
2222
You can [reload](../../getting_started/reloading.md) the GroovyScript `postInit` files
2323
via this command or via a keybind.
2424

25-
Running `/gs reload --clean` will clean up the [log](../../getting_started/groovy_log.md) file
26-
and remove all prior text.
25+
If [HEI](https://www.curseforge.com/minecraft/mc-mods/had-enough-items) is installed,
26+
reloading will only reload its recipes instead of reloading everything,
27+
which will increase the reload speed.
2728

29+
There are several modifiers that can be applied when reloading:
30+
- `--clean` will clean up the [log](../../getting_started/groovy_log.md) file and remove all prior text.<br>
2831
This can make it more readable and easier to identify errors with the current script instead of seeing
29-
all errors that have been experienced iin this minecraft session.
32+
all errors that have been experienced in this minecraft session.
3033
These errors will still impact the game.
34+
- `--skip-jei` will not try to reload JEI.<br>
35+
This can significantly speed up the reload time.
36+
All scripts will still be run and the recipes will still be changed.
37+
- `--entire-jei` will reload everything in JEI.<br>
38+
This only has an impact if [HEI](https://www.curseforge.com/minecraft/mc-mods/had-enough-items) is installed.
39+
It will make HEI reload everything, not just recipes, when run.
40+
3141

3242
## Clean Log
3343

0 commit comments

Comments
 (0)