Merge branch 'main' into a-batch

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,68 @@
+name: Bug Report
+description: Report an issue with Hex Casting
+labels:
+  - bug
+  - unconfirmed
+
+body:
+  - type: dropdown
+    attributes:
+      label: Modloader
+      options:
+        - Forge
+        - Fabric
+        - Quilt
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Minecraft version
+      placeholder: eg. 1.19.2
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Hex Casting version
+      placeholder: eg. 0.11.1-7-pre-609
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Modloader version
+      description: |
+        List the version of the mod loader you are using.
+        If on Fabric, post the versions of both Fabric Loader and Fabric API.
+      placeholder: "eg. Forge: 36.2.9 / Fabric: Loader 0.10.6 + API 0.42.1"
+
+  - type: input
+    attributes:
+      label: Modpack info
+      description: If playing a modpack, post the link to it!
+
+  - type: input
+    attributes:
+      label: The latest.log file
+      description: Please use https://mclo.gs/ if possible. Sites like https://gist.github.com/ or https://pastebin.com/ are also acceptable.
+
+  - type: textarea
+    attributes:
+      label: Issue description
+      placeholder: A description of the issue.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1. First step
+        2. Second step
+        3. etc...
+
+  - type: textarea
+    attributes:
+      label: Other information
+      description: Any other relevant information that is related to this issue, such as other mods and their versions.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,17 @@
+name: Feature Request
+description: Suggest an improvement or a new feature
+labels:
+  - enhancement
+  - unconfirmed
+
+body:
+  - type: textarea
+    attributes:
+      label: Describe the feature
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Any other relevant information (eg. use cases, alternative solutions)

.github/workflows/build_docs.yml

@@ -1,29 +1,60 @@
-name: Build the Python doc-gen
+name: Build the web book
 
 on:
   push:
-    branches: [main]
+    branches: main
+  workflow_dispatch:
+    inputs:
+      release:
+        description: Release this version
+        type: boolean
+        default: false
+      publish:
+        description: Package index to publish to
+        type: choice
+        options:
+          - none
+          - PyPI
+
+env:
+  PYPI_PACKAGE: hexdoc-hexcasting
+
+permissions:
+  contents: read
 
 jobs:
-  build_docs:
-    runs-on: ubuntu-latest
+  hexdoc:
+    uses: hexdoc-dev/hexdoc/.github/workflows/hexdoc.yml@main
     permissions:
       contents: write
+      pages: read
+    secrets:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    with:
+      python-version: "3.11"
+      release: |-
+        ${{
+          github.event_name != 'push' && inputs.release
+          || github.event_name == 'push' && startsWith(github.event.head_commit.message, '[Release]')
+        }}
+
+  publish-pypi:
+    runs-on: ubuntu-latest
+    needs: hexdoc
+    if: |-
+      needs.hexdoc.outputs.release == 'true' &&
+      (github.event_name == 'push' || inputs.publish == 'PyPI')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ env.PYPI_PACKAGE }}
+    permissions:
+      id-token: write
     steps:
-    - uses: actions/checkout@v3
-    - name: Generate file
-      run: doc/collate_data.py Common/src/main/resources hexcasting thehexbook doc/template.html index.html.uncommitted
-    - name: Check out gh-pages
-      uses: actions/checkout@v3
-      with:
-        clean: false
-        ref: gh-pages
-    - name: Overwrite file and commmit
-      run: |
-          mv index.html.uncommitted index.html
-          git config user.name "Documentation Generation Bot"
-          git config user.email "[email protected]"
-          git add index.html
-          git diff-index --quiet HEAD || git commit -m "Update docs at index.html from $GITHUB_REF"
-    - name: Upload changes
-      run: git push
+      - name: Download package artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: hexdoc-build
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pr.yml

@@ -0,0 +1,50 @@
+# mirror of the Jenkins pipeline, used for requiring PRs to build successfully before merging
+# this uses Actions because it's easier to integrate with GitHub PRs, and to allow running the build on forks
+
+name: Build pull request
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "17.0.1"
+      - uses: gradle/actions/setup-gradle@v3
+
+      - name: Clean
+        run: |
+          chmod +x gradlew
+          ./gradlew clean
+
+      - name: Build
+        run: ./gradlew build
+
+      - name: Run Datagen
+        run: ./gradlew runAllDatagen
+
+      - name: Check Datagen
+        run: |
+          git add --intent-to-add .
+          git diff --name-only --exit-code -- ":!:*/src/generated/resources/.cache/*"
+
+  hexdoc:
+    uses: hexdoc-dev/hexdoc/.github/workflows/hexdoc.yml@main
+    permissions:
+      contents: write
+      pages: read
+    secrets:
+      GH_TOKEN: ""
+    with:
+      python-version: "3.11"
+      release: false
+      deploy-pages: false
+      site-url: https://hexcasting.hexxy.media

.gitignore

@@ -1,3 +1,10 @@
+# hexdoc
+doc/**/_export/generated/
+/_site/
+/_checkout/
+__gradle_version__.py
+.hexdoc/
+
 # eclipse
 bin
 *.launch
@@ -22,9 +29,168 @@ eclipse
 run
 .DS_Store
 
+# MacOS moment
+.DS_Store
+
 # Files from Forge MDK
 forge*changelog.txt
 
 Session.vim
 plot/
 
+
+# Python
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/