Merge branch 'object-Object:main' into main

Author: ChuijkYahus

.github/workflows/ci.yml

@@ -2,37 +2,19 @@ name: Run CI/CD pipeline
 
 on:
   push:
-    branches: "*"
+    branches: ["*"]
   pull_request:
   workflow_dispatch:
 
 permissions:
   contents: read
 
 jobs:
-  setup:
-    runs-on: ubuntu-latest
-    outputs:
-      is-main-branch: |-
-        ${{
-          github.event_name != 'pull_request' && contains(
-            fromJson('["main", "1.19"]'),
-            (github.head_ref || github.ref_name)
-          )
-        }}
-    steps:
-      - name: Print message so the workflow isn't invalid
-        run: 'echo "HexDebug <3 HexBug"'
-
   build-docs:
-    needs: setup
-    uses: hexdoc-dev/actions/.github/workflows/hexdoc.yml@v1
+    uses: ./.github/workflows/docs.yml
     permissions:
       contents: write
       pages: read
-    secrets:
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
-      python-version: 3.11
-      deploy-pages: ${{ needs.setup.outputs.is-main-branch == 'true' }}
+      deploy-pages: ${{ github.event_name != 'pull_request' && contains(fromJson(vars.HEXDOC_BRANCHES), github.ref_name) }}
       release: false

.github/workflows/docs.yml

