Backport 1.0.2 (the latest 1.18 version) back to 1.16.5

.github/ISSUE_TEMPLATE/api-bug-report.md

@@ -0,0 +1,36 @@
+---
+name: API bug report
+about: Issue about the API (not the buildscript)
+title: "[API]"
+labels: bug
+assignees: KosmX
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Setup config (minecraft, modloader, libraries):**
+ - Minecraft version: [e.g. 1.19.3]
+ - Mod loader: [e.g. Fabric 0.14.11]
+ - PlayerAnimator Library version [e.g. 0.4.0+1.19.3]
+ - MC library version (e.g. Fabric API version)
+
+**Other mods (If you use other mods, please specify! it might be an incompatibility):**
+
+*Optional:*
+** Used library methods, ideas (If you're a developer, what function is not working as expected)**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/buildscript-error.md

@@ -0,0 +1,33 @@
+---
+name: Buildscript error
+about: Something is wrong with buildscript
+title: ''
+labels: build
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Buildscript content or link to content (If you don't share your code, I cannot debug it):**
+https://github.com/KosmX/fabricPlayerAnimatorExample/blob/1.19/build.gradle
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Run `gradle runClient`
+2. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Windows 11, Archlinux, Ubuntu 22.04]
+ - IDE [e.g. IntelliJ, Eclipse, vim+bash]
+ - Gradle version [e.g. 7.5.1]
+ - JDK version [e.g. 17.0.5 - Adoptium]
+ - gradle plugin [e.g. Fabric loom, ForgeGradle] (if I don't see it in your project)
+ - Minecraft, Loader: (Fabric 0.14.11+1.19.2)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/library-crash.md

@@ -0,0 +1,32 @@
+---
+name: Library crash
+about: User crash report
+title: ''
+labels: bug, library
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Crash report (please copy the whole crash report!)**
+```
+Minecraft 1.19.3
+...
+```
+
+**Logs (if you have logs from that run, please share it):**
+```
+...
+```

.github/workflows/publish.yml

@@ -5,13 +5,23 @@ on:
   workflow_dispatch:
     inputs:
       type:
-        description: 'alpha/beta/release'
+        description: 'release type'
         required: false
-        default: 'alpha'
+        type: choice
+        options:
+          - alpha
+          - beta
+          - release
       changelog:
         description: 'changelog'
         required: false
         default: ''
+      upload:
+        required: true
+        type: choice
+        options:
+          - true
+          - false
 
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
@@ -37,8 +47,13 @@ jobs:
           java-version: '17'
 
       # Runs a single command using the runners shell
+      - name: validate gradle wrapper
+        uses: gradle/wrapper-validation-action@v1
+      - name: make gradle wrapper executable
+        if: ${{ runner.os != 'Windows' }}
+        run: chmod +x ./gradlew
       - name: Publish package
-        run: gradle publish --no-daemon
+        run: ./gradlew publish --no-daemon
         env:
           KOSMX_MAVEN_USER: ${{ secrets.MAVEN_USER }}
           KOSMX_MAVEN_TOKEN: ${{ secrets.MAVEN_PASS }}
@@ -47,3 +62,4 @@ jobs:
           CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}
           CHANGELOG: ${{github.event.inputs.changelog}}
           RELEASE_TYPE: ${{github.event.inputs.type}}
+          UPLOAD_TO_PORTAL: ${{github.event.inputs.upload}}

build.gradle

@@ -1,10 +1,11 @@
 plugins {
     id "architectury-plugin" version "3.4-SNAPSHOT"
-    id "dev.architectury.loom" version "1.0.+" apply false
+     id "dev.architectury.loom" version "1.6-SNAPSHOT" apply false
 
     //Publishing
     id 'com.matthewprenger.cursegradle' version '1.4.0' apply false
-    id "com.modrinth.minotaur" version "2.4.3" apply false
+    id "com.modrinth.minotaur" version "2.8.7" apply false
+    id 'com.github.johnrengelman.shadow' version '8.1.1' apply false
 }
 
 architectury {
@@ -60,6 +61,7 @@ ext.ENV = System.getenv()
 ext.cfType = ENV.RELEASE_TYPE ? ENV.RELEASE_TYPE : "alpha"
 ext.changes = ENV.CHANGELOG ? ENV.CHANGELOG.replaceAll("\\\\n", "\n") : ""
 ext.ENV = System.getenv()
+boolean upload = ENV.UPLOAD_TO_PORTAL ? ENV.UPLOAD_TO_PORTAL == "true" : false
 
 ext.keysExists = ENV.KOSMX_MAVEN_USER != null || project.getGradle().getStartParameter().isDryRun()
 
@@ -81,6 +83,8 @@ if(keysExists) {
     }
 
     publish {
-        finalizedBy(':minecraft:publishMod')
+        if (upload) {
+            finalizedBy(':minecraft:publishMod')
+        }
     }
 }

coreLib/build.gradle

@@ -12,11 +12,11 @@ dependencies {
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
 
 
-    compileOnly 'org.projectlombok:lombok:1.18.24'
-    annotationProcessor 'org.projectlombok:lombok:1.18.24'
+    compileOnly 'org.projectlombok:lombok:1.18.26'
+    annotationProcessor 'org.projectlombok:lombok:1.18.26'
 
-    testCompileOnly 'org.projectlombok:lombok:1.18.24'
-    testAnnotationProcessor 'org.projectlombok:lombok:1.18.24'
+    testCompileOnly 'org.projectlombok:lombok:1.18.26'
+    testAnnotationProcessor 'org.projectlombok:lombok:1.18.26'
     compileOnly 'org.jetbrains:annotations:23.0.0'
 }
 

coreLib/src/main/java/dev/kosmx/playerAnim/api/AnimUtils.java

@@ -19,8 +19,9 @@ public static AnimationStack getPlayerAnimLayer(Object player) throws IllegalArg
     }
 
     /**
-     * Disable first person animation see-through.
-     * Has no effect if using mod like FirstPersonModel
+     * Unused, use proper first person library instead
+     * will be removed after next release (1.1)
      */
