[1.18] 3.1.0 release (#16)

* switch back to zulu for CI

* CI cleanup

* update readme

* add wiki to readme

* bump version

* fix release job dependency in CI

.github/workflows/ci.yml

@@ -12,14 +12,14 @@ on:
       - '1.18'
 
 env:
-  JAVA_DIST: 'temurin'
+  JAVA_DIST: 'zulu'
   JAVA_VERSION: 17
   JAR_NAME: 'energymeter'
   FILE_NAME: 'EnergyMeter'
 
 jobs:
-  check:
-    name: Lint & Build
+  build:
+    name: Build & Analyze
     runs-on: ubuntu-latest
     steps:
       - name: Clone Repository
@@ -58,10 +58,10 @@ jobs:
           chmod +x ./gradlew
           ./gradlew build sonarqube --stacktrace --no-daemon
 
-  publish:
-    name: Publish
+  release:
+    name: Release
     runs-on: ubuntu-latest
-    needs: check
+    needs: build
     if: startsWith(github.ref, 'refs/tags/v1.18-')
     steps:
       - name: Clone Repository
@@ -90,11 +90,10 @@ jobs:
           chmod +x ./gradlew
           ./gradlew jar --no-daemon
 
-      - name: Find the jar
-        run: echo "JAR_FILE=$(find build/libs/${{ env.JAR_NAME }}-*-*.jar)" >> $GITHUB_ENV
-
-      - name: Extract Minecraft and Mod Version
-        run: echo ${JAR_FILE%.*} | awk -F- '{ print "MINECRAFT_VERSION=" $2; print "MOD_VERSION=" $3; }' >> $GITHUB_ENV
+      - name: JAR manipulation
+        run: |
+          echo "JAR_FILE=$(find build/libs/${{ env.JAR_NAME }}-*-*.jar)" >> $GITHUB_ENV
+          echo ${JAR_FILE%.*} | awk -F- '{ print "MINECRAFT_VERSION=" $2; print "MOD_VERSION=" $3; }' >> $GITHUB_ENV
 
       - name: Upload Artifact
         uses: actions/upload-artifact@v2

CHANGELOG.md

@@ -6,12 +6,23 @@ The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
+- /
+
+
+## [3.1.0] - 2022-01-16
 
 ### Added
-- CC: Tweaked integration ([#9])
+- CC: Tweaked integration ([#9], [#14])
+  - for more information, see the [wiki]
+
+### Changed
+- cleanup ([#15])
 
 <!-- Links -->
+[wiki]: https://github.com/AlmostReliable/energymeter-forge/wiki/CC:-Tweaked-Integration
 [#9]: https://github.com/AlmostReliable/energymeter-forge/pull/9
+[#14]: https://github.com/AlmostReliable/energymeter-forge/pull/14
+[#15]: https://github.com/AlmostReliable/energymeter-forge/pull/15
 
 
 ## [3.0.0] - 2021-12-16
@@ -23,5 +34,6 @@ and this project adheres to [Semantic Versioning].
 [semantic versioning]: https://semver.org/spec/v2.0.0.html
 
 <!-- Versions -->
-[unreleased]: https://github.com/AlmostReliable/energymeter-forge/compare/v1.18-3.0.0...HEAD
+[unreleased]: https://github.com/AlmostReliable/energymeter-forge/compare/v1.18-3.1.0...HEAD
+[3.1.0]: https://github.com/AlmostReliable/energymeter-forge/releases/tag/v1.18-3.0.0..v1.18-3.1.0
 [3.0.0]: https://github.com/AlmostReliable/energymeter-forge/releases/tag/v1.18-3.0.0

README.md

@@ -33,39 +33,9 @@ It has a screen always displaying the current rate in order to keep you up-to-da
 3. Drop the **jar file** into your mods folder.
 
 
-## **✋ Usage**
-The usage of the Energy Meter is pretty straightforward.<br>
-Just connect wires, generators, machines or other electrical objects to the Meter and take a look at the energy transfer rate.
-
-The block itself has a GUI where you can look at extended number information, change its mode or adjust the side configuration of the Meter.
-
-
-## **⚙ Functionality**
-The Energy Meter can only have one input but a maximum of 4 outputs.<br>
-All sides can be configured except for the front because that's the reserved face for the screen.
-
-If you have multiple outputs, the Meter will always try to equally split the energy between all of them.<br>
-Additionally, the Meter has two modes:
-
-**Transfer Mode**
-- the default mode
-- will transfer the incoming energy to the defined outputs just like a cable with the benefit of it measuring the rate
-
-**Consumer Mode**
-- will take priority over all outputs
-- dumps all incoming energy (acts like a trashcan)
-- useful if you want to measure all incoming energy without the need to transfer it somewhere
-
-The Energy Meter recalculates the average transfer rate every 5 ticks (0,25 seconds) by default.<br>
-This update interval can be changed by typing the custom amount of ticks in the GUI.
-The change can be applied by pressing `Enter` or by unfocusing the text box.<br>
-A higher interval will result in energy spikes evening out but also fewer updates to the value.
-
-It has an unlimited transfer rate. Therefore, the limitation only comes from the attached objects.<br>
-To prevent having an unlimited cable very early, it is not possible to attach a Meter to another Meter.
-
-There are some mods with pretty unique implementations of cables like Pipez.<br>
-The mod currently has a workaround for that but in case you find other mods which don't work properly with the Meter, please report them!
+## **⚙ More Information**
+For more information about the usage, the functionality and the provided integrations of the mod, please
+visit our [wiki].
 
 
 ## **📕 History**
@@ -102,6 +72,7 @@ This project is licensed under the [MIT license][license].
 [curseforge]: https://www.curseforge.com/minecraft/mc-mods/energymeter
 [forge]: http://files.minecraftforge.net/
 [releases]: https://github.com/AlmostReliable/energymeter-forge/releases
+[wiki]: https://github.com/AlmostReliable/energymeter-forge/wiki
 [Energy Meters]: https://www.curseforge.com/minecraft/mc-mods/energy-meters
 [@vladmarica]: https://github.com/vladmarica
 [changelog]: CHANGELOG.md

gradle.properties

@@ -13,7 +13,7 @@ mappings_version = 1.18.1
 # mod info
 mod_id = energymeter
 mod_name = Energy Meter
-mod_version = 3.0.0
+mod_version = 3.1.0
 mod_base_package = com.github.almostreliable
 mod_authors = AlmostReliable, Relentless
 mod_description = Easily measure your energy rates.