@@ -0,0 +1,95 @@
+name: "[Reusable] Build and push the web book"
+
+on:
+  workflow_call:
+    inputs:
+      deploy-pages:
+        type: boolean
+        required: true
+      release:
+        type: boolean
+        required: true
+        description: Whether the book should be built in preparation for a release.
+
+jobs:
+  build-hexdoc:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: read
+    outputs:
+      pages-url: ${{ steps.build.outputs.pages-url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version-file: .python-version
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          activate-environment: true
+          enable-cache: true
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+
+      - uses: gradle/actions/setup-gradle@v4
+        with:
+          gradle-home-cache-includes: |
+            caches
+            notifications
+            loom-cache
+
+      - uses: ts-graphviz/setup-graphviz@v2
+
+      - name: Sync dependencies
+        run: uv sync --frozen --no-dev
+
+      - name: Build API docs
+        run: ./gradlew :dokkaGenerate
+
+      - id: build
+        uses: hexdoc-dev/actions/build@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          release: ${{ inputs.release }}
+
+  deploy-pages:
+    needs: build-hexdoc
+    if: inputs.deploy-pages
+    runs-on: ubuntu-latest
+    concurrency:
+      group: hexdoc-deploy-pages
+      cancel-in-progress: false
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version-file: .python-version
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          activate-environment: true
+          enable-cache: true
+
+      - name: Sync dependencies
+        run: uv sync --frozen --no-dev
+
+      - name: Merge new hexdoc build into existing book
+        uses: hexdoc-dev/actions/merge@v1
+        with:
+          release: ${{ inputs.release }}
+          site-url: ${{ needs.build-hexdoc.outputs.pages-url }}
+
+      - name: Deploy to Pages
+        uses: hexdoc-dev/actions/deploy-pages@v1
+        with:
+          merge: false
+          release: ${{ inputs.release }}

.github/workflows/release.yml

@@ -2,13 +2,10 @@ name: Release
 
 on:
   push:
-    tags: 'v[0-9]+.[0-9]+.[0-9]+*'
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
   workflow_dispatch:
     inputs:
-      publish-docs:
-        description: Publish the web book
-        type: boolean
-        default: false
       dry-run:
         description: Perform a dry run
         type: boolean
@@ -22,20 +19,17 @@ permissions:
 
 jobs:
   build-docs:
-    uses: hexdoc-dev/actions/.github/workflows/hexdoc.yml@v1
+    uses: ./.github/workflows/docs.yml
     permissions:
       contents: write
       pages: read
-    secrets:
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     with:
-      python-version: 3.11
-      deploy-pages: ${{ github.event_name == 'push' || inputs.publish-docs && !inputs.dry-run }}
+      deploy-pages: ${{ github.event_name == 'push' || !inputs.dry-run }}
       release: true
 
-  publish-docs:
+  publish-pypi:
     needs: build-docs
-    if: github.event_name == 'push' || inputs.publish-docs && !inputs.dry-run
+    if: github.event_name == 'push' || !inputs.dry-run
     runs-on: ubuntu-latest
     environment:
       name: pypi

.gitignore

@@ -156,9 +156,7 @@ celerybeat.pid
 # Environments
 .env
 .venv
-env/
 venv/
-ENV/
 env.bak/
 venv.bak/
 

.python-version

@@ -0,0 +1 @@
+3.12

CHANGELOG.md

@@ -6,11 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## [UNRELEASED]
 
+### Added
+
+- Added support for debugging spell circles! Right-click (or sneak-right-click, for toolsmiths) on the impetus with a Debugger to start a debug session.
+- New items: Quenched Debugger and Quenched Evaluator! These post-enlightenment debug tools allow up to 4 hexes to be debugged at once. Scroll while holding sneak and sprint in order to switch between the available "debug thread" slots.
+- API: Added API documentation to the web book! The API docs from the latest commit pushed to `main` are available [here](https://hexdebug.hexxy.media/v/latest/main/api/), and there is a link to the API docs for each version in the header of the corresponding web book.
+- API: Added support for implementing debug support in casting devices/environments other than the Debugger item (eg. circles, wisps, cassettes). See the API documentation for more details, especially the sequence diagrams in the `hexdebug-core-common` module.
+- API: Added a new mini-mod called HexDebug Core (`hexdebug-core-*`). This is a minimal, Java-only mod containing only the API classes required to implement debug support. The intention is for HexDebug Core to be included in other addons via Jar-in-Jar, allowing addons to implement optional debugging support in their casting environments while minimizing the amount of overhead and added complexity from checking whether HexDebug is loaded or not.
+- API: Added Mojmap-remapped `common` jars (`hexdebug-common-mojmap` and `hexdebug-core-common-mojmap`) for use in VanillaGradle-based xplat projects.
+
 ### Changed
 
 - Update zh_cn translations, by ChuijkYahus in [#60](https://github.com/object-Object/HexDebug/pull/60).
 - Source files can now be viewed after the hex that created them finishes debugging.
 - Removed the random prefix from source filenames.
+- Active debug sessions are now terminated on death.
+- API: The `SplicingTableIotaRenderer` tooltip is now stored in a field on the renderer, allowing it to be updated in `render` if HexDebug isn't updating it frequently enough for your use case.
 
 ### Fixed
 

Common/Mojmap/build.gradle.kts

@@ -0,0 +1,5 @@
+// this is in its own project because otherwise Gradle gets confused about having multiple remap tasks (?)
+
+plugins {
+    id("hexdebug.conventions.mojmap")
+}

Common/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id("hexdebug.conventions.architectury")
+    id("hexdebug.conventions.dokka")
 }
 
 architectury {
@@ -24,13 +25,13 @@ dependencies {
         annotationProcessor(it)
     }
 
-    api(libs.bundles.lsp4j)
+    implementation(libs.bundles.lsp4j)
 
     implementation(libs.bundles.ktor)
 
     modImplementation(libs.ioticblocks.common)
 
     modCompileOnly(libs.emi.xplat)
 
-    api(project(":Core"))
+    api(project(":hexdebug-core-common", "namedElements"))
 }

Common/dokka.md

@@ -0,0 +1 @@
+# Module hexdebug-common

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaRenderer.java

@@ -10,6 +10,7 @@
 import net.minecraft.network.chat.Component;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public abstract class SplicingTableIotaRenderer {
     @NotNull
@@ -19,6 +20,9 @@ public abstract class SplicingTableIotaRenderer {
     private int x;
     private int y;
 
+    @Nullable
+    private Tooltip tooltip;
+
     public SplicingTableIotaRenderer(
         @NotNull IotaType<?> type,
         @NotNull SplicingTableIotaClientView iota,
@@ -59,6 +63,24 @@ public void setY(int y) {
         this.y = y;
     }
 
+    /**
+     * Returns the cached tooltip for this renderer. This is called every frame, immediately after
+     * {@link SplicingTableIotaRenderer#render}.
+     */
+    @Nullable
+    public Tooltip getTooltip() {
+        return tooltip;
+    }
+
+    /**
+     * Sets the cached tooltip for this renderer. By default, this is called only when the renderer
+     * is moved to a new position, receiving the value returned by
+     * {@link SplicingTableIotaRenderer#createTooltip}.
+     */
+    public void setTooltip(@Nullable Tooltip tooltip) {
+        this.tooltip = tooltip;
+    }
+
     /** Renders one frame of this iota. */
     public abstract void render(@NotNull GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick);
 
@@ -69,7 +91,8 @@ public SplicingTableIotaBackgroundType getBackgroundType() {
     }
 
     /**
-     * Creates and returns a new {@link Tooltip} for the provided iota.
+     * Creates and returns a new {@link Tooltip} for the provided iota. By default, this is called
+     * only when the renderer is moved to a new position.
      * <br>
      * In most cases, you'll likely want to override
      * {@link SplicingTableIotaRenderer#buildTooltip} instead.