+    @Deprecated
     public static boolean disableFirstPersonAnim = true;
 }

coreLib/src/main/java/dev/kosmx/playerAnim/api/firstPerson/FirstPersonConfiguration.java

@@ -0,0 +1,17 @@
+package dev.kosmx.playerAnim.api.firstPerson;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.Accessors;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@Accessors(chain = true)
+public class FirstPersonConfiguration {
+    boolean showRightArm = false;
+    boolean showLeftArm = false;
+    boolean showRightItem = true;
+    boolean showLeftItem = true;
+}

coreLib/src/main/java/dev/kosmx/playerAnim/api/firstPerson/FirstPersonMode.java

@@ -0,0 +1,52 @@
+package dev.kosmx.playerAnim.api.firstPerson;
+
+import lombok.Getter;
+import org.jetbrains.annotations.ApiStatus;
+
+public enum FirstPersonMode {
+
+    /**
+     * The animation does not decide first person mode, this way, the animation will be transparent in first person mode.
+     */
+    NONE(false),
+    /**
+     * Use the vanilla renderer, most of the time broken, if you use this, please check your animation
+     */
+    VANILLA(true),
+
+    /**
+     * Use the 3rd person player model (only arms/items) to render accurate first-person perspective
+     */
+    THIRD_PERSON_MODEL(true),
+
+    /**
+     * First person animation is DISABLED, vanilla idle will be active.
+     */
+    DISABLED(false),
+
+;
+    @Getter
+    private final boolean enabled;
+
+
+    FirstPersonMode(boolean enabled) {
+        this.enabled = enabled;
+    }
+
+
+
+    private static final ThreadLocal<Boolean> firstPersonPass = ThreadLocal.withInitial(() -> false);
+
+
+    /**
+     * @return is the current render pass a first person pass
+     */
+    public static boolean isFirstPersonPass() {
+        return firstPersonPass.get();
+    }
+
+    @ApiStatus.Internal
+    public static void setFirstPersonPass(boolean newValue) {
+        firstPersonPass.set(newValue);
+    }
+}

coreLib/src/main/java/dev/kosmx/playerAnim/api/layered/AnimationContainer.java

@@ -1,31 +1,36 @@
 package dev.kosmx.playerAnim.api.layered;
 
 import dev.kosmx.playerAnim.api.TransformType;
+import dev.kosmx.playerAnim.api.firstPerson.FirstPersonConfiguration;
+import dev.kosmx.playerAnim.api.firstPerson.FirstPersonMode;
 import dev.kosmx.playerAnim.core.util.Vec3f;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * A container to make swapping animation object easier
  * It will clone the behaviour of the held animation
- *
+ * <p>
  * you can put endless AnimationContainer into each other
  * @param <T> Nullable animation
  */
 public class AnimationContainer<T extends IAnimation> implements IAnimation {
+    @Nullable
     protected T anim;
 
-    public AnimationContainer(T anim) {
+    public AnimationContainer(@Nullable T anim) {
         this.anim = anim;
     }
 
     public AnimationContainer() {
         this.anim = null;
     }
 
-    public void setAnim(T newAnim) {
+    public void setAnim(@Nullable T newAnim) {
         this.anim = newAnim;
     }
 
-    public T getAnim() {
+    public @Nullable T getAnim() {
         return this.anim;
     }
 
@@ -40,12 +45,23 @@ public void tick() {
     }
 
     @Override
-    public Vec3f get3DTransform(String modelName, TransformType type, float tickDelta, Vec3f value0) {
+    public @NotNull Vec3f get3DTransform(@NotNull String modelName, @NotNull TransformType type, float tickDelta, @NotNull Vec3f value0) {
         return anim == null ? value0 : anim.get3DTransform(modelName, type, tickDelta, value0);
     }
 
     @Override
     public void setupAnim(float tickDelta) {
         if (this.anim != null) this.anim.setupAnim(tickDelta);
     }
+
+    @Override
+    public @NotNull FirstPersonMode getFirstPersonMode(float tickDelta) {
+        return anim != null ? anim.getFirstPersonMode(tickDelta) : FirstPersonMode.NONE;
+    }
+
+    // Override candidate
+    @Override
+    public @NotNull FirstPersonConfiguration getFirstPersonConfiguration(float tickDelta) {
+        return anim != null ? anim.getFirstPersonConfiguration(tickDelta) : IAnimation.super.getFirstPersonConfiguration(tickDelta);
+    }
 }