Merge branch '1.20.1-v8.0.0' into tar/spoilage

Author: TarLaboratories

.github/workflows/deploy-pages.yml

@@ -2,13 +2,11 @@ name: Publish docs via GitHub Pages
 on:
   workflow_dispatch:
   push:
-    branches: [1.20.1]
+    branches: ["1.20.1", "1.21"]
     paths: ['docs/**']
 
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+  contents: write
 
 concurrency:
   group: 'pages'
@@ -24,33 +22,17 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          ref: '1.20.1'
-          sparse-checkout: './docs'
+          ref: '${{ github.ref_name }}'
+          fetch-depth: 0
       - uses: actions/setup-python@v4
         with:
           python-version: '3.11'
           cache: 'pip'
-      - run: pip install -r ./requirements.txt
-      - uses: actions/cache@v4
-        with:
-          key: 'mkdocs-cache'
-          path: './docs/.cache'
-      - name: Build static files
-        id: mkdocs
-        run: mkdocs build
-      - name: Upload pages as artifact
-        id: artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: './docs/site/'
-
-  deploy:
-    runs-on: ubuntu-latest
-    needs: build
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Deploy Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+      - name: Install packages
+        run: pip install -r ./requirements.txt
+      - name: Set git username and password
+        run: git config user.name 'github-actions[bot]'; git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+      - name: Deploy pages to gh-pages branch
+        run: mike deploy "${{ github.ref_name }}" --push
+      - name: Ensure 1.20.1 is the default version
+        run: mike set-default 1.20.1 --push

CHANGELOG.md

@@ -1,5 +1,64 @@
 # ChangeLog
 
