commit 6e9663fe496798db7bca8d6e88661b9eced83015
Author: bitsquid_dt <>
Date: Sun May 4 15:10:16 2025 +0200
Initial commit
diff --git a/.ci/Dockerfile b/.ci/Dockerfile
new file mode 100644
index 0000000..40c96c7
--- /dev/null
+++ b/.ci/Dockerfile
@@ -0,0 +1,11 @@
+FROM rust-xwin
+
+RUN set -eux; \
+ apt-get update; \
+ apt-get install --no-install-recommends -y \
+ git \
+ jq \
+ ; \
+ sh -c "git config --global --add safe.directory '*'"; \
+ apt-get remove -y --auto-remove; \
+ rm -rf /var/lib/apt/lists/*;
diff --git a/.ci/pipelines/pr.yml b/.ci/pipelines/pr.yml
new file mode 100644
index 0000000..4deb271
--- /dev/null
+++ b/.ci/pipelines/pr.yml
@@ -0,0 +1,151 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/cappyzawa/concourse-pipeline-jsonschema/master/concourse_jsonschema.json#/definitions/Config
+---
+resource_types:
+- name: gitea-package
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/gitea-package
+ username: ((registry_user))
+ password: ((registry_password))
+
+- name: gitea-status
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/gitea-status
+ username: ((registry_user))
+ password: ((registry_password))
+
+resources:
+- name: repo
+ type: git
+ source:
+ uri: ((forgejo_url))/((owner))/((repo))
+ branch: ((pr.head.ref))
+
+- name: gitea-package
+ type: gitea-package
+ source:
+ access_token: ((forgejo_api_key))
+ url: ((forgejo_url))
+ owner: ((owner))
+ type: generic
+ name: ((repo))
+
+- name: pr-status-lint-clippy
+ type: gitea-status
+ source:
+ access_token: ((forgejo_api_key))
+ url: ((forgejo_url))
+ owner: ((owner))
+ repo: ((repo))
+ context: lint/clippy
+ description: Check for common mistakes and opportunities for code improvement
+
+- name: pr-status-build
+ type: gitea-status
+ source:
+ access_token: ((forgejo_api_key))
+ url: ((forgejo_url))
+ owner: ((owner))
+ repo: ((repo))
+ context: build
+ description: "Build for the target platform"
+
+
+jobs:
+- name: clippy
+ on_success:
+ put: state-success
+ resource: pr-status-lint-clippy
+ no_get: true
+ params:
+ state: success
+ sha: ((.:git_sha))
+
+ on_failure:
+ put: state-failure
+ resource: pr-status-lint-clippy
+ no_get: true
+ params:
+ state: failure
+ sha: ((.:git_sha))
+
+ plan:
+ - get: repo
+ trigger: true
+
+ - load_var: git_sha
+ file: repo/.git/ref
+
+ - put: state-pending
+ resource: pr-status-lint-clippy
+ no_get: true
+ params:
+ state: pending
+ sha: ((.:git_sha))
+
+ - task: check
+ file: repo/.ci/tasks/clippy.yml
+ vars:
+ forgejo_api_key: ((forgejo_api_key))
+ registry_user: ((registry_user))
+ registry_password: ((registry_password))
+
+
+- name: build
+ on_success:
+ put: state-success
+ resource: pr-status-build
+ no_get: true
+ params:
+ state: success
+ sha: ((.:git_sha))
+
+ on_failure:
+ put: state-failure
+ resource: pr-status-build
+ no_get: true
+ params:
+ state: failure
+ sha: ((.:git_sha))
+
+ plan:
+ - get: repo
+ trigger: true
+
+ - load_var: git_sha
+ file: repo/.git/ref
+
+ - put: state-pending
+ resource: pr-status-build
+ no_get: true
+ params:
+ state: pending
+ sha: ((.:git_sha))
+
+ - task: build
+ file: repo/.ci/tasks/build.yml
+ vars:
+ target: msvc
+ pr: ((pr))
+ forgejo_url: ((forgejo_url))
+ forgejo_api_key: ((forgejo_api_key))
+ registry_user: ((registry_user))
+ registry_password: ((registry_password))
+
+ - load_var: version_number
+ reveal: true
+ file: artifact/version
+
+ - put: package
+ resource: gitea-package
+ no_get: true
+ inputs:
+ - artifact
+ params:
+ version: ((.:version_number))
+ fail_fast: true
+ override: true
+ globs:
+ - artifact/*.dll
+ - artifact/*.sha256
diff --git a/.ci/pipelines/set-pr-pipelines.yml b/.ci/pipelines/set-pr-pipelines.yml
new file mode 100644
index 0000000..792faad
--- /dev/null
+++ b/.ci/pipelines/set-pr-pipelines.yml
@@ -0,0 +1,144 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/cappyzawa/concourse-pipeline-jsonschema/master/concourse_jsonschema.json#/definitions/Config
+---
+
+resource_types:
+- name: gitea-package
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/gitea-package
+ username: ((registry_user))
+ password: ((registry_password))
+
+- name: gitea-status
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/gitea-status
+ username: ((registry_user))
+ password: ((registry_password))
+
+- name: gitea-pr
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/gitea-pr
+ username: ((registry_user))
+ password: ((registry_password))
+
+
+resources:
+- name: repo
+ type: git
+ source:
+ uri: ((forgejo_url))/((owner))/((repo))
+ branch: master
+
+- name: repo-pr
+ type: gitea-pr
+ source:
+ access_token: ((forgejo_api_key))
+ owner: ((owner))
+ repo: ((repo))
+ url: ((forgejo_url))
+
+- name: gitea-package
+ type: gitea-package
+ source:
+ access_token: ((forgejo_api_key))
+ url: ((forgejo_url))
+ owner: ((owner))
+ type: generic
+ name: ((repo))
+
+
+- name: status-build
+ type: gitea-status
+ source:
+ access_token: ((forgejo_api_key))
+ url: ((forgejo_url))
+ owner: ((owner))
+ repo: ((repo))
+ context: build
+ description: "Build for the target platform"
+
+jobs:
+- name: set-pipelines
+ plan:
+ - in_parallel:
+ - get: repo-pr
+ trigger: true
+ - get: repo
+
+ - load_var: prs
+ file: repo-pr/prs.json
+
+ - across:
+ - var: pr
+ values: ((.:prs))
+ set_pipeline: ((repo))-pr
+ file: repo/.ci/pipelines/pr.yml
+ vars:
+ pr: ((.:pr))
+ forgejo_api_key: ((forgejo_api_key))
+ forgejo_url: ((forgejo_url))
+ owner: ((owner))
+ repo: ((repo))
+ registry_user: ((registry_user))
+ registry_password: ((registry_password))
+ instance_vars:
+ number: ((.:pr.number))
+
+- name: build
+ on_success:
+ put: state-success
+ resource: status-build
+ no_get: true
+ params:
+ state: success
+ sha: ((.:git_sha))
+
+ on_failure:
+ put: state-failure
+ resource: status-build
+ no_get: true
+ params:
+ state: failure
+ sha: ((.:git_sha))
+
+ plan:
+ - get: repo
+ trigger: true
+
+ - load_var: git_sha
+ file: repo/.git/ref
+
+ - put: state-pending
+ resource: status-build
+ no_get: true
+ params:
+ state: pending
+ sha: ((.:git_sha))
+
+ - task: build
+ file: repo/.ci/tasks/build.yml
+ vars:
+ pr: ""
+ forgejo_url: ((forgejo_url))
+ forgejo_api_key: ((forgejo_api_key))
+ registry_user: ((registry_user))
+ registry_password: ((registry_password))
+
+ - load_var: version_number
+ reveal: true
+ file: artifact/version
+
+ - put: package
+ resource: gitea-package
+ no_get: true
+ inputs:
+ - artifact
+ params:
+ version: ((.:version_number))
+ fail_fast: true
+ override: true
+ globs:
+ - artifact/*.dll
+ - artifact/*.sha256
diff --git a/.ci/tasks/build.sh b/.ci/tasks/build.sh
new file mode 100755
index 0000000..1b95440
--- /dev/null
+++ b/.ci/tasks/build.sh
@@ -0,0 +1,41 @@
+#!/bin/bash
+
+set -eu
+
+if [ -n "$OUTPUT" ]; then
+ OUTPUT=$(realpath "$PWD/../$OUTPUT")
+else
+ OUTPUT=$(mktemp -d)
+fi
+
+title() {
+ printf "\033[1m%s\033[0m\n" "$1"
+}
+
+install_artifact() {
+ for f in "$@"; do
+ echo "Installing: $f"
+ install -v -t "$OUTPUT/" "$f"
+ sha256sum "$f" > "$OUTPUT/$(basename "$f").sha256"
+ done
+}
+
+PR=${PR:-}
+
+if [ -n "$PR" ]; then
+ title "PR: $(echo "$PR" | jq '.number') - $(echo "$PR" | jq '.title')"
+ ref="pr-$(echo "$PR" | jq '.number')-$(git rev-parse --short "$(cat .git/ref || echo "HEAD")" 2>/dev/null || echo 'manual')"
+else
+ ref=$(git describe --tags --always)
+fi
+
+title "Version: '$ref'"
+echo "$ref" > "$OUTPUT/version"
+
+title "Building project"
+cargo build --color always --locked --release --target x86_64-pc-windows-msvc -Zbuild-std
+
+title "Installing artifacts"
+install_artifact target/x86_64-pc-windows-msvc/release/*.dll
+
+title "Done"
diff --git a/.ci/tasks/build.yml b/.ci/tasks/build.yml
new file mode 100644
index 0000000..d0afe6a
--- /dev/null
+++ b/.ci/tasks/build.yml
@@ -0,0 +1,32 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/cappyzawa/concourse-pipeline-jsonschema/master/concourse_jsonschema.json#/definitions/TaskConfig
+---
+platform: linux
+
+image_resource:
+ name: rust-xwin
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/rust-xwin-ci
+ tag: latest
+ username: ((registry_user))
+ password: ((registry_password))
+
+inputs:
+ - name: repo
+
+outputs:
+ - name: artifact
+
+caches:
+ - path: repo/target
+ - path: /usr/local/cargo/registry
+
+params:
+ CI: "true"
+ FORGEJO_API_KEY: ((forgejo_api_key))
+ PR: ((pr))
+ OUTPUT: artifact
+
+run:
+ path: .ci/tasks/build.sh
+ dir: repo
diff --git a/.ci/tasks/clippy.sh b/.ci/tasks/clippy.sh
new file mode 100755
index 0000000..2d0aac7
--- /dev/null
+++ b/.ci/tasks/clippy.sh
@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -eu
+
+title() {
+ printf "\033[1m%s\033[0m\n" "$1"
+}
+
+title "Install clippy"
+rustup component add clippy
+
+title "Run clippy"
+cargo clippy --color always --no-deps --locked
+
+title "Done"
+
diff --git a/.ci/tasks/clippy.yml b/.ci/tasks/clippy.yml
new file mode 100644
index 0000000..690954b
--- /dev/null
+++ b/.ci/tasks/clippy.yml
@@ -0,0 +1,27 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/cappyzawa/concourse-pipeline-jsonschema/master/concourse_jsonschema.json#/definitions/TaskConfig
+---
+platform: linux
+
+image_resource:
+ name: rust-xwin-ci
+ type: registry-image
+ source:
+ repository: registry.sclu1034.dev/rust-xwin-ci
+ tag: latest
+ username: ((registry_user))
+ password: ((registry_password))
+
+inputs:
+- name: repo
+
+caches:
+ - path: repo/target
+ - path: /usr/local/cargo/registry
+
+params:
+ CI: "true"
+ FORGEJO_API_KEY: ((forgejo_api_key))
+
+run:
+ path: .ci/tasks/clippy.sh
+ dir: repo
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..dcb1b49
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+.envrc
+/target
+/msvc
+/tools/xwin
+/.xwin-cache
+/.wineprefix
+/target
diff --git a/.renovaterc b/.renovaterc
new file mode 100644
index 0000000..b36f3b4
--- /dev/null
+++ b/.renovaterc
@@ -0,0 +1,11 @@
+{
+ "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+ "extends": [
+ "config:recommended",
+ ":combinePatchMinorReleases",
+ ":enableVulnerabilityAlerts",
+ ":rebaseStalePrs"
+ ],
+ "prConcurrentLimit": 10,
+ "branchPrefix": "renovate/"
+}
diff --git a/Cargo.lock b/Cargo.lock
new file mode 100644
index 0000000..8ea5eb8
--- /dev/null
+++ b/Cargo.lock
@@ -0,0 +1,287 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "aho-corasick"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "bindgen"
+version = "0.71.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5f58bf3d7db68cfbac37cfc485a8d711e87e064c3d0fe0435b92f7a407f9d6b3"
+dependencies = [
+ "bitflags",
+ "cexpr",
+ "clang-sys",
+ "itertools",
+ "log",
+ "prettyplease",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "rustc-hash",
+ "shlex",
+ "syn",
+]
+
+[[package]]
+name = "bitflags"
+version = "2.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de"
+
+[[package]]
+name = "cexpr"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6fac387a98bb7c37292057cffc56d62ecb629900026402633ae9160df93a8766"
+dependencies = [
+ "nom",
+]
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "clang-sys"
+version = "1.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b023947811758c97c59bf9d1c188fd619ad4718dcaa767947df1cadb14f39f4"
+dependencies = [
+ "glob",
+ "libc",
+ "libloading",
+]
+
+[[package]]
+name = "dt-plugin-template"
+version = "0.1.0"
+dependencies = [
+ "bindgen",
+ "libc",
+]
+
+[[package]]
+name = "either"
+version = "1.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0"
+
+[[package]]
+name = "glob"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"
+
+[[package]]
+name = "itertools"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ba291022dbbd398a455acf126c1e341954079855bc60dfdda641363bd6922569"
+dependencies = [
+ "either",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.172"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d750af042f7ef4f724306de029d18836c26c1765a54a6a3f094cbd23a7267ffa"
+
+[[package]]
+name = "libloading"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4979f22fdb869068da03c9f7528f8297c6fd2606bc3a4affe42e6a823fdb8da4"
+dependencies = [
+ "cfg-if",
+ "windows-targets",
+]
+
+[[package]]
+name = "log"
+version = "0.4.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
+
+[[package]]
+name = "memchr"
+version = "2.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
+
+[[package]]
+name = "minimal-lexical"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
+
+[[package]]
+name = "nom"
+version = "7.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d273983c5a657a70a3e8f2a01329822f3b8c8172b73826411a55751e404a0a4a"
+dependencies = [
+ "memchr",
+ "minimal-lexical",
+]
+
+[[package]]
+name = "prettyplease"
+version = "0.2.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5f12335488a2f3b0a83b14edad48dca9879ce89b2edd10e80237e4e852dd645e"
+dependencies = [
+ "proc-macro2",
+ "syn",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.86"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.36"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "regex"
+version = "1.10.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4219d74c6b67a3654a9fbebc4b419e22126d13d2f3c4a07ee0cb61ff79a79619"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "38caf58cc5ef2fed281f89292ef23f6365465ed9a41b7a7754eb4e26496c92df"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b"
+
+[[package]]
+name = "rustc-hash"
+version = "2.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c7fb8039b3032c191086b10f11f319a6e99e1e82889c5cc6046f515c9db1d497"
+
+[[package]]
+name = "shlex"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
+
+[[package]]
+name = "syn"
+version = "2.0.72"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc4b9b9bf2add8093d3f2c0204471e951b2285580335de42f9d2534f3ae7a8af"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
+
+[[package]]
+name = "windows-targets"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
+dependencies = [
+ "windows_aarch64_gnullvm",
+ "windows_aarch64_msvc",
+ "windows_i686_gnu",
+ "windows_i686_gnullvm",
+ "windows_i686_msvc",
+ "windows_x86_64_gnu",
+ "windows_x86_64_gnullvm",
+ "windows_x86_64_msvc",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
+
+[[package]]
+name = "windows_i686_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..36d3a21
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,25 @@
+[package]
+name = "dt-plugin-template"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+libc = "0.2.144"
+
+[build-dependencies]
+bindgen = "0.71.0"
+
+[lib]
+crate-type = ["cdylib", "lib"]
+
+[profile.release]
+strip = "debuginfo"
+
+# The MSVC toolchain cannot handle LTO properly. Some symbol related to
+# panic unwind would always be missing.
+# So we use a separate profile for when we can compile with LTO.
+[profile.release-lto]
+inherits = "release"
+lto = true
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..1a5a968
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,111 @@
+# https://jake-shadle.github.io/xwin/
+FROM debian:bullseye-slim AS xwin
+
+ARG XWIN_VERSION=0.5.2
+ARG XWIN_PREFIX="xwin-$XWIN_VERSION-x86_64-unknown-linux-musl"
+ADD https://github.com/Jake-Shadle/xwin/releases/download/$XWIN_VERSION/$XWIN_PREFIX.tar.gz /root/$XWIN_PREFIX.tar.gz
+
+RUN set -eux; \
+ # Install xwin to cargo/bin via github release. Note you could also just use `cargo install xwin`.
+ tar -xzv -f /root/$XWIN_PREFIX.tar.gz -C /usr/bin --strip-components=1 $XWIN_PREFIX/xwin; \
+ rm -f /root/$XWIN_PREFIX.tar.gz;
+
+RUN set -eux; \
+ # Splat the CRT and SDK files to /xwin/crt and /xwin/sdk respectively
+ xwin \
+ --log-level debug \
+ --cache-dir /root/.xwin-cache \
+ --manifest-version 16 \
+ --accept-license \
+ splat \
+ --output /xwin; \
+ # Even though this build step only exists temporary to copy the
+ # final data out of, it still generates a cache entry on the Docker host.
+ # And to keep that to a minimum, we still delete the stuff we don't need.
+ rm -rf /root/.xwin-cache;
+
+FROM rust:slim-bullseye AS final
+
+ARG LLVM_VERSION=18
+ENV KEYRINGS=/usr/local/share/keyrings
+
+ADD https://apt.llvm.org/llvm-snapshot.gpg.key /root/llvm-snapshot.gpg.key
+ADD https://dl.winehq.org/wine-builds/winehq.key /root/winehq.key
+
+RUN set -eux; \
+ apt-get update; \
+ apt-get install -y --no-install-recommends \
+ ca-certificates \
+ gpg \
+ ; \
+ mkdir -p $KEYRINGS; \
+ gpg --dearmor > $KEYRINGS/llvm.gpg < /root/llvm-snapshot.gpg.key; \
+ gpg --dearmor > $KEYRINGS/winehq.gpg < /root/winehq.key; \
+ echo "deb [signed-by=$KEYRINGS/llvm.gpg] http://apt.llvm.org/bullseye/ llvm-toolchain-bullseye-${LLVM_VERSION} main" > /etc/apt/sources.list.d/llvm.list; \
+ echo "deb [signed-by=$KEYRINGS/winehq.gpg] https://dl.winehq.org/wine-builds/debian/ bullseye main" > /etc/apt/sources.list.d/winehq.list; \
+ dpkg --add-architecture i386; \
+ apt-get update; \
+ apt-get install --no-install-recommends --no-install-suggests -y \
+ libclang-${LLVM_VERSION}-dev \
+ gcc-mingw-w64-x86-64 \
+ clang-${LLVM_VERSION} \
+ llvm-${LLVM_VERSION} \
+ lld-${LLVM_VERSION} \
+ winehq-staging \
+ ; \
+ # ensure that clang/clang++ are callable directly
+ ln -s clang-${LLVM_VERSION} /usr/bin/clang && ln -s clang /usr/bin/clang++ && ln -s lld-${LLVM_VERSION} /usr/bin/ld.lld; \
+ # We also need to setup symlinks ourselves for the MSVC shims because they aren't in the debian packages
+ ln -s clang-${LLVM_VERSION} /usr/bin/clang-cl && ln -s llvm-ar-${LLVM_VERSION} /usr/bin/llvm-lib && ln -s lld-link-${LLVM_VERSION} /usr/bin/lld-link; \
+ # Verify the symlinks are correct
+ clang++ -v; \
+ ld.lld -v; \
+ # Doesn't have an actual -v/--version flag, but it still exits with 0
+ llvm-lib -v; \
+ clang-cl -v; \
+ lld-link --version; \
+ # Use clang instead of gcc when compiling and linking binaries targeting the host (eg proc macros, build files)
+ update-alternatives --install /usr/bin/cc cc /usr/bin/clang 100; \
+ update-alternatives --install /usr/bin/c++ c++ /usr/bin/clang++ 100; \
+ update-alternatives --install /usr/bin/ld ld /usr/bin/ld.lld 100; \
+ rustup target add x86_64-pc-windows-msvc; \
+ rustup default stable-x86_64-pc-windows-msvc; \
+ rustup component add rust-src; \
+ rustup update; \
+ apt-get remove -y --auto-remove \
+ gpg \
+ ; \
+ rm -rf \
+ /var/lib/apt/lists/* \
+ /root/*.key;
+
+COPY --from=xwin /xwin /xwin
+
+# Note that we're using the full target triple for each variable instead of the
+# simple CC/CXX/AR shorthands to avoid issues when compiling any C/C++ code for
+# build dependencies that need to compile and execute in the host environment
+ENV CC_x86_64_pc_windows_msvc="clang-cl" \
+ CXX_x86_64_pc_windows_msvc="clang-cl" \
+ AR_x86_64_pc_windows_msvc="llvm-lib" \
+ # wine can be quite spammy with log messages and they're generally uninteresting
+ WINEDEBUG="-all" \
+ # Use wine to run test executables
+ CARGO_TARGET_X86_64_PC_WINDOWS_MSVC_RUNNER="wine" \
+ # Note that we only disable unused-command-line-argument here since clang-cl
+ # doesn't implement all of the options supported by cl, but the ones it doesn't
+ # are _generally_ not interesting.
+ CL_FLAGS="-Wno-unused-command-line-argument -fuse-ld=lld-link /imsvc/xwin/crt/include /imsvc/xwin/sdk/include/ucrt /imsvc/xwin/sdk/include/um /imsvc/xwin/sdk/include/shared" \
+ # Let cargo know what linker to invoke if you haven't already specified it
+ # in a .cargo/config.toml file
+ CARGO_TARGET_X86_64_PC_WINDOWS_MSVC_LINKER="lld-link" \
+ CARGO_TARGET_X86_64_PC_WINDOWS_MSVC_RUSTFLAGS="-Lnative=/xwin/crt/lib/x86_64 -Lnative=/xwin/sdk/lib/um/x86_64 -Lnative=/xwin/sdk/lib/ucrt/x86_64"
+
+# These are separate since docker/podman won't transform environment variables defined in the same ENV block
+ENV CFLAGS_x86_64_pc_windows_msvc="$CL_FLAGS" \
+ CXXFLAGS_x86_64_pc_windows_msvc="$CL_FLAGS"
+
+WORKDIR /src/plugin
+
+# Run wineboot just to setup the default WINEPREFIX so we don't do it every
+# container run
+RUN wine wineboot --init
diff --git a/Justfile b/Justfile
new file mode 100644
index 0000000..4825633
--- /dev/null
+++ b/Justfile
@@ -0,0 +1,24 @@
+fly_target := "main"
+
+image:
+ docker build -t dt-plugin-builder .
+
+build:
+ docker run \
+ --rm \
+ -t \
+ --user "$(id -u):$(id -g)" \
+ -v ./:/src/plugin \
+ dt-plugin-builder \
+ cargo build -Zbuild-std --target x86_64-pc-windows-msvc
+
+set-base-pipeline:
+ fly -t {{fly_target}} set-pipeline \
+ --pipeline dt-plugin-template-pr \
+ --config .ci/pipelines/set-pr-pipelines.yml \
+ -v forgejo_url=https://git.sclu1034.dev \
+ -v forgejo_api_key=${FORGEJO_API_KEY} \
+ -v registry_user=${REGISTRY_USER} \
+ -v registry_password=${REGISTRY_PASSWORD} \
+ -v owner=bitsquid_dt \
+ -v repo=dt-plugin-template
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c154efd
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,676 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
+
+
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..e1ff448
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,89 @@
+= Darktide Plugin Template
+:idprefix:
+:idseparator:
+:toc: macro
+:toclevels: 1
+:!toc-title:
+:caution-caption: :fire:
+:important-caption: :exclamtion:
+:note-caption: :paperclip:
+:tip-caption: :bulb:
+:warning-caption: :warning:
+
+A template for building an engine plugin for Warhammer 40,000 Darktide.
+
+== Getting started
+
+In `src/lib.rs`, change `PLUGIN_NAME` and `MODULE_NAME` to unique values matching your plugin.
+Then head to `src/plugin.rs`, where `Plugin.setup_game`, `Plugin.update_game` and
+`Plugin.shutdown_game` are your entry points that the engine will call. Start your plugin
+implementation here.
+
+`src/stingray_sdk.rs` provides mappings for the engine's API. A few functions are already
+implemented to serve as an example. You can implement more based on what you need (see
+`LuaApi` in `src/plugin_api.h` for what's available).
+If you do implement more mappings, please contribute them upstream to this template, so that
+others can benefit from them as well.
+
+Your primary interface with the game's Lua code should be `LuaApi.add_module_function`. This creates
+functions callable from Lua, such as `DTPluginTemplate.do_something` in `src/plugin.rs`.
+
+=== Things to keep in mind
+
+* Printing in Rust code will not show up in the game's log. You must use `plugin.log` (`LoggingApi`).
+* Panics in Rust will lead to a game crash. Using `Result` is good hygiene anyways.
+
+=== Advanced
+
+`PluginApi` contains more functions than just the three currently mapped in `Plugin`.
+If you need any of those, you will have to implement their mapping both in `Plugin` and in
+`src/lib.rs` like to the existing ones.
+
+The engine also provides additional API structs beyond `LoggingApi` and `LuaApi`. A full list can be
+found at https://github.com/AutodeskGames/stingray-plugin/blob/master/stingray_sdk/engine_plugin_api/plugin_api.h[AutodeskGames/stingray-plugin].
+You will need to copy the definitions from there to `src/plugin_api.h`. They will likely also need
+adjustments, as Darktide's engine has long since diverted from Autodesk's version.
+
+== Building
+
+> Only cross-compiling on a Linux build machine has been tested so far.
+> Native build on Windows likely only need the basic setup for Rust, though.
+
+The engine requires DLLs to have a name suffix of `_pluginw64_release.dll`. The rest before that
+can be an arbitrary file name. The DLL then needs to be copied to `binaries/plugins` in the game's
+installation directory.
+
+=== Docker
+
+The easiest way is using the provided `Dockerfile`. While it does run a Linux image, it sets up
+everything needed for compiling Windows DLLs, so it will work the same regardless of the host OS.
+
+[source,shell]
+----
+docker build -t my-project .
+docker run --rm -t -v ./:/src/plugin my-project cargo build --release
+----
+
+(substitute `my-project` for a fitting name)
+
+This `Dockerfile` should be suitable for CI as well.
+
+=== Manual (Linux)
+
+==== Prerequisites
+
+* A reasonably recent version of LLVM, lld & Clang
+** A symlink `clang-cl` -> `clang` in `PATH`
+* cURL
+* Wine
+* Rust toolchain, MSVC target and `rust-src`:
+** `rustup target add x86_64-pc-windows-msvc`
+** `rustup component add rust-src`
+
+==== Build
+
+Set up https://github.com/Jake-Shadle/xwin[Jake-Shadle/xwin]. That repository contains a Docker file
+that can serve as an example. So does the `Dockerfile` here.
+
+This includes the setup of Wine and the environmental variables to have Cargo use the Windows
+libraries and tools through Wine.
diff --git a/build.rs b/build.rs
new file mode 100644
index 0000000..b39dc97
--- /dev/null
+++ b/build.rs
@@ -0,0 +1,28 @@
+extern crate bindgen;
+
+use std::env;
+use std::path::PathBuf;
+
+const HEADER_NAME: &str = "src/plugin_api.h";
+
+fn main() {
+ println!("cargo:rerun-if-changed={}", HEADER_NAME);
+
+ let bindings = bindgen::Builder::default()
+ .header(HEADER_NAME)
+ .rustified_enum("PluginApiID")
+ .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
+ .generate()
+ .expect("Unable to generate bindings");
+
+ let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+ bindings
+ .write_to_file(out_path.join("bindings.rs"))
+ .expect("Couldn't write bindings!");
+
+ if cfg!(debug_assertions) {
+ bindings
+ .write_to_file(out_path.join("../../../bindings.rs"))
+ .expect("Couldn't write bindings to debug path");
+ }
+}
diff --git a/rust-toolchain.toml b/rust-toolchain.toml
new file mode 100644
index 0000000..e2057cd
--- /dev/null
+++ b/rust-toolchain.toml
@@ -0,0 +1,5 @@
+[toolchain]
+channel = "nightly"
+components = ["rust-src"]
+targets = ["x86_64-pc-windows-msvc"]
+
diff --git a/rustfmt.toml b/rustfmt.toml
new file mode 100644
index 0000000..c5b51b0
--- /dev/null
+++ b/rustfmt.toml
@@ -0,0 +1,21 @@
+# Copyright (C) 2024 Lucas Schwiderski
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+unstable_features = true
+hard_tabs = false
+max_width = 100
+edition = "2021"
+use_field_init_shorthand = true
+
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..9cdc2b7
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,65 @@
+use std::ffi::{c_char, CString};
+use std::sync::OnceLock;
+
+mod plugin;
+mod stingray_sdk;
+
+use plugin::Plugin;
+use stingray_sdk::{GetApiFunction, PluginApi, PluginApiID};
+
+// TODO: Change these
+/// The name that the plugin is registered to the engine as.
+/// Must be unique across all plugins.
+pub const PLUGIN_NAME: &str = "dt-plugin-template";
+/// The module that Lua functions are assigned to.
+pub const MODULE_NAME: &str = "DTPluginTemplate";
+
+static PLUGIN: OnceLock = OnceLock::new();
+
+#[no_mangle]
+pub extern "C" fn get_name() -> *const c_char {
+ let s = CString::new(PLUGIN_NAME).expect("Failed to create CString from plugin name");
+ s.as_ptr()
+}
+
+#[no_mangle]
+pub extern "C" fn setup_game(get_engine_api: GetApiFunction) {
+ let plugin = Plugin::new(get_engine_api);
+ plugin.setup_game();
+ PLUGIN
+ .set(plugin)
+ .expect("Failed to initalize global plugin object.");
+}
+
+#[no_mangle]
+pub extern "C" fn shutdown_game() {
+ // Safety: The engine ensures that `setup_game` was called before this, so `PLUGIN` has been
+ // initialized.
+ let plugin = unsafe { PLUGIN.get().unwrap_unchecked() };
+ plugin.shutdown_game();
+}
+
+#[no_mangle]
+pub extern "C" fn update_game(dt: f32) {
+ // Safety: The engine ensures that `setup_game` was called before this, so `PLUGIN` has been
+ // initialized.
+ let plugin = unsafe { PLUGIN.get().unwrap_unchecked() };
+ plugin.update_game(dt);
+}
+
+#[no_mangle]
+pub extern "C" fn get_plugin_api(id: PluginApiID) -> *mut PluginApi {
+ if id == PluginApiID::PLUGIN_API_ID {
+ let api = PluginApi {
+ get_name: Some(get_name),
+ setup_game: Some(setup_game),
+ update_game: Some(update_game),
+ shutdown_game: Some(shutdown_game),
+ ..Default::default()
+ };
+
+ Box::into_raw(Box::new(api))
+ } else {
+ std::ptr::null_mut()
+ }
+}
diff --git a/src/plugin.rs b/src/plugin.rs
new file mode 100644
index 0000000..ec861eb
--- /dev/null
+++ b/src/plugin.rs
@@ -0,0 +1,54 @@
+use crate::stingray_sdk::{lua_State, GetApiFunction, LoggingApi, LuaApi};
+use crate::{MODULE_NAME, PLUGIN, PLUGIN_NAME};
+
+pub(crate) struct Plugin {
+ pub log: LoggingApi,
+ pub lua: LuaApi,
+}
+
+extern "C" fn do_something(l: *mut lua_State) -> i32 {
+ // Safety: Plugin must have been initialized for this to be registered as module
+ // function.
+ let plugin = unsafe { PLUGIN.get().unwrap_unchecked() };
+
+ if let Some(name) = plugin.lua.tolstring(l, 1) {
+ plugin.lua.pushstring(
+ l,
+ format!("[do_something] Hello from Rust, {}", name.to_string_lossy()),
+ );
+ 1
+ } else {
+ 0
+ }
+}
+
+impl Plugin {
+ pub fn new(get_engine_api: GetApiFunction) -> Self {
+ let log = LoggingApi::get(get_engine_api);
+ let lua = LuaApi::get(get_engine_api);
+ Self { log, lua }
+ }
+
+ pub fn setup_game(&self) {
+ self.log.info(
+ PLUGIN_NAME,
+ format!("[setup_game] Hello, world! This is {}!", PLUGIN_NAME),
+ );
+
+ self.lua
+ .add_module_function(MODULE_NAME, "do_something", do_something);
+ }
+
+ pub fn shutdown_game(&self) {
+ self.log
+ .info(PLUGIN_NAME, "[shutdown_game] Goodbye, world!");
+ }
+
+ pub fn update_game(&self, _dt: f32) {}
+}
+
+impl std::fmt::Debug for Plugin {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ f.write_str("PluginApi")
+ }
+}
diff --git a/src/plugin_api.h b/src/plugin_api.h
new file mode 100644
index 0000000..fe29b8c
--- /dev/null
+++ b/src/plugin_api.h
@@ -0,0 +1,443 @@
+#pragma once
+// This is manually updated and minified PluginApi based on the publicly
+// available sources at: https://github.com/AutodeskGames/stingray-plugin
+// From
+// https://github.com/thewhitegoatcb/rawray/blob/master/rawray/PluginApi128.h
+
+#define PLUGIN_DLLEXPORT __declspec(dllexport)
+
+#include
+#include
+#include
+
+typedef struct CApiUnit CApiUnit;
+typedef struct CApiWorld CApiWorld;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* API IDs for the different services. */
+enum PluginApiID {
+ PLUGIN_API_ID = 0,
+ LUA_API_ID = 1,
+ DATA_COMPILER_API_ID = 2,
+ DATA_COMPILE_PARAMETERS_API_ID = 3,
+ ALLOCATOR_API_ID = 4,
+ RESOURCE_MANAGER_API_ID = 5,
+ LOGGING_API_ID = 6,
+ UNIT_API_ID = 8,
+ SCENE_GRAPH_API_ID = 9,
+ FUTURE_INPUT_ARCHIVE_API_ID = 10,
+ INPUT_ARCHIVE_API_ID = 11,
+ APPLICATION_API_ID = 12,
+ APPLICATION_OPTIONS_API_ID = 13,
+ UNIT_REFERENCE_API_ID = 14,
+ ERROR_CONTEXT_API_ID = 15,
+ RENDER_INTERFACE_API_ID = 16,
+ RAYCAST_API_ID = 17,
+ RENDER_CALLBACKS_PLUGIN_API_ID = 18,
+ RENDER_OVERRIDES_PLUGIN_API_ID = 19,
+ FILESYSTEM_API_ID = 20,
+ PLUGIN_MANAGER_API_ID = 21,
+ WORLD_API_ID = 22,
+ LINE_OBJECT_DRAWER_API_ID = 23,
+ PROFILER_API_ID = 24,
+ ERROR_API_ID = 25,
+ RENDER_BUFFER_API_ID = 26,
+ MESH_API_ID = 27,
+ INPUT_BUFFER_API_ID = 28,
+ RENDER_SCENE_GRAPH_API_ID = 29,
+ SOUND_STREAM_SOURCE_API_ID = 30,
+ C_API_ID = 31,
+ THREAD_API_ID = 32,
+ TIMER_API_ID = 33,
+ MATERIAL_API_ID = 34,
+ SCENE_DATABASE_API_ID = 35,
+ STREAM_CAPTURE_API_ID = 36,
+ FLOW_NODES_API_ID = 37,
+ CAMERA_API_ID = 38,
+ END_OF_ENGINE_RESERVED_RANGE = 65535,
+
+ /* API IDs in the range 0--65535 are reserved by the engine. If you want to
+ provide your own API in your plugin, we suggest using a hash of the API's
+ name as ID. */
+};
+
+/* This function can be used by the plugin to query for engine APIs. */
+typedef void *(*GetApiFunction)(unsigned api);
+
+struct PluginApi {
+#ifdef __cplusplus
+ uint32_t version = 65;
+ uint32_t flags = 3; // lua plugin
+#else
+ uint32_t version;
+ uint32_t flags;
+#endif
+
+ /* Called to initialize the plugin once it has been loaded into memory. For
+ plugins loaded at boot, this function is called once all plugins have been
+ loaded (so you can query for other plugins in this function). For plugins
+ loaded on demand, this function is called as soon as the plugin have been
+ loaded. */
+ void (*loaded)(GetApiFunction get_engine_api);
+
+ /* Called at the start of a "hot reload" of the plugin DLL. Should return a
+ pointer to a serialized "state" for the plugin.*/
+ void *(*start_reload)(GetApiFunction get_engine_api);
+
+ /* Called just before the plugin is unloaded. */
+ void (*unloaded)();
+
+ /* Called to finalized the "hot reload" after the plugin has been reloaded
+ with the new code. Should restore the state from the serialized state data.
+ Note that it is the responsibility of the plugin to free the state data. */
+ void (*finish_reload)(GetApiFunction get_engine_api, void *state);
+
+ /* Called when the engine sets up the ResourceManager. At this point you can
+ use the ResourceManagerApi to add support for resource manager loading of
+ your custom data types. */
+ void (*setup_resources)(GetApiFunction get_engine_api);
+
+ /* Called when the engine shuts down the ResourceManager. */
+ void (*shutdown_resources)();
+
+ /* Called when the engine sets up the game. At this point, you can use the
+ functions in the LuaApi to add functions to the engine's Lua API. */
+ void (*setup_game)(GetApiFunction get_engine_api);
+
+ /* Called per game frame. */
+ void (*update_game)(float dt);
+
+ /* Called when the engine shuts down the game. */
+ void (*shutdown_game)();
+
+ /* Called before a world is about to be destroyed and removed from the engines
+ * list of worlds. */
+ void (*unregister_world)(CApiWorld *world);
+
+ /* Called after the world has been created and is about to be added to the
+ * engines list of worlds */
+ void (*register_world)(CApiWorld *world);
+
+ /* Returns the hash of the plugin. (Optional) */
+ uint64_t (*get_hash)();
+
+ /* Returns the name of the plugin. */
+ const char *(*get_name)();
+
+ void (*unkfunc13)();
+ void (*unkfunc14)();
+ void *(*unkfunc15)(); // returns some func table
+
+ /* Called by the engine to draw debug visuals into the world. */
+ void (*debug_draw)(CApiWorld *world, struct StateReflectionStream *srs);
+};
+
+/* Opaque struct representing a Lua state. */
+typedef struct lua_State lua_State;
+
+/* Types from Lua. */
+typedef int (*lua_CFunction)(lua_State *L);
+typedef struct lua_Debug lua_Debug;
+typedef double lua_Number;
+typedef ptrdiff_t lua_Integer;
+typedef void (*lua_Hook)(lua_State *L, lua_Debug *ar);
+typedef const char *(*lua_Reader)(lua_State *L, void *ud, size_t *sz);
+typedef int (*lua_Writer)(lua_State *L, const void *p, size_t sz, void *ud);
+typedef void *(*lua_Alloc)(void *ud, void *ptr, size_t osize, size_t nsize);
+typedef struct luaL_Reg luaL_Reg;
+
+/*
+ Interface to access Lua services.
+*/
+struct LuaApi {
+ /* -----------------------------------------------------------------------
+ Extending Lua
+ ----------------------------------------------------------------------- */
+
+ /* Adds a new lua function in the module with the specified name.
+
+ The function will be callable as stingray.{module}.{name}() */
+ void (*add_module_function)(const char *module, const char *name,
+ lua_CFunction f);
+
+ /* Sets a bool constant in a module. */
+ void (*set_module_bool)(const char *module, const char *key, int value);
+
+ /* Sets a number constant in a module. */
+ void (*set_module_number)(const char *module, const char *key, double value);
+
+ /* Sets a string constant in a module. */
+ void (*set_module_string)(const char *module, const char *key,
+ const char *value);
+
+ /* As add_module_function() but prints a deprecation warning when the function
+ * is used. */
+ void (*deprecated_warning)(const char *module, const char *name,
+ lua_CFunction f, const char *message);
+
+ /* Adds a new console command. Console commands are Lua functions in the
+ stingray.Console module that only takes string parameters. They can be used
+ from the console:
+
+ > memory_resources all
+
+ is equivalent to
+
+ > Console.memory_resources("all")
+
+ The vararg is a sequence of documentation strings, ended by a nullptr --
+ like this:
+
+ add_console_command("memory_resources", memory_resources_f,
+ "Print memory usage per resource",
+ "all", "print memory use of all resources",
+ "sound", "print memory use of sound resources",
+ "texture_categories [details]", "print memory usage per
+ texture category", "list ", "list memory use of specified types",
+ (void*)nullptr); */
+ void (*add_console_command)(const char *command, lua_CFunction f,
+ const char *desc, ...);
+
+ /* -----------------------------------------------------------------------
+ Lua standard functions
+
+ See the Lua API for documentation.
+ ----------------------------------------------------------------------- */
+
+ /* State manipulation */
+ lua_State *(*newstate)(lua_Alloc f, void *ud);
+ void (*close)(lua_State *L);
+ lua_State *(*newthread)(lua_State *L);
+ lua_CFunction (*atpanic)(lua_State *L, lua_CFunction panicf);
+
+ /* Basic stack manipulation */
+ int (*gettop)(lua_State *L);
+ void (*settop)(lua_State *L, int idx);
+ void (*pushvalue)(lua_State *L, int idx);
+ void (*remove)(lua_State *L, int idx);
+ void (*insert)(lua_State *L, int idx);
+ void (*replace)(lua_State *L, int idx);
+ int (*checkstack)(lua_State *L, int sz);
+ void (*xmove)(lua_State *from, lua_State *to, int n);
+
+ const void *(*fnx1)(lua_State *L, int idx);
+
+ /* Access functions */
+ int (*isnumber)(lua_State *L, int idx);
+ int (*isstring)(lua_State *L, int idx);
+ int (*iscfunction)(lua_State *L, int idx);
+ int (*isuserdata)(lua_State *L, int idx);
+ int (*type)(lua_State *L, int idx);
+ const char *(*lua_typename)(lua_State *L, int tp);
+
+ int (*equal)(lua_State *L, int idx1, int idx2);
+ int (*rawequal)(lua_State *L, int idx1, int idx2);
+ int (*lessthan)(lua_State *L, int idx1, int idx2);
+
+ lua_Number (*tonumber)(lua_State *L, int idx);
+ lua_Integer (*tointeger)(lua_State *L, int idx);
+ int (*toboolean)(lua_State *L, int idx);
+ const char *(*tolstring)(lua_State *L, int idx, size_t *len);
+ size_t (*objlen)(lua_State *L, int idx);
+ lua_CFunction (*tocfunction)(lua_State *L, int idx);
+ void *(*touserdata)(lua_State *L, int idx);
+ lua_State *(*tothread)(lua_State *L, int idx);
+ const void *(*topointer)(lua_State *L, int idx);
+
+ const void *(*fnx2)(lua_State *L, int idx);
+
+ /* Push functions */
+ void (*pushnil)(lua_State *L);
+ void (*pushnumber)(lua_State *L, lua_Number n);
+ void (*pushinteger)(lua_State *L, lua_Integer n);
+ void (*pushlstring)(lua_State *L, const char *s, size_t l);
+ void (*pushstring)(lua_State *L, const char *s);
+ const char *(*pushvfstring)(lua_State *L, const char *fmt, va_list argp);
+ const char *(*pushfstring)(lua_State *L, const char *fmt, ...);
+ void (*pushcclosure)(lua_State *L, lua_CFunction fn, int n);
+ void (*pushboolean)(lua_State *L, int b);
+ void (*pushlightuserdata)(lua_State *L, void *p);
+ int (*pushthread)(lua_State *L);
+
+ /* Get functions */
+ void (*gettable)(lua_State *L, int idx);
+ void (*getfield)(lua_State *L, int idx, const char *k);
+ void (*rawget)(lua_State *L, int idx);
+ void (*rawgeti)(lua_State *L, int idx, int n);
+ void (*createtable)(lua_State *L, int narr, int nrec);
+ void *(*newuserdata)(lua_State *L, size_t sz);
+ int (*getmetatable)(lua_State *L, int objindex);
+ void (*getfenv)(lua_State *L, int idx);
+
+ /* Set functions */
+ void (*settable)(lua_State *L, int idx);
+ void (*setfield)(lua_State *L, int idx, const char *k);
+ void (*rawset)(lua_State *L, int idx);
+ void (*rawseti)(lua_State *L, int idx, int n);
+ int (*setmetatable)(lua_State *L, int objindex);
+ int (*setfenv)(lua_State *L, int idx);
+
+ /* Load and call functions */
+ void (*call)(lua_State *L, int nargs, int nresults);
+ int (*pcall)(lua_State *L, int nargs, int nresults, int errfunc);
+ int (*cpcall)(lua_State *L, lua_CFunction func, void *ud);
+ int (*load)(lua_State *L, lua_Reader reader, void *dt, const char *chunkname);
+ int (*dump)(lua_State *L, lua_Writer writer, void *data);
+
+ /* Coroutine functions */
+ int (*yield)(lua_State *L, int nresults);
+ int (*resume)(lua_State *L, int narg);
+ int (*status)(lua_State *L);
+
+ /* Garbage collection */
+ int (*gc)(lua_State *L, int what, int data);
+
+ /* Miscellaneous functions */
+ int (*error)(lua_State *L);
+ int (*next)(lua_State *L, int idx);
+ void (*concat)(lua_State *L, int n);
+
+ /* Debugging */
+ int (*getstack)(lua_State *L, int level, lua_Debug *ar);
+ int (*getinfo)(lua_State *L, const char *what, lua_Debug *ar);
+ const char *(*getlocal)(lua_State *L, const lua_Debug *ar, int n);
+ const char *(*setlocal)(lua_State *L, const lua_Debug *ar, int n);
+ const char *(*getupvalue)(lua_State *L, int funcindex, int n);
+ const char *(*setupvalue)(lua_State *L, int funcindex, int n);
+
+ int (*sethook)(lua_State *L, lua_Hook func, int mask, int count);
+ lua_Hook (*gethook)(lua_State *L);
+ int (*gethookmask)(lua_State *L);
+ int (*gethookcount)(lua_State *L);
+
+ // int (*fnx3) (lua_State* L);
+
+ /* Library functions */
+ void (*lib_openlib)(lua_State *L, const char *libname, const luaL_Reg *l,
+ int nup);
+ void (*lib_register)(lua_State *L, const char *libname, const luaL_Reg *l);
+ int (*lib_getmetafield)(lua_State *L, int obj, const char *e);
+ int (*lib_callmeta)(lua_State *L, int obj, const char *e);
+ int (*lib_typerror)(lua_State *L, int narg, const char *tname);
+ int (*lib_argerror)(lua_State *L, int numarg, const char *extramsg);
+ const char *(*lib_checklstring)(lua_State *L, int numArg, size_t *l);
+ const char *(*lib_optlstring)(lua_State *L, int numArg, const char *def,
+ size_t *l);
+ lua_Number (*lib_checknumber)(lua_State *L, int numArg);
+ lua_Number (*lib_optnumber)(lua_State *L, int nArg, lua_Number def);
+ lua_Integer (*lib_checkinteger)(lua_State *L, int numArg);
+ lua_Integer (*lib_optinteger)(lua_State *L, int nArg, lua_Integer def);
+ void (*lib_checkstack)(lua_State *L, int sz, const char *msg);
+ void (*lib_checktype)(lua_State *L, int narg, int t);
+ void (*lib_checkany)(lua_State *L, int narg);
+ int (*lib_newmetatable)(lua_State *L, const char *tname);
+ void *(*lib_checkudata)(lua_State *L, int ud, const char *tname);
+ void (*lib_where)(lua_State *L, int lvl);
+ int (*lib_error)(lua_State *L, const char *fmt, ...);
+ int (*lib_checkoption)(lua_State *L, int narg, const char *def,
+ const char *const lst[]);
+ int (*lib_ref)(lua_State *L, int t);
+ void (*lib_unref)(lua_State *L, int t, int ref);
+ int (*lib_loadfile)(lua_State *L, const char *filename);
+ int (*lib_loadbuffer)(lua_State *L, const char *buff, size_t sz,
+ const char *name);
+ int (*lib_loadstring)(lua_State *L, const char *s);
+ lua_State *(*lib_newstate)(void);
+ const char *(*lib_gsub)(lua_State *L, const char *s, const char *p,
+ const char *r);
+ const char *(*lib_findtable)(lua_State *L, int idx, const char *fname,
+ int szhint);
+ void (*lib_openlibs)(lua_State *L);
+
+ /* -----------------------------------------------------------------------
+ Lua Stingray extensions
+ ----------------------------------------------------------------------- */
+
+ /* Gets an index integer from the stack. This will automatically convert
+ from 1-based (Lua convention) to 0-based (C convention). */
+ int (*getindex)(lua_State *L, int idx);
+
+ /* Pushes an index integer to the stack. This will automatically convert
+ from 0-based (C convention) to 1-based (lua convention). */
+ void (*pushindex)(lua_State *L, int n);
+
+ /* As getindex() but uses either 0 or 1 based convention on the Lua side,
+ depending on user project settings. */
+ int (*getindex_0_or_1_based)(lua_State *L, int idx);
+
+ /* As pushindex() but uses either 0 or 1 based convention on the Lua side,
+ depending on user project settings. */
+ void (*pushindex_0_or_1_based)(lua_State *L, int n);
+
+ /* Pushes a Vector3 to the stack. */
+ void (*pushvector3)(lua_State *L, float v[3]);
+
+ /* Pushes a Quaternion to the stack. */
+ void (*pushquaternion)(lua_State *L, float q[4]);
+
+ /* Pushes a Matrix4x4 to the stack. */
+ void (*pushmatrix4x4)(lua_State *L, float m[16]);
+
+ /* Pushes a Vector3Box to the stack. */
+ void (*pushvector3box)(lua_State *L, float v[3]);
+
+ /* Gets a Vector3 at the specified index. */
+ float *(*getvector3)(lua_State *L, int i);
+
+ /* Gets a Vector4 at the specified index. */
+ float *(*getvector4)(lua_State *L, int i);
+
+ /* Gets a Quaternion at the specified index. */
+ float *(*getquaternion)(lua_State *L, int i);
+
+ /* Gets a Matrix4x4 at the specified index. */
+ float *(*getvector3box)(lua_State *L, int i);
+
+ /* Gets a Unit at the specified index. */
+ CApiUnit *(*getunit)(lua_State *L, int i);
+
+ /* Gets the Lua state where the main scripts execute. */
+ lua_State *(*getscriptenvironmentstate)();
+
+ /* Returns true if the stack entry is a table. */
+ int (*istable)(lua_State *L, int i);
+
+ /* Returns true if the stack entry is a Vector3. */
+ int (*isvector3_)(lua_State *L, int i);
+
+ /* Returns true if the stack entry is a Vector3. */
+ int (*isvector3)(lua_State *L, int i);
+
+ /* Returns true if the stack entry is a Quaternion. */
+ int (*isquaternion)(lua_State *L, int i);
+
+ /* Returns true if the stack entry is a Matrix4x4. */
+ int (*ismatrix4x4)(lua_State *L, int i);
+
+ /* Pops the top value from the Lua stack. */
+ void (*pop)(lua_State *L);
+
+ /* Returns true if the stack entry is a UnitReference. */
+ int (*isunitreference)(lua_State *L, int i);
+
+ /* Reserved for expansion of the API. */
+ void *reserved[32];
+};
+
+struct LoggingApi {
+ /* Logs an informational message */
+ void (*info)(const char *system, const char *info);
+
+ /* Logs a warning message. */
+ void (*warning)(const char *system, const char *warning);
+
+ /* Logs an error message. */
+ void (*error)(const char *system, const char *error);
+};
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/src/stingray_sdk.rs b/src/stingray_sdk.rs
new file mode 100644
index 0000000..b046b63
--- /dev/null
+++ b/src/stingray_sdk.rs
@@ -0,0 +1,214 @@
+#![allow(non_upper_case_globals)]
+#![allow(non_camel_case_types)]
+#![allow(non_snake_case)]
+#![allow(clippy::type_complexity)]
+#![allow(unused)]
+
+mod bindings {
+ include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
+}
+
+use std::ffi::CStr;
+use std::ffi::CString;
+use std::os::raw::c_char;
+use std::os::raw::c_void;
+
+use bindings::lua_CFunction;
+pub use bindings::lua_State;
+pub use bindings::GetApiFunction;
+pub use bindings::PluginApi;
+pub use bindings::PluginApiID;
+
+impl std::default::Default for PluginApi {
+ fn default() -> Self {
+ Self {
+ version: 65,
+ flags: 3,
+ setup_game: None,
+ update_game: None,
+ shutdown_game: None,
+ get_name: None,
+ loaded: None,
+ start_reload: None,
+ unloaded: None,
+ finish_reload: None,
+ setup_resources: None,
+ shutdown_resources: None,
+ unregister_world: None,
+ register_world: None,
+ get_hash: None,
+ unkfunc13: None,
+ unkfunc14: None,
+ unkfunc15: None,
+ debug_draw: None,
+ }
+ }
+}
+
+#[cfg(debug_assertions)]
+fn get_engine_api(f: GetApiFunction, id: PluginApiID) -> *mut c_void {
+ let f = f.expect("'GetApiFunction' is always passed by the engine");
+ unsafe { f(id as u32) }
+}
+
+#[cfg(not(debug_assertions))]
+fn get_engine_api(f: GetApiFunction, id: PluginApiID) -> *mut c_void {
+ // `Option::unwrap` still generates several instructions in
+ // optimized code.
+ let f = unsafe { f.unwrap_unchecked() };
+
+ unsafe { f(id as u32) }
+}
+
+pub struct LoggingApi {
+ info: unsafe extern "C" fn(*const c_char, *const c_char),
+ warning: unsafe extern "C" fn(*const c_char, *const c_char),
+ error: unsafe extern "C" fn(*const c_char, *const c_char),
+}
+
+impl LoggingApi {
+ pub fn get(f: GetApiFunction) -> Self {
+ let api = unsafe {
+ let api = get_engine_api(f, PluginApiID::LOGGING_API_ID);
+ api as *mut bindings::LoggingApi
+ };
+
+ unsafe {
+ Self {
+ info: (*api).info.unwrap_unchecked(),
+ warning: (*api).warning.unwrap_unchecked(),
+ error: (*api).error.unwrap_unchecked(),
+ }
+ }
+ }
+
+ pub fn info(&self, system: impl Into>, message: impl Into>) {
+ let system = CString::new(system).expect("Invalid CString");
+ let message = CString::new(message).expect("Invalid CString");
+ unsafe {
+ (self.info)(system.as_ptr(), message.as_ptr());
+ }
+ }
+
+ pub fn warning(&self, system: impl Into>, message: impl Into>) {
+ let system = CString::new(system).expect("Invalid CString");
+ let message = CString::new(message).expect("Invalid CString");
+ unsafe {
+ (self.warning)(system.as_ptr(), message.as_ptr());
+ }
+ }
+
+ pub fn error(&self, system: impl Into>, message: impl Into>) {
+ let system = CString::new(system).expect("Invalid CString");
+ let message = CString::new(message).expect("Invalid CString");
+ unsafe {
+ (self.error)(system.as_ptr(), message.as_ptr());
+ }
+ }
+}
+
+#[repr(i32)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub enum LuaType {
+ None = -1,
+ Nil = 0,
+ Boolean = 1,
+ LightUserdata = 2,
+ Number = 3,
+ String = 4,
+ Table = 5,
+ Function = 6,
+ Userdata = 7,
+ Thread = 8,
+ Unknown(i32),
+}
+
+impl From for LuaType {
+ fn from(value: i32) -> Self {
+ match value {
+ -1 => Self::None,
+ 0 => Self::Nil,
+ 1 => Self::Boolean,
+ 2 => Self::LightUserdata,
+ 3 => Self::Number,
+ 4 => Self::String,
+ 5 => Self::Table,
+ 6 => Self::Function,
+ 7 => Self::Userdata,
+ 8 => Self::Thread,
+ _ => Self::Unknown(value),
+ }
+ }
+}
+
+impl std::fmt::Display for LuaType {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ match self {
+ Self::None => write!(f, "None"),
+ Self::Nil => write!(f, "Nil"),
+ Self::Boolean => write!(f, "Boolean"),
+ Self::LightUserdata => write!(f, "LightUserdata"),
+ Self::Number => write!(f, "Number"),
+ Self::String => write!(f, "String"),
+ Self::Table => write!(f, "Table"),
+ Self::Function => write!(f, "Function"),
+ Self::Userdata => write!(f, "Userdata"),
+ Self::Thread => write!(f, "Thread"),
+ Self::Unknown(val) => write!(f, "Unkown({})", val),
+ }
+ }
+}
+
+pub struct LuaApi {
+ add_module_function: unsafe extern "C" fn(*const c_char, *const c_char, lua_CFunction),
+ tolstring: unsafe extern "C" fn(*mut lua_State, i32, *mut usize) -> *const c_char,
+ pushstring: unsafe extern "C" fn(*mut lua_State, *const c_char),
+}
+
+impl LuaApi {
+ pub fn get(f: GetApiFunction) -> Self {
+ let api = unsafe {
+ let api = get_engine_api(f, PluginApiID::LUA_API_ID);
+ api as *mut bindings::LuaApi
+ };
+
+ unsafe {
+ Self {
+ add_module_function: (*api).add_module_function.unwrap_unchecked(),
+ tolstring: (*api).tolstring.unwrap_unchecked(),
+ pushstring: (*api).pushstring.unwrap_unchecked(),
+ }
+ }
+ }
+
+ pub fn add_module_function(
+ &self,
+ module: impl Into>,
+ name: impl Into>,
+ cb: extern "C" fn(*mut lua_State) -> i32,
+ ) {
+ let module = CString::new(module).expect("Invalid CString");
+ let name = CString::new(name).expect("Invalid CString");
+
+ unsafe { (self.add_module_function)(module.as_ptr(), name.as_ptr(), Some(cb)) }
+ }
+
+ pub fn tolstring(&self, L: *mut lua_State, idx: i32) -> Option<&CStr> {
+ let mut len: usize = 0;
+
+ let c = unsafe { (self.tolstring)(L, idx, &mut len as *mut _) };
+
+ if len == 0 {
+ None
+ } else {
+ // Safety: As long as `len > 0`, Lua guarantees the constraints that `CStr::from_ptr`
+ // requires.
+ Some(unsafe { CStr::from_ptr(c) })
+ }
+ }
+
+ pub fn pushstring(&self, L: *mut lua_State, s: impl Into>) {
+ let s = CString::new(s).expect("Invalid CString");
+ unsafe { (self.pushstring)(L, s.as_ptr()) }
+ }
+}