Render Docs and Update Docs (#3782)

Author: jurrejelle

docs/README.md

@@ -26,9 +26,40 @@ Once you're happy, commit these changes and make a pull request for us to review
 If you come back to work on the docs, you can use a codespace again. You might need to `pull` to bring your codespace up to date, which you can do by pressing this button in the `Source Control` tab.
 
 ![image](https://github.com/user-attachments/assets/7d1246d2-f091-4452-bdb3-edf221902503)
-## Installing Required Dependencies
+## Installing Required Dependencies & Run Locally
 
-To install the required dependencies, please run `pip install -r requirements.txt`
+Please run all commands from this section inside the `docs` folder!
+
+**First, setup a venv for python:**
+
+```bash
+python -m venv .venv
+```
+or:
+```bash
+python3 -m venv .venv
+```
+
+**Now activate the venv:**
+
+Windows:
+```cmd
+.venv\Scripts\activate
+```
+Linux / MacOS:
+```bash
+source .venv/bin/activate
+```
+
+**Install the required dependencies:**
+```bash
+pip install -r requirements.txt
+```
+
+**Run locally**:
+```bash
+mkdocs serve
+```
 
 ## MkDocs Plugins
 

docs/content/Modpacks/Changes/v7.0.0.md

@@ -0,0 +1,44 @@
+---
+title: "Version 7.0.0"
+---
+
+
+# Updating from `1.6.4` to `7.0.0`
+
+
+## Models
+
+We have completely reworked our rendering system to be model-based instead of renderer-based.
+
+Previously, you would do
+```javascript
+        .workableCasingRenderer(
+            "gtceu:block/casings/solid/machine_casing_robust_tungstensteel",
+            "gtceu:block/multiblock/primitive_blast_furnace", false
+        );
+```
+
+Now, you should instead use:
+
+```javascript
+        .workableCasingModel(
+            "gtceu:block/casings/solid/machine_casing_robust_tungstensteel",
+            "gtceu:block/multiblock/primitive_blast_furnace"
+        );
+```
+Note: The third argument has been removed and should no longer be used.
+
+
+Previously, you would do
+```javascript
+        .workableTieredHullRenderer("gtceu:block/machines/reconstructor")
+```
+
+Now, you would do
+```javascript
+        .workableTieredHullModel("gtceu:block/machines/reconstructor")
+```
+
+To find an updated list of all the methods for models, look at [MachineBuilder.java](https://github.com/GregTechCEu/GregTech-Modern/blob/1.20.1/src/main/java/com/gregtechceu/gtceu/api/registry/registrate/MachineBuilder.java) for singleblocks, and [MultiblockMachineBuilder.java](https://github.com/GregTechCEu/GregTech-Modern/blob/1.20.1/src/main/java/com/gregtechceu/gtceu/api/registry/registrate/MultiblockMachineBuilder.java) for multiblocks. Most methods have kept a similar name, replacing `renderer` with `model`.
+
+

docs/content/Modpacks/Changes/v7.2.0.md

@@ -0,0 +1,31 @@
+---
+title: "Version 7.2.0"
+---
+
+
+# Updating from `7.1.4` to `7.2.0`
+
+
+## Models
+If you have any block model that 
+ - has overridden base textures when part of a formed structure (fluid hatch coloring for say an EBF), 
+ - doesn't use any of the builtin model methods that set it,
+
+in the MachineDefinition, you need to add `.modelProperty(GTMachineModelProperties.IS_FORMED, false)`
+
+## Ranged inputs/outputs
+In recipes, you can now use:
+- `.itemInputsRanged(..., min, max)`
+- `.itemOutputssRanged(..., min, max)`
+- `.fluidInputsRanged(..., min, max)`
+- `.fluidOutputsRanged(..., min, max)`
+
+Where the inputs or outputs will be rolled inclusively from min to max.
+
+## Rock breaker conditions
+Previously, rock breaker recipes used the `addData("fluidA", ...)` methods.
+
+Now, they work by AdjacentFluidConditions, added with the `adjacentFluid(Fluid...)` methods. See [our other condition builder methods](https://github.com/GregTechCEu/GregTech-Modern/blob/1.20.1/src/main/java/com/gregtechceu/gtceu/integration/kjs/recipe/GTRecipeSchema.java#L894).
+
+## Recipe Conditions
+We have moved away from the .serialize, .deserialize, .toNetwork and .fromNetwork calls on the RecipeCondition, and we now exclusively use the codecs registered in GTRecipeConditions.

docs/content/Modpacks/Examples/Alternator.md

@@ -40,9 +40,9 @@ GTCEuStartupEvents.registry('gtceu:machine', event => {
             .where('E', Predicates.abilities(PartAbility.OUTPUT_ENERGY).setExactLimit(1))
             .build()
         )
-        .workableCasingRenderer(
+        .workableCasingModel(
             "gtceu:block/casings/solid/machine_casing_solid_steel",
-            "gtceu:block/multiblock/implosion_compressor", false
+            "gtceu:block/multiblock/implosion_compressor"
         )
 })
 ```

docs/content/Modpacks/Examples/Greenhouse.md

@@ -61,7 +61,10 @@ GTCEuStartupEvents.registry('gtceu:machine', event => {
             .where('#', Predicates.air())
             .build()
         )
-        .workableCasingRenderer('gtceu:block/casings/solid/machine_casing_solid_steel', 'gtceu:block/multiblock/implosion_compressor', false)
+        .workableCasingModel(
+            "gtceu:block/casings/solid/machine_casing_solid_steel",
+            "gtceu:block/multiblock/implosion_compressor"
+        )
 })
 ```
 

docs/content/Modpacks/Examples/Ore-Processing-Plant.md

@@ -46,8 +46,10 @@ GTCEuStartupEvents.registry('gtceu:machine', event => {
             .where('B', Predicates.blocks('gtceu:bronze_machine_casing'))
             .where(' ', Predicates.any())
             .build())
-        .workableCasingRenderer("gtceu:block/casings/solid/machine_casing_robust_tungstensteel",
-        "gtceu:block/multiblock/primitive_blast_furnace", false);
+        .workableCasingModel(
+            "gtceu:block/casings/solid/machine_casing_robust_tungstensteel",
+            "gtceu:block/multiblock/primitive_blast_furnace"
+        );
     })
 ```
 

docs/content/Modpacks/Other-Topics/Custom-Machines.md

@@ -77,10 +77,9 @@ GTCEuStartupEvents.registry('gtceu:machine', event => {
             .where('C', Predicates.blocks(GTBlocks.CASING_STEEL_SOLID.get())
                 .or(Predicates.autoAbilities(definition.getRecipeTypes())))
         .build())
-        .workableCasingRenderer(
+        .workableCasingModel(
             "gtceu:block/casings/solid/machine_casing_inert_ptfe",
-            "gtceu:block/multiblock/large_chemical_reactor",
-            false
+            "gtceu:block/multiblock/large_chemical_reactor"
         )
 })
 ```
@@ -125,10 +124,9 @@ GTCEuStartupEvents.registry('gtceu:machine', event => {
             .where('i', GTMachines.ITEM_IMPORT_BUS[1], Direction.SOUTH)
             .where('0', GTMachines.ITEM_EXPORT_BUS[1], Direction.SOUTH)
         .build())
-        .workableCasingRenderer(
+        .workableCasingModel(
             "gtceu:block/casings/solid/machine_casing_inert_ptfe",
-            "gtceu:block/multiblock/large_chemical_reactor",
-            false
+            "gtceu:block/multiblock/large_chemical_reactor"
         )
 })
 ```

…er-Topics/Adding-and-Removing-Recipes.md …s/Recipes/Adding-and-Removing-Recipes.mddocs/content/Modpacks/Other-Topics/Adding-and-Removing-Recipes.md renamed to docs/content/Modpacks/Recipes/Adding-and-Removing-Recipes.md docs/content/Modpacks/Other-Topics/Adding-and-Removing-Recipes.md renamed to docs/content/Modpacks/Recipes/Adding-and-Removing-Recipes.md

@@ -114,25 +114,25 @@ ServerEvents.recipes(event => {
       Takes a numerical value representing an EU amount. Positive values will make the recipe consume energy per tick,
       negative ones will make it generate energy per tick.
 - Chanced Ingredients:
-  - Ingredients that are not consumed/produced on every run of a recipe. Can be expressed as either a fraction, or as an
-    integer chance out of 10,000.
-  - Assigning an Input ingredient with a Chance of `0` causes that ingredient to be flagged as `Non-Consumed` in EMI. 
-  This can also be done more easily using `.notConsumable()`.
-  - Recipes with chanced ingredients can also have a Chance Logic designated for each of their input/output sets, using 
-  one or more of the functions `.chancedItemInputLogic()`, `.chancedFluidInputLogic()`, `.chancedTickInputLogic()`,
-  `.chancedItemOutputLogic()`, `.chancedFluidOutputLogic()`, `.chancedTickOutputLogic()`
-  - Valid options for chanced logic are:
-    - `or` - (default) Any item/fluid which succeeds on its chance roll is produced/consumed.
-    - `and` - If _all_ items/fluids succeed on their chance roll, all are produced/consumed together. Otherwise, none are. 
-    - `xor` - Guarantees that exactly one of the chanced items/fluids will be produced/consumed on every run. 
-    Behavior was changed in 7.0.0.
-    - `first` - Makes a chance roll for each item/fluid, in order of registration. Only the first item which succeeds 
-    on its roll is returned. Prior to 7.0.0, this was the behavior of `xor` logic.
+    - Ingredients that are not consumed/produced on every run of a recipe. Can be expressed as either a fraction, or as an
+      integer chance out of 10,000.
+    - Assigning an Input ingredient with a Chance of `0` causes that ingredient to be flagged as `Non-Consumed` in EMI. 
+      This can also be done more easily using `.notConsumable()`.
+    - Recipes with chanced ingredients can also have a Chance Logic designated for each of their input/output sets, using 
+      one or more of the functions `.chancedItemInputLogic()`, `.chancedFluidInputLogic()`, `.chancedTickInputLogic()`,
+      `.chancedItemOutputLogic()`, `.chancedFluidOutputLogic()`, `.chancedTickOutputLogic()`
+    - Valid options for chanced logic are:
+        - `or` - (default) Any item/fluid which succeeds on its chance roll is produced/consumed.
+        - `and` - If _all_ items/fluids succeed on their chance roll, all are produced/consumed together. Otherwise, none are. 
+        - `xor` - Guarantees that exactly one of the chanced items/fluids will be produced/consumed on every run. 
+        Behavior was changed in 7.0.0.
+        - `first` - Makes a chance roll for each item/fluid, in order of registration. Only the first item which succeeds 
+        on its roll is returned. Prior to 7.0.0, this was the behavior of `xor` logic.
 - Ranged Ingredients:
-  - Item or Fluid ingredients that will be consumed or produced in a random amount within a `min, max` range (inclusive).
+    - Item or Fluid ingredients that will be consumed or produced in a random amount within a `min, max` range (inclusive).
 - Circuits
-  - Many GT recipes use a `Programmed Circuit` item with a Configuration value of `1-32` as a `Non-Consumed` input,
-  to distinguish them from other recipes in the same machine with similar ingredients. `.circuit()` adds one to a recipe.
+    - Many GT recipes use a `Programmed Circuit` item with a Configuration value of `1-32` as a `Non-Consumed` input,
+to distinguish them from other recipes in the same machine with similar ingredients. `.circuit()` adds one to a recipe.
 - More granular functionality:
     - `.perTick()`:  
       Using this will enable you to control whether a recipe input/output is consumed/produced per tick the recipe is
@@ -178,17 +178,17 @@ ServerEvents.recipes(event => {
 
 ### Rock breaker fluids
 
-!!! warning
-When adding rock breaker recipes you will need to manually define the fluids the rock breaker will use.
-(might change in the future)
+Rock breaker recipes use AdjacentFluidConditions.
+
+To add a condition, you can use the `adjacentFluid(Fluid...)` methods, see [our other condition builder methods](https://github.com/GregTechCEu/GregTech-Modern/blob/1.20.1/src/main/java/com/gregtechceu/gtceu/integration/kjs/recipe/GTRecipeSchema.java#L894).
 
 ```js title="rock_breaker.js"
 ServerEvents.recipes(event => {
     event.recipes.gtceu.rock_breaker('rhino_jank')
         .notConsumable('minecraft:dirt')
         .itemOutputs('minecraft:dirt')
-        .addDataString("fluidA", "minecraft:lava")
-        .addDataString("fluidB", "minecraft:water")
+        .adjacentFluid('minecraft:water')
+        .adjacentFluid('minecraft:lava')
         .duration(16)
         .EUt(30)
 })