+## Version [v7.4.0](https://github.com/GregTechCEu/GregTech-Modern/compare/v7.3.0-1.20.1...v7.4.0-1.20.1)
+### Added
+
+- Add Bucket/Tank items interaction with coke oven by @Spicierspace153 in [#4190](https://github.com/GregTechCEu/GregTech-Modern/pull/4190)
+- NBT Predicate Ingredient by @jurrejelle in [#4175](https://github.com/GregTechCEu/GregTech-Modern/pull/4175)
+- Add a SpeedBoost When Walking on Concrete by @YoungOnionMC in [#3985](https://github.com/GregTechCEu/GregTech-Modern/pull/3985)
+
+### Fixed
+
+- Change paused steel boiler texture to be consistent with other boilers by @GirixK in [#4196](https://github.com/GregTechCEu/GregTech-Modern/pull/4196)
+- Fix server disconnections and other network errors from causing a crash by @gustovafing in [#4169](https://github.com/GregTechCEu/GregTech-Modern/pull/4169)
+- Implement creating Chanced and Ranged NBTPredicateIngredients by @DilithiumThoride in [#4202](https://github.com/GregTechCEu/GregTech-Modern/pull/4202)
+- Fix machines set to disable after current cycle not disabling on powerstall by @DilithiumThoride in [#4215](https://github.com/GregTechCEu/GregTech-Modern/pull/4215)
+- Balance chemical titanium recipe by @jurrejelle in [#4228](https://github.com/GregTechCEu/GregTech-Modern/pull/4228)
+- Fix Jade showing all singleblock generators as producing at LV by @DilithiumThoride in [#4193](https://github.com/GregTechCEu/GregTech-Modern/pull/4193)
+- Use manual tag checking instead of IsSameItemSameTags by @YoungOnionMC in [#4210](https://github.com/GregTechCEu/GregTech-Modern/pull/4210)
+
+### Changed
+
+- Update zh_cn.json 1.20 by @iouter in [#4226](https://github.com/GregTechCEu/GregTech-Modern/pull/4226)
+- Refactor OR and XOR chance logic rolls to multiply outputs for Guaranteed Rolls rather than adding by @DilithiumThoride in [#4211](https://github.com/GregTechCEu/GregTech-Modern/pull/4211)
+
+ 
+## Version [v7.3.0](https://github.com/GregTechCEu/GregTech-Modern/compare/v7.2.1-1.20.1...v7.3.0-1.20.1)
+### Added
+
+- Re-enable using Screwdriver to toggle Drum auto output, if Allow Input From Output Side is disabled by @DilithiumThoride in [#4163](https://github.com/GregTechCEu/GregTech-Modern/pull/4163)
+- Implement voiding mode by @nutant233 in [#3924](https://github.com/GregTechCEu/GregTech-Modern/pull/3924)
+- Turbine Energy Voiding by @YoungOnionMC in [#4177](https://github.com/GregTechCEu/GregTech-Modern/pull/4177)
+- Max Parallel Setting on place by @YoungOnionMC in [#4186](https://github.com/GregTechCEu/GregTech-Modern/pull/4186)
+- Miner block replacement by @YoungOnionMC in [#4021](https://github.com/GregTechCEu/GregTech-Modern/pull/4021)
+- Change some formulas to make them more accurate by @TarLaboratories in [#4017](https://github.com/GregTechCEu/GregTech-Modern/pull/4017)
+
+### Fixed
+
+- Fix CC integration with the monitor cover by @TarLaboratories in [#4143](https://github.com/GregTechCEu/GregTech-Modern/pull/4143)
+- Add material existing checks before making pipe recipes by @jurrejelle in [#4146](https://github.com/GregTechCEu/GregTech-Modern/pull/4146)
+- Fix toggling Advanced Energy Detector Cover between EU and % modes causing values to decrement by @DilithiumThoride in [#4159](https://github.com/GregTechCEu/GregTech-Modern/pull/4159)
+- Fix Stone Pressure Plate / Button recipe conflict by @DilithiumThoride in [#4131](https://github.com/GregTechCEu/GregTech-Modern/pull/4131)
+- Re-enable using Screwdriver to toggle Drum auto output, if Allow Input From Output Side is disabled by @DilithiumThoride in [#4163](https://github.com/GregTechCEu/GregTech-Modern/pull/4163)
+- Validate KubeJS recipes to ensure no invalid/missing ingredients by @mikerooni in [#4170](https://github.com/GregTechCEu/GregTech-Modern/pull/4170)
+- fix (steam) multiblocks not resetting progress on powerfail by @DilithiumThoride in [#4181](https://github.com/GregTechCEu/GregTech-Modern/pull/4181)
+- Add missing tooltips for auto-output buttons in machine UIs by @mikerooni in [#4180](https://github.com/GregTechCEu/GregTech-Modern/pull/4180)
+- Fix XEI display for recipes with IO and TickIO of the same ingredient type by @DilithiumThoride in [#4137](https://github.com/GregTechCEu/GregTech-Modern/pull/4137)
+- Fix Jade provider displaying no energy for addon steam machines consuming 1mB/t by @DilithiumThoride in [#4127](https://github.com/GregTechCEu/GregTech-Modern/pull/4127)
+- Fix ore veins with only one layer causing crashes by @screret in [#4183](https://github.com/GregTechCEu/GregTech-Modern/pull/4183)
+- Fix Ranged Fluid Ingredients deserializing incorrectly in SMP by @DilithiumThoride in [#4150](https://github.com/GregTechCEu/GregTech-Modern/pull/4150)
+- Swap Diluted HCl to return HCl on Circuit 1 by @DilithiumThoride in [#4125](https://github.com/GregTechCEu/GregTech-Modern/pull/4125)
+- Fix Tool Matching using every Item tag by @YoungOnionMC in [#3945](https://github.com/GregTechCEu/GregTech-Modern/pull/3945)
+- Ore Maceration Changes by @YoungOnionMC in [#4020](https://github.com/GregTechCEu/GregTech-Modern/pull/4020)
+
+### Changed
+
+- update ja_jp by @code-onigiri in [#4099](https://github.com/GregTechCEu/GregTech-Modern/pull/4099)
+- Deprecate ChanceLogic.FIRST by @DilithiumThoride in [#4109](https://github.com/GregTechCEu/GregTech-Modern/pull/4109)
+- Holistic Rebalance to the Large and Small Boiler by @Ghostipedia in [#4075](https://github.com/GregTechCEu/GregTech-Modern/pull/4075)
+- Ore Maceration Changes by @YoungOnionMC in [#4020](https://github.com/GregTechCEu/GregTech-Modern/pull/4020)
+
+ 
 ## Version [v7.2.1](https://github.com/GregTechCEu/GregTech-Modern/compare/v.7.2.0-1.20.1...v7.2.1-1.20.1)
 ### Added
 

docs/README.md

@@ -79,3 +79,8 @@ mkdocs serve
 The following plugins for MkDocs are being used:
 - https://squidfunk.github.io/mkdocs-material/
 - https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
+
+## Deployment
+The hosted documentation is found on the `gh-pages` branch of the repository. [Mike](https://github.com/jimporter/mike) is used to deploy both the 1.20.1 and 1.21.1 documentation on the same site through Github Actions.
+
+When working on the docs locally, the plain `mkdocs` commands should be used to view the changes made to the version of the docs you are currently working on, like the previously mentioned `mkdocs serve`.

docs/content/Development/Data-Sync-System/Annotations.md

@@ -0,0 +1,89 @@
+---
+title: "Annotations"
+---
+
+# Annotations
+The following annotations define the sync/save behaviour for an `ISyncManaged` object.
+
+### `@SaveField`
+
+The `@SaveField` annotation defines a field that should be saved to the server. `nbtKey` is optional, the key will default to the field name.
+```java
+@SaveField(nbtKey="nbtKeyToSaveTo")
+public int mySaveInt = 10;
+```
+
+### `@SyncToClient`
+
+The `@SyncToClient` annotation defines a field with a value that should be synced to clients.
+
+!!! warning 
+    Client sync fields **do not** automatically detect changes. When changing a client sync field, call `ISyncManaged.getSyncDataHolder().markClientSyncFieldDirty(FIELD_NAME)`
+```java
+@SaveField(nbtKey="nbtKeyToSaveTo")
+@SyncToClient
+public int mySaveAndSyncInt = 10;
+
+@SyncToClient
+@RerenderOnChanged
+public long mySyncRerenderLong = 10000L;
+
+public void serverTick() {
+    int newIntValue = getNewIntValue();
+    long newLongValue = getNewLongValue();
+    if (mySaveAndSyncInt != newIntValue) {
+        mySaveAndSyncInt = newIntValue;
+        getSyncDataHolder().markClientSyncFieldDirty("mySaveAndSyncInt");
+    }
+    if (mySyncRerenderLong != newLongValue) {
+        mySyncRerenderLong = newLongValue;
+        getSyncDataHolder().markClientSyncFieldDirty("mySyncRerenderLong");
+    }
+}
+```
+
+### `@ClientFieldChangeListener` and `@RerenderOnChanged`
+
+The `@ClientFieldChangeListener` annotation defines a method to be called on the client when a client sync field has changed value;
+
+Annotating a `@SyncToClient` field with `@RerenderOnChanged` will cause clients to rerender the block entity when this field changes.
+
+```java
+@SyncToClient
+@SaveField
+@RerenderOnChanged
+public boolean isWorkingEnabled = true;
+
+@ClientFieldChangeListener(fieldName="isWorkingEnabled")
+public void isWorkingChanged() {
+    setRenderState(getRenderState().setValue(GTMachineModelProperties.IS_WORKING_ENABLED, isWorkingEnabled));
+}
+```
+
+### `@FieldDataModifier` and `@CustomDataField`
+
+
+
+The `@FieldDataModifier`annotation defines custom processing to be performed on the NBT for a field, e.g. for compatibility reasons.
+
+The `@CustomDataField`annotation defines a field with a type too complex to be serialised using the normal system. Custom data fields must have exactly one load modifier and one data modifier.
+
+Field data modifiers on non-custom fields will be applied *after* standard serialisation/deserialisation, and will be called with an argument containing the current tag.
+
+```java
+@CustomDataField
+@SaveField
+public VeryComplexType myVeryComplexValue = new VeryComplexType();
+
+@FieldDataModifier(fieldName="myVeryComplexValue", target=FieldDataModifier.MODIFY_TARGET.LOAD_NBT)
+public void loadVeryComplexValue(CompoundTag tag) {
+    // Process tag here.
+    myVeryComplexValue = new VeryComplexType();
+}
+
+@FieldDataModifier(fieldName="myVeryComplexValue", target=FieldDataModifier.MODIFY_TARGET.SAVE_NBT)
+public CompoundTag saveVeryComplexValue(CompoundTag tag, boolean isSendingToClient) {
+    // Save data here.
+    return tag;
+}
+```

docs/content/Development/Data-Sync-System/Migrating-From-LDLib-SyncData.md

@@ -0,0 +1,27 @@
+---
+title: "Migrating from LDLib SyncData"
+---
+# Migrating from LDLib SyncData
+
+### General migration guidelines
+
+- Remove all `ManagedFieldHolder` fields.
+- Replace `FieldManagedStorage` fields with `SyncDataHolder` fields.
+- Replace `IEnhancedManaged` objects with `ISyncManaged`.
+- Replace `IAsyncAutoSyncBlockEntity`, `IAutoPersistBlockEntity`, `IAutoSyncBlockEntity` and `IManagedBlockEntity` by extending `ManagedSyncBlockEntity`.
+
+### Annotations
+
+!!! warning
+Client sync fields **do not** automatically detect changes. When changing a client sync field, call `ISyncManaged.syncDataHolder.markClientSyncFieldDirty(FIELD_NAME)`
+
+- `@DescSynced` -> `@SyncToClient`
+- `@RequireRerender` -> `@RerenderOnChanged`
+- `@Persisted` -> `@SaveField`
+- `@UpdateListener` -> `@ClientFieldChangeListener` on listener method.
+- `@DropSaved` - Removed, make machines implement `IDropSaveMachine` instead
+- `@ReadOnlyManaged` and `@LazyManaged` See usage docs for instructions on complex sync objects 
+
+### Other changes
+
+ - `saveCustomPersistedData` & `loadCustomPersistedData` methods: Use `@CustomDataModifier` & `@FieldDataModifier`

docs/content/Development/Data-Sync-System/Usage.md

@@ -0,0 +1,98 @@
+---
+title: "Usage"
+---
+
+## Usage
+
+### Registering classes with the sync system
+
+At the core of the system is the interface `ISyncManaged`, which represents a class that to be synchronised with the client or saved.
+All block entities which should be synchronised or saved must extend the abstract class `ManagedSyncBlockEntity`.
+
+!!! warning 
+  Block entities that inherit `ManagedSyncBlockEntity` must call `ManagedSyncBlockEntity::updateTick`***every tick*** within their ticker, or they will not be saved.
+
+```java
+class MySyncObject implements ISyncManaged {
+    // Any class that directly implements ISyncManaged must have the following:
+     @Getter
+     protected final SyncDataHolder syncDataHolder = new SyncDataHolder(this);
+    
+    
+    /**
+     * Function called when the SyncDataHolder requests a rerender
+     */
+    void scheduleRenderUpdate();
+
+    /**
+     * Function called to notify the server that this object has been updated and must be synced to clients
+     */
+    void markAsChanged();
+}
+```
+
+### Registering fields to be managed by the system
+See [Annotations](Annotations.md)
+
+### Type compatibility
+The following field types are supported by default:
+- Any class implementing `ISyncManaged`
+- Any class implementing `INBTSerializable<Tag>`
+- All primitive types
+- If `T`, `K` are supported types:
+   - `T[]`
+   - `Set<T>`
+   - `List<T>`,
+   - `Map<T, K>`
+- `String`
+- `ItemStack`
+- `FluidStack`
+- `UUID`
+- `BlockPos`
+- `CompoundTag`
+- `GTRecipe`
+- `GTRecipeType`
+- `MachineRenderState`
+- `Material`
+- `Component`
+
+### Adding support for additional types
+
+To add support for an additional type, call `ValueTransformers.registerClassTransformer(Class<?> cls, IValueTransformer<?> transformer)` or `ValueTransformers.registerInterfaceTransformer(Class<?> cls, IValueTransformer<?> transformer)`
+
+The `IValueTransformer<T>` interface defines how a value of type `T` should be serialised.
+
+```java
+public interface IValueTransformer<T> {
+
+    // If this type cannot be instanced purely from a serialised tag.
+    // All complex type typically have mustProvideObject true 
+    default boolean mustProvideObject() {
+        return false;
+    }
+    
+    // A method for serialising a value into a tag
+    // Called when serialising a value to be sent to the client
+    default Tag serializeClientSyncNBT(@Nullable T value, ISyncManaged holder) {
+      return serializeNBT(value, holder);
+    }
+
+    // A method for deserialising a value from a tag
+    // Called when deserialising a value on the client.
+    // If mustProvideObject == true, currentVal is the currently saved value.
+  default T deserializeClientNBT(Tag tag, ISyncManaged holder, @Nullable T currentVal) {
+      return deserializeNBT(tag, holder, currentVal);
+    }
+
+
+  // A method for serialising a value into a tag.
+  // The holder param is the object this sync value is attached to
+  Tag serializeNBT(T value, ISyncManaged holder);
+    
+  // A method for deserialising a value from a tag
+  // If mustProvideObject == true, currentVal is the currently saved value.
+  T deserializeNBT(Tag tag, ISyncManaged holder, @Nullable T currentVal);
+}
+```
+
+Some types may be too complex to be processed using this system. For more complex NBT interactions, use the `@FieldDataModifier` and `@CustomDataField` annotations.

docs/content/Development/Data-Sync-System/index.md

@@ -0,0 +1,12 @@
+---
+title: "Data Sync/Save system "
+---
+
+# Data Sync/Save System
+
+For serialising data to saves and synchronising with clients, a custom data sync system based on Java Annotations is used.
+
+- See [Usage](Usage.md) for a guide on using the system
+- See [Annotations](Annotations.md) for a list of annotations provided by the system
+- See [Migrating From LDLib SyncData](Migrating-From-LDLib-SyncData.md) for instructions on how to migrate from the LDLib SyncData system, which was used in versions 7.x and lower.
+