diff --git a/.github/workflows/import-mod-archive.yml b/.github/workflows/import-mod-archive.yml
deleted file mode 100644
index cc7319c..0000000
--- a/.github/workflows/import-mod-archive.yml
+++ /dev/null
@@ -1,73 +0,0 @@
-name: Import full MCM archive
-
-on:
- push:
- paths:
- - 'Metamorph_Creative_Menu_standalone_noitapatcher*.zip'
-
-permissions:
- contents: write
-
-jobs:
- import:
- runs-on: ubuntu-latest
- steps:
- - name: Check out repository
- uses: actions/checkout@v4
- with:
- fetch-depth: 0
-
- - name: Import standalone archive
- shell: python
- run: |
- import glob
- import os
- import shutil
- import zipfile
- from pathlib import Path, PurePosixPath
-
- archives = sorted(glob.glob('Metamorph_Creative_Menu_standalone_noitapatcher*.zip'))
- if not archives:
- raise SystemExit('Standalone archive was not found')
- archive = archives[-1]
-
- with zipfile.ZipFile(archive) as zf:
- members = zf.infolist()
- for member in members:
- path = PurePosixPath(member.filename)
- if path.is_absolute() or '..' in path.parts:
- raise SystemExit(f'Unsafe archive path: {member.filename}')
- roots = {PurePosixPath(m.filename).parts[0] for m in members if PurePosixPath(m.filename).parts}
- if roots != {'metamorph_creative_menu'}:
- raise SystemExit(f'Unexpected archive root: {sorted(roots)}')
-
- target = Path('metamorph_creative_menu')
- if target.exists():
- shutil.rmtree(target)
- zf.extractall('.')
-
- required = [
- Path('metamorph_creative_menu/mod.xml'),
- Path('metamorph_creative_menu/mod_id.txt'),
- Path('metamorph_creative_menu/init.lua'),
- Path('metamorph_creative_menu/NoitaPatcher/noitapatcher.dll'),
- ]
- missing = [str(path) for path in required if not path.is_file()]
- if missing:
- raise SystemExit('Missing required files: ' + ', '.join(missing))
-
- for item in archives:
- os.remove(item)
-
- - name: Commit imported mod
- shell: bash
- run: |
- git config user.name "github-actions[bot]"
- git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
- git add -A
- if git diff --cached --quiet; then
- echo "Archive contents already match the repository."
- exit 0
- fi
- git commit -m "Import full standalone Metamorph Creative Menu"
- git push
diff --git a/.github/workflows/publish-ready-build.yml b/.github/workflows/publish-ready-build.yml
deleted file mode 100644
index 3d4565c..0000000
--- a/.github/workflows/publish-ready-build.yml
+++ /dev/null
@@ -1,94 +0,0 @@
-name: Publish ready-to-install build
-
-on:
- push:
- branches: [main]
- workflow_dispatch:
-
-permissions:
- contents: write
-
-concurrency:
- group: publish-ready-build
- cancel-in-progress: true
-
-jobs:
- publish:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v4
- with:
- fetch-depth: 0
-
- - name: Keep one-click download table in README
- shell: bash
- run: |
- python3 - <<'PY'
- from pathlib import Path
-
- path = Path('README.md')
- text = path.read_text(encoding='utf-8')
- if '## Download / Скачать' not in text:
- needle = '| 한국어 | [한국어](#ko) |\n\n'
- lines = [
- '| 한국어 | [한국어](#ko) |',
- '',
- '## Download / Скачать',
- '',
- '| Build / Сборка | Download / Скачать |',
- '|---|---|',
- '| **Ready-to-install / Готовая версия** | **[⬇️ Download ZIP / Скачать ZIP](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/download/latest-build/Metamorph-Creative-Menu.zip)** |',
- '| Build page / Страница сборки | [Open / Открыть](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/tag/latest-build) |',
- '',
- '> The ZIP already contains the `metamorph_creative_menu` folder. Extract/copy that folder directly into `Noita/mods/`. ',
- '> ZIP уже содержит папку `metamorph_creative_menu`. Распакуйте/скопируйте её прямо в `Noita/mods/`.',
- '',
- ]
- block = '\n'.join(lines)
- if needle not in text:
- raise SystemExit('Language table marker not found in README.md')
- text = text.replace(needle, block, 1)
- text = text.replace(
- '> ZIP уже содержит папку `metamorph_creative_menu`. Распакуйте/скопируйте её прямо в `Noita/mods/`.\n> Choose your language above.',
- '> ZIP уже содержит папку `metamorph_creative_menu`. Распакуйте/скопируйте её прямо в `Noita/mods/`.\n\n> Choose your language above.',
- 1,
- )
- path.write_text(text, encoding='utf-8')
- PY
-
- if ! git diff --quiet -- README.md; then
- git config user.name "github-actions[bot]"
- git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
- git add README.md
- git commit -m "Polish one-click download section"
- git push
- fi
-
- - name: Package playable mod
- shell: bash
- run: |
- rm -f Metamorph-Creative-Menu.zip
- zip -r -9 Metamorph-Creative-Menu.zip metamorph_creative_menu \
- -x 'metamorph_creative_menu/tests/*' \
- 'metamorph_creative_menu/README.txt'
- unzip -l Metamorph-Creative-Menu.zip | grep -q 'metamorph_creative_menu/mod.xml'
- unzip -l Metamorph-Creative-Menu.zip | grep -q 'metamorph_creative_menu/init.lua'
-
- - name: Publish stable download URL
- env:
- GH_TOKEN: ${{ github.token }}
- shell: bash
- run: |
- git tag -f latest-build HEAD
- git push origin refs/tags/latest-build --force
-
- if gh release view latest-build >/dev/null 2>&1; then
- gh release upload latest-build Metamorph-Creative-Menu.zip --clobber
- gh release edit latest-build \
- --title "Latest ready-to-install build" \
- --notes "Automatically packaged from the current main branch. Download Metamorph-Creative-Menu.zip, then copy the included metamorph_creative_menu folder into Noita/mods/."
- else
- gh release create latest-build Metamorph-Creative-Menu.zip \
- --title "Latest ready-to-install build" \
- --notes "Automatically packaged from the current main branch. Download Metamorph-Creative-Menu.zip, then copy the included metamorph_creative_menu folder into Noita/mods/."
- fi
diff --git a/.github/workflows/workshop-validation.yml b/.github/workflows/workshop-validation.yml
new file mode 100644
index 0000000..acd31e6
--- /dev/null
+++ b/.github/workflows/workshop-validation.yml
@@ -0,0 +1,366 @@
+name: Workshop build
+
+on:
+ push:
+ branches: [workshop]
+ workflow_dispatch:
+
+permissions:
+ contents: read
+
+concurrency:
+ group: workshop-build
+ cancel-in-progress: true
+
+jobs:
+ validate:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v7
+
+ - name: Validate exact Workshop payload
+ shell: bash
+ run: |
+ set -euo pipefail
+ python3 - <<'PY'
+ from pathlib import Path
+ import re
+ import struct
+ import xml.etree.ElementTree as ET
+
+ root = Path('metamorph_creative_menu')
+ required_source = [
+ 'mod.xml',
+ 'mod_id.txt',
+ 'init.lua',
+ 'settings.lua',
+ 'translations.csv',
+ 'workshop.xml',
+ 'workshop_preview_image.png',
+ 'README.txt',
+ ]
+ missing = [name for name in required_source if not (root / name).is_file()]
+ if missing:
+ raise SystemExit('Missing Workshop source files: ' + ', '.join(missing))
+
+ if (root / 'README.txt').read_text(encoding='utf-8') != 'Creator: zerodancing\n':
+ raise SystemExit("Workshop source README.txt must contain only 'Creator: zerodancing'")
+
+ if (root / 'NoitaPatcher').exists():
+ raise SystemExit('Workshop branch must not contain NoitaPatcher/')
+ dlls = sorted(p.relative_to(root).as_posix() for p in root.rglob('*.dll'))
+ if dlls:
+ raise SystemExit('Native DLLs are not allowed in Workshop branch: ' + ', '.join(dlls))
+
+ if (root / 'mod_id.txt').read_text(encoding='utf-8').strip() != 'metamorph_creative_menu':
+ raise SystemExit('Unexpected mod_id.txt value')
+
+ mod_root = ET.parse(root / 'mod.xml').getroot()
+ if mod_root.tag != 'Mod' or mod_root.attrib.get('name') != 'Metamorph: Creative Menu':
+ raise SystemExit('Unexpected mod.xml metadata')
+ if 'request_no_api_restrictions' in mod_root.attrib:
+ raise SystemExit('Workshop mod.xml must not request unrestricted API')
+ if mod_root.attrib.get('is_game_mode', '0') not in {'0', 'false'}:
+ raise SystemExit('Workshop build must not be a game mode')
+
+ workshop = ET.parse(root / 'workshop.xml').getroot()
+ if workshop.tag != 'Mod' or workshop.attrib.get('name') != 'Metamorph: Creative Menu':
+ raise SystemExit('Unexpected workshop.xml metadata')
+ if workshop.attrib.get('description') != '':
+ raise SystemExit('workshop.xml description must remain empty so Steam page text is not overwritten')
+
+ documented_tags = {
+ 'gameplay','graphics','quality of life','translations','perks','spells',
+ 'player characters','loadouts','biomes','total conversions','game modes',
+ 'creatures','bosses','alchemy','tweaks','items','audio','cheats','funny',
+ 'streaming integration','mod dependencies',
+ }
+ tags = [x.strip() for x in workshop.attrib.get('tags', '').split(',') if x.strip()]
+ unknown_tags = sorted(set(tags) - documented_tags)
+ if unknown_tags:
+ raise SystemExit('Unknown Workshop tags: ' + ', '.join(unknown_tags))
+ if 'gameplay' not in tags:
+ raise SystemExit('Workshop tags must include gameplay')
+
+ def split_pipe(value):
+ return [x.strip().replace('\\', '/') for x in value.split('|') if x.strip()]
+
+ excluded_dirs = set(split_pipe(workshop.attrib.get('dont_upload_folders', '')))
+ excluded_files = set(split_pipe(workshop.attrib.get('dont_upload_files', '')))
+ required_excluded_dirs = {'NoitaPatcher', 'tests', 'files/qa', 'files/diagnostics'}
+ required_excluded_files = {
+ 'README.txt',
+ 'dev_mode.lua',
+ 'files/core/bounded_log.lua',
+ 'files/features/creatures/diagnostics.lua',
+ 'files/integrations/ew/bridge/qa.lua',
+ 'files/integrations/ew/bridge/qa_reserved.lua',
+ }
+ missing_dir_exclusions = sorted(required_excluded_dirs - excluded_dirs)
+ missing_file_exclusions = sorted(required_excluded_files - excluded_files)
+ if missing_dir_exclusions:
+ raise SystemExit('Missing Workshop folder exclusions: ' + ', '.join(missing_dir_exclusions))
+ if missing_file_exclusions:
+ raise SystemExit('Missing Workshop file exclusions: ' + ', '.join(missing_file_exclusions))
+
+ preview = root / 'workshop_preview_image.png'
+ data = preview.read_bytes()
+ if len(data) < 24 or data[:8] != b'\x89PNG\r\n\x1a\n' or data[12:16] != b'IHDR':
+ raise SystemExit('workshop_preview_image.png is not a valid PNG with IHDR header')
+ width, height = struct.unpack('>II', data[16:24])
+ if (width, height) != (1280, 720) or width * 9 != height * 16:
+ raise SystemExit(f'Workshop preview must be exactly 1280x720 (16:9), got {width}x{height}')
+ if preview.stat().st_size >= 1_000_000:
+ raise SystemExit('Workshop preview should stay below 1 MB')
+
+ def excluded(relative):
+ name = relative.as_posix()
+ return name in excluded_files or any(name == d or name.startswith(d + '/') for d in excluded_dirs)
+
+ allowed_suffixes = {'.txt','.csv','.xml','.json','.bmp','.png','.lua','.frag','.vert','.bank','.bin','.plz'}
+ uploaded = []
+ bad_types = []
+ symlinks = []
+ for path in sorted(root.rglob('*')):
+ if not path.is_file():
+ continue
+ relative = path.relative_to(root)
+ if path.is_symlink():
+ symlinks.append(relative.as_posix())
+ continue
+ if excluded(relative):
+ continue
+ uploaded.append(relative.as_posix())
+ if path.suffix.lower() not in allowed_suffixes:
+ bad_types.append(relative.as_posix())
+
+ if symlinks:
+ raise SystemExit('Symlinks are not allowed in Workshop payload: ' + ', '.join(symlinks))
+ if bad_types:
+ raise SystemExit('Unsupported Workshop file types: ' + ', '.join(bad_types))
+
+ uploaded_set = set(uploaded)
+ essential = {'mod.xml','mod_id.txt','init.lua','settings.lua','translations.csv','workshop.xml','workshop_preview_image.png'}
+ missing_essential = sorted(essential - uploaded_set)
+ if missing_essential:
+ raise SystemExit('Essential files excluded from Workshop upload: ' + ', '.join(missing_essential))
+
+ forbidden_upload = sorted(
+ name for name in uploaded
+ if name in required_excluded_files
+ or name.lower().endswith('.dll')
+ or name.startswith('NoitaPatcher/')
+ or name.startswith('tests/')
+ or name.startswith('files/qa/')
+ or name.startswith('files/diagnostics/')
+ )
+ if forbidden_upload:
+ raise SystemExit('Developer/native files leaked into Workshop payload: ' + ', '.join(forbidden_upload))
+
+ strong_rules = [
+ ('numbered test chronology', re.compile(r'\bTEST\s+\d+\b', re.I)),
+ ('test-only production API', re.compile(r'\b[A-Za-z0-9_]+_for_test\b')),
+ ('conversation-specific wording', re.compile(r"\b(?:the\s+)?user['’]s\s+build\b|\bat\s+the\s+user['’]s\s+request\b", re.I)),
+ ('numbered runtime label', re.compile(r'\[MCM\s*(?:TEST\s*)?\d{2,}\]', re.I)),
+ ('AI attribution residue', re.compile(r'\b(?:ChatGPT|OpenAI|Claude|Gemini|Copilot|LLM|AI[- ]generated|generated\s+by\s+AI)\b', re.I)),
+ ('debug-named runtime API', re.compile(r'\b(?:debug_[A-Za-z0-9_]+|[A-Za-z0-9_]+_debug|[A-Za-z0-9_]+\.debug(?:_[A-Za-z0-9_]+)?)\b')),
+ ('development mode wiring', re.compile(r'\b(?:dev_mode|DEV_MODE|METAMORPH_CREATIVE_MENU_DEV_MODE)\b')),
+ ('diagnostics runtime hook', re.compile(r'METAMORPH_CREATIVE_MENU_DIAGNOSTICS|\bdiagnostic_event\b')),
+ ('UI action audit hook', re.compile(r'\bui\.audit\b|\blocal\s+audit\s*=\s*ui\.audit\b')),
+ ]
+ residue = []
+ for name in uploaded:
+ if not name.endswith('.lua'):
+ continue
+ text = (root / name).read_text(encoding='utf-8', errors='replace')
+ for lineno, line in enumerate(text.splitlines(), 1):
+ for label, pattern in strong_rules:
+ if pattern.search(line):
+ residue.append(f'{name}:{lineno}: {label}: {line.strip()}')
+ if residue:
+ raise SystemExit('Workshop runtime residue detected:\n' + '\n'.join(residue))
+
+ unsafe_api = re.compile(r'(? {dependency}')
+ if missing_refs:
+ raise SystemExit('Workshop payload references missing local files:\n' + '\n'.join(sorted(set(missing_refs))))
+
+ mode = 'update' if (root / 'workshop_id.txt').exists() else 'first-publication'
+ print(
+ f'Workshop payload: PASS mode={mode} files={len(uploaded)} '
+ f'preview={width}x{height} preview_bytes={preview.stat().st_size}'
+ )
+ PY
+
+ - name: Install texlua
+ shell: bash
+ run: |
+ sudo apt-get update -qq
+ sudo apt-get install -y --no-install-recommends texlive-binaries >/dev/null
+
+ - name: Run Workshop regression suite
+ working-directory: metamorph_creative_menu
+ shell: bash
+ run: |
+ python3 - <<'PY'
+ from pathlib import Path
+ import shutil
+ import subprocess
+ import sys
+
+ root = Path('.').resolve()
+ texlua = shutil.which('texlua')
+ if not texlua:
+ raise SystemExit('texlua not found')
+
+ excluded_contracts = {'standalone_patcher_contract.py'}
+ preferred = [
+ 'syntax_contract.py',
+ 'architecture_contract.py',
+ 'behavior_coverage_contract.py',
+ 'localization_contract.py',
+ 'qa_phase_contract.py',
+ ]
+ contracts = {
+ p.name: p for p in (root / 'tests').glob('*_contract.py')
+ if p.name not in excluded_contracts
+ }
+ ordered = []
+ for name in preferred:
+ path = contracts.pop(name, None)
+ if path is not None:
+ ordered.append(path)
+ ordered.extend(contracts[name] for name in sorted(contracts))
+ mocks = sorted((root / 'tests').glob('*_mock.lua'), key=lambda p: p.name)
+
+ commands = [[sys.executable, str(path), str(root)] for path in ordered]
+ commands.extend([[texlua, str(path), str(root)] for path in mocks])
+ for command in commands:
+ print('+', ' '.join(command), flush=True)
+ subprocess.run(command, check=True)
+
+ print(
+ 'WORKSHOP_REGRESSION_TESTS=PASS '
+ f'count={len(commands)} contracts={len(ordered)} behavioral_mocks={len(mocks)} '
+ 'excluded=standalone_patcher_contract.py'
+ )
+ PY
+
+ publish:
+ needs: validate
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - uses: actions/checkout@v7
+
+ - name: Package exact Workshop upload set
+ shell: bash
+ run: |
+ set -euo pipefail
+ python3 - <<'PY'
+ from pathlib import Path
+ from zipfile import ZIP_DEFLATED, ZipFile, ZipInfo
+ import xml.etree.ElementTree as ET
+
+ root = Path('metamorph_creative_menu')
+ archive_path = Path('Metamorph-Creative-Menu-Workshop.zip')
+ workshop = ET.parse(root / 'workshop.xml').getroot()
+
+ def split_pipe(value):
+ return [x.strip().replace('\\', '/') for x in value.split('|') if x.strip()]
+
+ excluded_dirs = set(split_pipe(workshop.attrib.get('dont_upload_folders', '')))
+ excluded_files = set(split_pipe(workshop.attrib.get('dont_upload_files', '')))
+
+ def excluded(relative):
+ name = relative.as_posix()
+ return name in excluded_files or any(name == d or name.startswith(d + '/') for d in excluded_dirs)
+
+ files = [path for path in sorted(root.rglob('*')) if path.is_file() and not excluded(path.relative_to(root))]
+ with ZipFile(archive_path, 'w', compression=ZIP_DEFLATED, compresslevel=9) as archive:
+ for path in files:
+ relative = Path('metamorph_creative_menu') / path.relative_to(root)
+ info = ZipInfo(relative.as_posix(), date_time=(1980, 1, 1, 0, 0, 0))
+ info.compress_type = ZIP_DEFLATED
+ info.external_attr = 0o100644 << 16
+ archive.writestr(info, path.read_bytes())
+
+ with ZipFile(archive_path) as archive:
+ names = {name for name in archive.namelist() if not name.endswith('/')}
+ required = {
+ 'metamorph_creative_menu/mod.xml',
+ 'metamorph_creative_menu/mod_id.txt',
+ 'metamorph_creative_menu/init.lua',
+ 'metamorph_creative_menu/settings.lua',
+ 'metamorph_creative_menu/translations.csv',
+ 'metamorph_creative_menu/workshop.xml',
+ 'metamorph_creative_menu/workshop_preview_image.png',
+ }
+ missing = sorted(required - names)
+ if missing:
+ raise SystemExit('Missing required files in Workshop ZIP: ' + ', '.join(missing))
+ forbidden_exact = {
+ 'metamorph_creative_menu/README.txt',
+ 'metamorph_creative_menu/dev_mode.lua',
+ 'metamorph_creative_menu/files/core/bounded_log.lua',
+ 'metamorph_creative_menu/files/features/creatures/diagnostics.lua',
+ 'metamorph_creative_menu/files/integrations/ew/bridge/qa.lua',
+ 'metamorph_creative_menu/files/integrations/ew/bridge/qa_reserved.lua',
+ }
+ forbidden = sorted(
+ name for name in names
+ if name in forbidden_exact
+ or name.lower().endswith('.dll')
+ or name.startswith('metamorph_creative_menu/NoitaPatcher/')
+ or name.startswith('metamorph_creative_menu/tests/')
+ or name.startswith('metamorph_creative_menu/files/qa/')
+ or name.startswith('metamorph_creative_menu/files/diagnostics/')
+ )
+ if forbidden:
+ raise SystemExit('Forbidden files in Workshop ZIP: ' + ', '.join(forbidden))
+ broken = archive.testzip()
+ if broken is not None:
+ raise SystemExit('Workshop ZIP CRC failure: ' + broken)
+ print(f'Workshop ZIP: PASS files={len(files)} bytes={archive_path.stat().st_size}')
+ PY
+
+ - name: Publish stable Workshop download
+ env:
+ GH_TOKEN: ${{ github.token }}
+ shell: bash
+ run: |
+ set -euo pipefail
+ TAG=workshop-latest
+ ASSET=Metamorph-Creative-Menu-Workshop.zip
+ notes="Ready-to-upload Steam Workshop edition. Source commit: ${GITHUB_SHA}. This build intentionally excludes bundled NoitaPatcher/DLL and unrestricted API access."
+
+ if gh release view "$TAG" >/dev/null 2>&1; then
+ gh release upload "$TAG" "$ASSET" --clobber
+ gh release edit "$TAG" --title "Latest Steam Workshop build" --notes "$notes"
+ else
+ gh release create "$TAG" "$ASSET" --target "$GITHUB_SHA" --title "Latest Steam Workshop build" --notes "$notes"
+ fi
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..17713d7
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,28 @@
+Metamorph Creative Menu Attribution License 1.0
+
+Copyright (c) 2026 zerodancing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of the original portions of Metamorph: Creative Menu and its associated source code, scripts, original assets, and documentation (the "Software"), to use, copy, reproduce, modify, merge, publish, distribute, sublicense, sell, rent, monetize, and otherwise use the Software for any commercial or non-commercial purpose, subject to the following conditions:
+
+1. License preservation.
+ Any redistribution of the Software, whether in original or modified form and whether in source or binary form, must include a readable copy of this license.
+
+2. Required attribution.
+ Any redistribution of the Software or a derivative work based on the Software must preserve the following attribution in a reasonably visible place available to recipients:
+
+ Original developer: zerodancing
+ Developer page: https://github.com/zerodancing
+ Original project: https://github.com/zerodancing/Metamorph-Creative-Menu
+
+ The attribution may appear in an accompanying LICENSE, NOTICE, or credits file; in documentation supplied with the distribution; on the mod, product, download, or store page from which the distribution is obtained; or in a credits/about screen. The attribution must remain readable and must not be deliberately hidden.
+
+3. Modified versions.
+ You may identify your own modifications, add your own copyright notices, and apply additional terms to your own original contributions. You may not remove or override the license-preservation and attribution requirements above for the original Software or portions derived from it.
+
+4. No endorsement.
+ This license does not grant permission to claim that zerodancing endorses, sponsors, maintains, or is responsible for a modified or redistributed version.
+
+5. Third-party material.
+ This license applies only to material for which zerodancing has the right to grant these permissions. Third-party components, libraries, game resources, trademarks, and other materials remain subject to their own licenses and terms. See THIRD_PARTY_NOTICES.md where applicable.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..2354104
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,7 @@
+Metamorph: Creative Menu
+
+Original developer: zerodancing
+Developer page: https://github.com/zerodancing
+Original project: https://github.com/zerodancing/Metamorph-Creative-Menu
+
+Redistributions and modified versions must preserve this attribution as required by the Metamorph Creative Menu Attribution License 1.0.
diff --git a/README.md b/README.md
index 08e019a..f4666c5 100644
--- a/README.md
+++ b/README.md
@@ -2,655 +2,82 @@
-Metamorph: Creative Menu
+Metamorph: Creative Menu — Steam Workshop build
-
- A standalone creative toolkit for Noita — transformations, possession, spells, items, perks, effects, weather and World Rules.
-
-
-
-
-## Choose your language
-
-| Language | Guide |
-|---|---|
-| English | [Open guide](#en) |
-| Русский | [Открыть руководство](#ru) |
-| Português (Brasil) | [Abrir guia](#pt-br) |
-| Español | [Abrir guía](#es) |
-| Deutsch | [Anleitung öffnen](#de) |
-| Français | [Ouvrir le guide](#fr) |
-| Italiano | [Apri la guida](#it) |
-| Polski | [Otwórz instrukcję](#pl) |
-| 简体中文 | [打开指南](#zh-cn) |
-| 日本語 | [ガイドを開く](#ja) |
-| 한국어 | [가이드 열기](#ko) |
-
-## Download
-
-| Package | Download |
-|---|---|
-| **Latest ready-to-install build** | **[⬇️ Download Metamorph-Creative-Menu.zip](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/download/latest-build/Metamorph-Creative-Menu.zip)** |
-| Build page | [Latest ready-to-install build](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/tag/latest-build) |
-
-> The ZIP already contains the complete `metamorph_creative_menu` folder, including the bundled NoitaPatcher runtime. Extract that folder directly into `Noita/mods/`.
->
-> ZIP уже содержит готовую папку `metamorph_creative_menu`, включая встроенный NoitaPatcher. Её нужно распаковать прямо в `Noita/mods/`.
-
-Correct final path:
-
-```text
-Noita/mods/metamorph_creative_menu/mod.xml
-```
-
-If you end up with `metamorph_creative_menu/metamorph_creative_menu/mod.xml`, the archive was extracted one folder too deep.
-
----
-
-
+Creative tools for Noita by zerodancing.
-## English
+This branch contains the **Steam Workshop build** of Metamorph: Creative Menu. It is intentionally different from the full standalone GitHub build: native NoitaPatcher-powered recovery and other standalone-only native features are not shipped here.
-### Installation
+## Install
-1. [Download the latest ready-to-install ZIP](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/download/latest-build/Metamorph-Creative-Menu.zip).
-2. Close Noita before installing or updating the mod.
-3. On Steam, open **Library → right-click Noita → Manage → Browse local files**.
-4. Open the game's `mods` folder and copy the complete **`metamorph_creative_menu`** folder into it.
-5. Verify that `Noita/mods/metamorph_creative_menu/mod.xml` exists. Do not rename the mod folder.
-6. Start Noita, enable **Metamorph: Creative Menu**, allow **Unsafe mods / unrestricted API** when required, and restart Noita after enabling the mod.
-7. Start a run and press **TAB**. If the menu opens, installation is complete.
+Use the [Steam Workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=3785170245) to subscribe to this build. Steam manages the Workshop files; do not copy the standalone GitHub archive over the Workshop installation.
-**Updating:** close Noita, remove the old `metamorph_creative_menu` folder, then copy the new one into `mods`. Replacing the whole folder avoids stale files from older builds.
+After subscribing, enable **Metamorph: Creative Menu** in Noita and start a run. Press **TAB** to open or close the menu.
-### Controls
+## Main controls
- **TAB** — open or close the Creative Menu.
-- **TAB while transformed** — return to the human player form.
-- **G** by default — possess a supported creature under the cursor. The key can be changed in MCM settings.
-- Most catalog entries expose different **LMB/RMB** actions; the exact action is shown in the UI.
+- **TAB while transformed** — return to human form where the Workshop-safe path supports it.
+- **G** by default — possess a supported creature under the cursor; the binding can be changed in MCM settings.
+- Catalog entries may expose different **LMB/RMB** actions; the UI shows the active action.
-### What MCM can do
+## What this build includes
-- **Spells & wands** — search spells, replace a selected wand slot, delete a spell or drop it into the world.
-- **Items** — spawn supported items, containers, liquids, wands, books, quest objects and more; MCM can also attempt direct inventory placement.
-- **Perks** — spawn/apply perks and remove one or all tracked stacks while trying to restore only state owned by that perk.
-- **Effects** — apply supported timed/status effects, choose duration where supported and remove editor-owned effects.
-- **Creatures & forms** — spawn creatures or transform into supported creatures, objects and special forms.
-- **Human recovery** — normal TAB return uses the native polymorph lifecycle, with serialized NoitaPatcher recovery available for hard fallback paths.
-- **Death handoff** — supported transformed bodies can die while player authority is returned to the restored human body instead of immediately ending the run.
-- **Possession** — take over a supported existing creature under the cursor rather than simply spawning a duplicate.
-- **PLAYER companion** — spawn a player-like allied companion with copied presentation/inventory behavior and extended wand use when supported.
-- **Search** — large catalogs can be searched by localized names, IDs and descriptions depending on the editor.
-- **Weather** — control time of day, clouds, fog, wind, rain, lightning and presets; RELEASE stops MCM from holding the override.
-- **World Rules** — reversible overrides for creature relations, gold lifetime, spell uses, fog of war, trick-kill systems, healing drops, friendly rats, gore, damage flash, stain shedding, gravity, physics damping, blood volume, kick force, joint strength and day-cycle speed.
+The Workshop build keeps the normal creative editors and gameplay tools that work without the standalone native components, including supported spawning/editing for spells, wands, items, perks, effects, creatures/forms, weather and World Rules.
-
-Transformations, compatibility and recovery
+Some entities and recovery paths are inherently engine-sensitive. A feature that depends on the standalone native bridge may be unavailable or use a more limited safe fallback in this branch.
-MCM uses exact XML-path compatibility data and narrow safe-routing exceptions for entities that are known to be unsafe or unsuitable for direct native polymorph. Player-controlled forms try to retain useful native movement, attacks, visuals and physics while disabling AI that would fight player input. Complex bosses, scripted entities and physics objects can require dedicated adapters and may not reproduce every AI behavior exactly.
+## Standalone build
-NoitaPatcher is used for hard recovery capabilities such as entity serialization/deserialization, player handoff and other extended runtime functions. This is why the complete standalone build requests unrestricted/unsafe mod access.
+For the complete build, including the bundled NoitaPatcher runtime and native Game Over/recovery support, use the repository's ready-to-install GitHub release:
-
+- [Latest standalone release](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/tag/latest-build)
+- [Direct standalone ZIP](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/download/latest-build/Metamorph-Creative-Menu.zip)
-
-Entangled Worlds multiplayer integration
+Do **not** install the Workshop and standalone builds at the same time. They use the same mod identity and can conflict.
-**Entangled Worlds is optional.** MCM is designed to work as a complete standalone single-player mod without EW.
+## Entangled Worlds
-When `quant.ew` is enabled, MCM activates experimental integration for shared items, perks, weather, World Rules, forms/possession, companion requests and related authority/synchronization behavior. Use the same MCM version on every peer. Multiplayer support is intentionally considered experimental because not every Noita/EW edge case can be guaranteed to synchronize perfectly.
+Entangled Worlds integration is optional and experimental. When using multiplayer, keep MCM versions compatible between peers and expect some Noita/EW edge cases to remain engine-dependent.
-
+## Reporting problems
-### Requirements & third-party components
+When reporting a bug, specify that you are using the **Steam Workshop build**, describe the action that failed, and include the exact creature/item/effect or XML path when relevant.
-- **Noita** — required game, by Nolla Games.
-- **NoitaPatcher** by dextercd — bundled with MCM and used for extended runtime/recovery functionality.
-- **lbase64** by Ilya Kolbin — bundled local Base64 implementation.
-- **Entangled Worlds / Noita Proxy** by IntQuant and contributors — optional multiplayer integration; not required for single player.
-
-Exact upstream links, bundled paths and third-party license/status notes are in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
-
-### Troubleshooting
-
-- **TAB does nothing:** verify the exact `mod.xml` path, make sure MCM is enabled, allow Unsafe mods/unrestricted API, then restart Noita.
-- **Extended recovery or World Rules functionality is missing:** verify `metamorph_creative_menu/NoitaPatcher/noitapatcher.dll` is present and unrestricted API access is allowed.
-- **A form fails to return correctly:** report the exact creature name/XML and whether normal TAB return or fatal-death return failed.
-- **EW mismatch/desync:** verify that every peer uses the same MCM build and a compatible EW build.
-
-### Links
-
-- [Latest build](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/tag/latest-build)
-- [Report a bug](https://github.com/zerodancing/Metamorph-Creative-Menu/issues)
-- [Third-party notices](THIRD_PARTY_NOTICES.md)
-- [Noita](https://noitagame.com/)
-- [NoitaPatcher](https://github.com/dextercd/NoitaPatcher)
-- [NoitaPatcher documentation](https://dexter.döpping.eu/NoitaPatcher/)
-- [Entangled Worlds](https://github.com/IntQuant/noita_entangled_worlds)
-- [lbase64](https://github.com/iskolbin/lbase64)
-
-[↑ Back to language selection](#languages)
+Issues: https://github.com/zerodancing/Metamorph-Creative-Menu/issues
---
-
-
## Русский
+Эта ветка содержит **Steam Workshop-сборку** Metamorph: Creative Menu. Она специально отличается от полной standalone-сборки GitHub: сюда не входят нативные возможности, завязанные на встроенный NoitaPatcher, включая расширенные standalone-only сценарии восстановления.
+
### Установка
-1. [Скачайте готовый ZIP последней сборки](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/download/latest-build/Metamorph-Creative-Menu.zip).
-2. Полностью закройте Noita перед установкой или обновлением.
-3. В Steam откройте **Библиотека → ПКМ по Noita → Управление → Просмотреть локальные файлы**.
-4. Откройте папку `mods` и скопируйте туда целиком папку **`metamorph_creative_menu`** из архива.
-5. Проверьте, что существует файл `Noita/mods/metamorph_creative_menu/mod.xml`. Папку мода не переименовывайте.
-6. Запустите Noita, включите **Metamorph: Creative Menu**, разрешите **Unsafe mods / unrestricted API**, если игра этого требует, и перезапустите Noita после включения мода.
-7. Начните забег и нажмите **TAB**. Если меню открылось — установка закончена.
+Подпишитесь на мод на [странице Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=3785170245). Файлы Workshop устанавливает Steam; не копируйте поверх них standalone-архив GitHub.
-**Обновление:** закройте Noita, удалите старую папку `metamorph_creative_menu` и скопируйте новую. Полная замена папки не оставляет устаревшие файлы предыдущих версий.
+Включите **Metamorph: Creative Menu** в Noita, начните забег и нажмите **TAB**.
### Управление
- **TAB** — открыть или закрыть Creative Menu.
-- **TAB во время превращения** — вернуться в человеческую форму.
-- **G** по умолчанию — занять тело поддерживаемого существа под курсором. Клавиша меняется в настройках MCM.
-- У большинства элементов каталога **ЛКМ/ПКМ** выполняют разные действия; точная подсказка показывается в интерфейсе.
-
-### Возможности MCM
-
-- **Заклинания и посохи** — поиск заклинаний, замена выбранного слота, удаление или выбрасывание заклинания в мир.
-- **Предметы** — создание предметов, контейнеров, жидкостей, посохов, книг, квестовых объектов и других поддерживаемых сущностей; возможна попытка сразу положить предмет в инвентарь.
-- **Перки** — создание/применение перков и удаление одного или всех отслеживаемых уровней с восстановлением принадлежащего перку состояния.
-- **Эффекты** — применение status/timed effects, выбор длительности и удаление состояния, созданного редактором.
-- **Существа и формы** — создание мобов и превращение в поддерживаемых существ, объекты и специальные формы.
-- **Возврат человека** — обычный TAB использует нативный lifecycle polymorph, а для аварийных сценариев доступно сериализованное восстановление через NoitaPatcher.
-- **Death handoff** — смерть поддерживаемой формы может вернуть player authority восстановленному человеку вместо немедленного Game Over.
-- **Possession** — занятие тела уже существующего поддерживаемого моба под курсором, а не простое создание копии.
-- **Союзник PLAYER** — создание союзника, похожего на игрока, с копированием визуального/инвентарного состояния и расширенным использованием посоха при доступных возможностях runtime.
-- **Поиск** — крупные каталоги ищут по локализованным именам, ID и описаниям в зависимости от вкладки.
-- **Погода** — время суток, облака, туман, ветер, дождь, молнии и пресеты; RELEASE прекращает активное удержание погодных значений.
-- **World Rules** — обратимые правила для отношений существ, времени жизни золота, использования заклинаний, fog of war, trick-kill механик, healing drops, friendly rats, gore, damage flash, stain shedding, гравитации, физического damping, объёма крови, силы пинка, прочности соединений и скорости цикла дня.
-
-
-Превращения, совместимость и восстановление
-
-MCM хранит совместимость по точным XML-путям и использует узкие safe-routing исключения для сущностей, которые опасно или бессмысленно превращать напрямую нативным polymorph. Управляемая игроком форма старается сохранить полезное движение, атаки, внешний вид и физику, отключая конфликтующий AI. Для сложных боссов, scripted-сущностей и physics-объектов могут использоваться отдельные адаптеры.
-
-NoitaPatcher нужен для жёстких recovery-сценариев: сериализации/десериализации сущностей, player handoff и других расширенных runtime-возможностей. Поэтому полная standalone-сборка использует unrestricted/unsafe mod access.
-
-
-
-
-Интеграция с Entangled Worlds
-
-**Entangled Worlds не обязателен.** В одиночной игре MCM является полноценным standalone-модом.
-
-При включённом `quant.ew` активируется экспериментальная синхронизация предметов, перков, погоды, World Rules, форм/possession, запросов companion и связанных authority-механизмов. На всех клиентах должна быть одна и та же версия MCM. Сетевая интеграция считается экспериментальной, потому что не все edge cases Noita/EW можно гарантированно синхронизировать.
-
-
-
-### Требования и сторонние компоненты
-
-- **Noita** — обязательная игра, Nolla Games.
-- **NoitaPatcher** от dextercd — включён в MCM и используется для расширенного runtime и recovery.
-- **lbase64** от Ilya Kolbin — локальная встроенная реализация Base64.
-- **Entangled Worlds / Noita Proxy** от IntQuant и contributors — опциональная мультиплеерная интеграция, для одиночной игры не нужна.
-
-Точные upstream-ссылки, пути встроенных компонентов и сведения об их лицензиях/статусе находятся в [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
-
-### Если что-то не работает
-
-- **TAB ничего не делает:** проверьте путь к `mod.xml`, включение MCM, Unsafe mods/unrestricted API и перезапустите Noita.
-- **Нет расширенного recovery или части World Rules:** проверьте наличие `metamorph_creative_menu/NoitaPatcher/noitapatcher.dll` и доступ к unrestricted API.
-- **Форма не возвращается правильно:** укажите точное имя/XML существа и уточните, сломался обычный возврат по TAB или возврат после смертельного урона.
-- **EW desync:** убедитесь, что у всех участников одинаковая сборка MCM и совместимая версия EW.
-
-### Ссылки
-
-- [Последняя готовая сборка](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/tag/latest-build)
-- [Сообщить об ошибке](https://github.com/zerodancing/Metamorph-Creative-Menu/issues)
-- [Сторонние компоненты](THIRD_PARTY_NOTICES.md)
-- [Noita](https://noitagame.com/)
-- [NoitaPatcher](https://github.com/dextercd/NoitaPatcher)
-- [Документация NoitaPatcher](https://dexter.döpping.eu/NoitaPatcher/)
-- [Entangled Worlds](https://github.com/IntQuant/noita_entangled_worlds)
-- [lbase64](https://github.com/iskolbin/lbase64)
-
-[↑ К выбору языка](#languages)
-
----
-
-
-
-## Português (Brasil)
-
-### Instalação
-
-1. [Baixe o ZIP pronto para instalar](https://github.com/zerodancing/Metamorph-Creative-Menu/releases/download/latest-build/Metamorph-Creative-Menu.zip).
-2. Feche o Noita antes de instalar ou atualizar o mod.
-3. No Steam: **Biblioteca → clique direito em Noita → Gerenciar → Explorar arquivos locais**.
-4. Abra a pasta `mods` e copie para ela a pasta completa **`metamorph_creative_menu`**.
-5. Confirme que existe `Noita/mods/metamorph_creative_menu/mod.xml`.
-6. Inicie o Noita, ative **Metamorph: Creative Menu**, permita **Unsafe mods / unrestricted API** quando necessário e reinicie o jogo.
-7. Entre em uma partida e pressione **TAB**.
-
-### Controles
-
-- **TAB** — abre/fecha o menu; durante uma transformação, retorna à forma humana.
-- **G** por padrão — possui uma criatura compatível sob o cursor; a tecla pode ser alterada nas configurações.
-- **LMB/RMB** — ações diferentes dependendo do item do catálogo; a interface mostra a ação exata.
-
-### Recursos
-
-MCM permite editar **magias e varinhas**, criar **itens e líquidos**, aplicar/remover **perks e efeitos**, criar criaturas, **transformar-se**, possuir criaturas existentes, recuperar a forma humana, fazer **death handoff**, criar um aliado `PLAYER`, pesquisar grandes catálogos, controlar **clima** e aplicar **World Rules reversíveis** para relações entre criaturas, ouro, usos de magia, fog of war, trick kills, drops de cura, gore, gravidade, física, sangue, força de chute, juntas e ciclo do dia.
-
-Standalone, recuperação e Entangled Worlds
-
-O modo single-player não exige Entangled Worlds. O MCM inclui NoitaPatcher para serialização/recuperação, player handoff e outras funções avançadas; por isso a versão completa requer acesso Unsafe/unrestricted. Com `quant.ew` ativo, o MCM habilita integração multiplayer experimental para itens, perks, clima, World Rules, formas/possession e companion. Todos os peers devem usar a mesma versão do MCM.
-
-Standalone, recuperación y Entangled Worlds
-
-Entangled Worlds no es necesario para un jugador. MCM incluye NoitaPatcher para serialización/recuperación, player handoff y funciones avanzadas, por lo que la versión completa requiere acceso Unsafe/unrestricted. Con `quant.ew` activo se habilita una integración multijugador experimental para objetos, perks, clima, World Rules, formas/possession y companion. Todos los peers deben usar la misma versión de MCM.
-
-Standalone, Recovery und Entangled Worlds
-
-Entangled Worlds ist für Singleplayer nicht erforderlich. MCM enthält NoitaPatcher für Serialisierung/Recovery, Player Handoff und weitere erweiterte Funktionen; deshalb benötigt die Vollversion Unsafe/unrestricted API. Mit aktivem `quant.ew` wird eine experimentelle Multiplayer-Integration für Items, Perks, Wetter, World Rules, Formen/Possession und Companion aktiviert. Alle Peers sollten dieselbe MCM-Version verwenden.
-
-Standalone, récupération et Entangled Worlds
+Функции, которым нужен standalone native bridge, в этой ветке могут быть недоступны или использовать более ограниченный безопасный fallback.
-Entangled Worlds n'est pas requis en solo. MCM inclut NoitaPatcher pour la sérialisation/récupération, le player handoff et d'autres fonctions avancées ; la version complète nécessite donc Unsafe/unrestricted API. Avec `quant.ew`, une intégration multijoueur expérimentale est activée pour objets, perks, météo, World Rules, formes/possession et companion. Tous les peers doivent utiliser la même version de MCM.
-
-Standalone, recovery ed Entangled Worlds
-
-Entangled Worlds non è necessario in single-player. MCM include NoitaPatcher per serializzazione/recovery, player handoff e altre funzioni avanzate; per questo la versione completa richiede Unsafe/unrestricted API. Con `quant.ew` attivo viene abilitata un'integrazione multiplayer sperimentale per oggetti, perk, meteo, World Rules, forme/possession e companion. Tutti i peer devono usare la stessa versione di MCM.
-
-Standalone, recovery i Entangled Worlds
-
-Entangled Worlds nie jest wymagany w single-player. MCM zawiera NoitaPatcher do serializacji/recovery, player handoff i innych zaawansowanych funkcji, dlatego pełna wersja wymaga Unsafe/unrestricted API. Przy aktywnym `quant.ew` włącza się eksperymentalna integracja multiplayer dla przedmiotów, perków, pogody, World Rules, form/possession i companion. Wszyscy gracze powinni używać tej samej wersji MCM.
-
-独立模式、恢复与 Entangled Worlds
-
-单人模式不需要 Entangled Worlds。MCM 内置 NoitaPatcher，用于实体序列化/恢复、player handoff 和其他高级功能，因此完整版本需要 Unsafe/unrestricted API。启用 `quant.ew` 后，会开启针对物品、Perk、天气、World Rules、形态/附身和 companion 的实验性多人同步。所有玩家应使用相同版本的 MCM。
-
-Standalone、Recovery、Entangled Worlds
-
-シングルプレイヤーでは Entangled Worlds は不要です。MCM には NoitaPatcher が同梱され、シリアライズ/復元、player handoff、その他の高度な機能に使われるため、完全版では Unsafe/unrestricted API が必要です。`quant.ew` が有効な場合、アイテム・Perk・天候・World Rules・形態/possession・companion の実験的マルチプレイヤー統合が有効になります。全 peer で同じ MCM バージョンを使用してください。
-
-Standalone, 복구 및 Entangled Worlds
-
-싱글플레이에서는 Entangled Worlds가 필요하지 않습니다. MCM에는 직렬화/복구, player handoff 및 기타 고급 기능을 위한 NoitaPatcher가 포함되어 있어 전체 버전은 Unsafe/unrestricted API가 필요합니다. `quant.ew`가 활성화되면 아이템, Perk, 날씨, World Rules, 형태/possession, companion에 대한 실험적 멀티플레이 통합이 활성화됩니다. 모든 peer는 동일한 MCM 버전을 사용해야 합니다.
-
-