From 8d8fda49c414a24739af69139ec285d5f489c347 Mon Sep 17 00:00:00 2001 From: Marvin <52848568+mleem97@users.noreply.github.com> Date: Fri, 10 Apr 2026 02:12:06 +0200 Subject: [PATCH] docs(readme): update README for clarity and consistency - Translated sections from German to English for better accessibility. - Enhanced the structure by clearly defining the workspace relationship and local development instructions. - Improved descriptions for Docker setup and deployment processes to ensure users understand the requirements and context. - Updated links and formatting for consistency throughout the document. This commit aims to improve the overall clarity and usability of the README documentation. --- README.md | 61 ++++---- docs/contributors/repo-inventory.md | 2 +- docs/guides/contributors/topics-overview.md | 2 +- docs/guides/mod-developers/overview.md | 10 +- docs/guides/players/audiences-overview.md | 11 +- docs/guides/players/overview.md | 7 +- docs/guides/sponsors/overview.md | 13 +- docs/intro.md | 8 +- docs/legacy/index.md | 12 -- docs/legacy/wiki-import/AI-USAGE.md | 9 -- docs/legacy/wiki-import/Architecture.md | 9 -- docs/legacy/wiki-import/AssetExport.md | 9 -- .../Bekannte-Inkompatibilitaeten.md | 9 -- docs/legacy/wiki-import/Brief-an-WASEKU.md | 9 -- .../legacy/wiki-import/Changelog-Versionen.md | 9 -- docs/legacy/wiki-import/Changelog-Versions.md | 9 -- docs/legacy/wiki-import/Community-Thanks.md | 9 -- .../Contirbutors/Contributors-Debug.md | 9 -- .../wiki-import/Contirbutors/_category_.json | 4 - docs/legacy/wiki-import/Contributors-Debug.md | 9 -- .../Contributors/Contributors-Debug.md | 9 -- .../Guides/Contribution-Workflow.md | 9 -- .../wiki-import/Contributors/Guides/Index.md | 9 -- .../Contributors/Guides/_category_.json | 3 - docs/legacy/wiki-import/Contributors/Index.md | 9 -- .../Contributors/Reference/Index.md | 9 -- .../Reference/Naming-Convention.md | 9 -- .../Contributors/Reference/_category_.json | 3 - .../Contributors/Troubleshooting/Index.md | 9 -- .../Troubleshooting/_category_.json | 3 - .../Contributors/Troubleshooting/overview.md | 9 -- .../wiki-import/Contributors/_category_.json | 4 - .../legacy/wiki-import/DataCenterFAQ/Index.md | 9 -- .../wiki-import/DataCenterFAQ/Part-1.md | 9 -- .../wiki-import/DataCenterFAQ/Part-2.md | 9 -- .../wiki-import/DataCenterFAQ/Part-3.md | 9 -- .../wiki-import/DataCenterFAQ/Patch-Panel.md | 9 -- .../wiki-import/DataCenterFAQ/_category_.json | 4 - docs/legacy/wiki-import/Device-Reference.md | 9 -- docs/legacy/wiki-import/End-User-Release.md | 9 -- .../wiki-import/EndUser/End-User-Release.md | 9 -- .../EndUser/Guides/Framework-Dependency.md | 9 -- .../wiki-import/EndUser/Guides/Index.md | 9 -- .../EndUser/Guides/_category_.json | 3 - docs/legacy/wiki-import/EndUser/Index.md | 9 -- .../EndUser/Reference/Disclaimer.md | 9 -- .../wiki-import/EndUser/Reference/Index.md | 9 -- .../EndUser/Reference/_category_.json | 3 - .../EndUser/Troubleshooting/FAQ.md | 9 -- .../EndUser/Troubleshooting/Index.md | 9 -- .../EndUser/Troubleshooting/_category_.json | 3 - .../EndUser/Troubleshooting/overview.md | 9 -- .../wiki-import/EndUser/_category_.json | 4 - .../wiki-import/FFI-Bridge-Reference.md | 9 -- .../Framework-Features-Use-Cases.md | 9 -- docs/legacy/wiki-import/Glossar.md | 9 -- docs/legacy/wiki-import/Glossary.md | 9 -- .../wiki-import/HOOK-NAMING-CONVENTION.md | 9 -- docs/legacy/wiki-import/HOOKS.md | 9 -- docs/legacy/wiki-import/Home.md | 9 -- .../wiki-import/Known-Incompatibilities.md | 9 -- docs/legacy/wiki-import/Letter-to-WASEKU.md | 9 -- docs/legacy/wiki-import/License-Legal.md | 9 -- docs/legacy/wiki-import/Lizenz-Rechtliches.md | 9 -- .../wiki-import/Lua-FFI-Start-Developing.md | 9 -- .../wiki-import/MODIAPI_FINAL_STATUS.md | 9 -- .../MODIAPI_INTEGRATION_SUMMARY.md | 9 -- docs/legacy/wiki-import/MelonLoader.md | 9 -- docs/legacy/wiki-import/Mod-Config-System.md | 9 -- .../legacy/wiki-import/Mod-Developer-Debug.md | 9 -- .../ModDevs/Guides/Getting-Started.md | 9 -- .../wiki-import/ModDevs/Guides/Index.md | 9 -- .../ModDevs/Guides/_category_.json | 3 - docs/legacy/wiki-import/ModDevs/Index.md | 9 -- .../ModDevs/Mod-Developer-Debug.md | 9 -- .../wiki-import/ModDevs/Modding-Guide.md | 9 -- .../ModDevs/Reference/Hook-Event-Reference.md | 9 -- .../wiki-import/ModDevs/Reference/Index.md | 9 -- .../ModDevs/Reference/_category_.json | 3 - .../ModDevs/Troubleshooting/Index.md | 9 -- .../ModDevs/Troubleshooting/_category_.json | 3 - .../ModDevs/Troubleshooting/overview.md | 9 -- .../wiki-import/ModDevs/_category_.json | 4 - docs/legacy/wiki-import/Modding-Guide.md | 9 -- .../wiki-import/ModigAPI-Consolidation.md | 9 -- docs/legacy/wiki-import/README.md | 58 -------- docs/legacy/wiki-import/README_MODDING.md | 9 -- docs/legacy/wiki-import/ROADMAP.md | 9 -- .../Release-Assets-and-Templates.md | 9 -- .../wiki-import/Repos/mleem97/_category_.json | 6 - .../Repository-Status-2026-04-04.md | 9 -- docs/legacy/wiki-import/Setup.md | 9 -- docs/legacy/wiki-import/Sponsoren.md | 9 -- docs/legacy/wiki-import/Sponsors.md | 9 -- docs/legacy/wiki-import/StandaloneMods.md | 9 -- .../Steamworks-P2P-Multiplayer-Roadmap.md | 9 -- docs/legacy/wiki-import/TASKLIST.md | 9 -- .../TechnicalReference/Guides/Index.md | 9 -- .../TechnicalReference/Guides/_category_.json | 3 - .../wiki-import/TechnicalReference/Index.md | 9 -- .../TechnicalReference/Reference/Index.md | 9 -- .../Reference/_category_.json | 3 - .../Troubleshooting/Index.md | 9 -- .../Troubleshooting/_category_.json | 3 - .../TechnicalReference/_category_.json | 4 - docs/legacy/wiki-import/WIKI-MOVED.md | 9 -- docs/legacy/wiki-import/Web-UI-Bridge.md | 9 -- docs/legacy/wiki-import/_Sidebar.md | 9 -- docs/legacy/wiki-import/ui.md | 9 -- docs/mods/framework.md | 8 +- docs/plugins/index.md | 2 +- docs/reference/fmf-hook-naming.md | 2 +- docs/topics/assets-and-export/overview.md | 8 +- docs/topics/ffi-and-hooks/overview.md | 12 +- docs/topics/index.md | 3 +- docs/topics/meta/game-folder-layout.md | 2 +- .../multiplayer-and-networking/overview.md | 12 +- docs/topics/roadmap/overview.md | 4 +- docs/topics/security-legal/overview.md | 13 +- docs/topics/wiki-import/overview.md | 52 ------- docusaurus.config.js | 26 +++- .../current/intro.md | 8 +- .../current/legacy/wiki-import/AI-USAGE.md | 9 -- .../legacy/wiki-import/Architecture.md | 9 -- .../current/legacy/wiki-import/AssetExport.md | 9 -- .../Bekannte-Inkompatibilitaeten.md | 9 -- .../legacy/wiki-import/Brief-an-WASEKU.md | 9 -- .../legacy/wiki-import/Changelog-Versionen.md | 9 -- .../legacy/wiki-import/Changelog-Versions.md | 45 ------ .../legacy/wiki-import/Community-Thanks.md | 9 -- .../Contirbutors/Contributors-Debug.md | 99 ------------- .../wiki-import/Contirbutors/_category_.json | 5 - .../legacy/wiki-import/Contributors-Debug.md | 5 - .../Contributors/Contributors-Debug.md | 99 ------------- .../Guides/Contribution-Workflow.md | 9 -- .../wiki-import/Contributors/Guides/Index.md | 3 - .../Contributors/Guides/_category_.json | 3 - .../legacy/wiki-import/Contributors/Index.md | 10 -- .../Contributors/Reference/Index.md | 3 - .../Reference/Naming-Convention.md | 12 -- .../Contributors/Reference/_category_.json | 3 - .../Contributors/Troubleshooting/Index.md | 3 - .../Troubleshooting/_category_.json | 3 - .../Contributors/Troubleshooting/overview.md | 12 -- .../wiki-import/Contributors/_category_.json | 5 - .../legacy/wiki-import/DataCenterFAQ/Index.md | 9 -- .../wiki-import/DataCenterFAQ/Part-1.md | 9 -- .../wiki-import/DataCenterFAQ/Part-2.md | 9 -- .../wiki-import/DataCenterFAQ/Part-3.md | 9 -- .../wiki-import/DataCenterFAQ/Patch-Panel.md | 9 -- .../wiki-import/DataCenterFAQ/_category_.json | 5 - .../legacy/wiki-import/Device-Reference.md | 9 -- .../legacy/wiki-import/End-User-Release.md | 5 - .../wiki-import/EndUser/End-User-Release.md | 79 ----------- .../EndUser/Guides/Framework-Dependency.md | 17 --- .../wiki-import/EndUser/Guides/Index.md | 3 - .../EndUser/Guides/_category_.json | 3 - .../legacy/wiki-import/EndUser/Index.md | 11 -- .../EndUser/Reference/Disclaimer.md | 11 -- .../wiki-import/EndUser/Reference/Index.md | 3 - .../EndUser/Reference/_category_.json | 3 - .../EndUser/Troubleshooting/FAQ.md | 13 -- .../EndUser/Troubleshooting/Index.md | 4 - .../EndUser/Troubleshooting/_category_.json | 3 - .../EndUser/Troubleshooting/overview.md | 13 -- .../wiki-import/EndUser/_category_.json | 5 - .../wiki-import/FFI-Bridge-Reference.md | 9 -- .../Framework-Features-Use-Cases.md | 7 - .../current/legacy/wiki-import/Glossar.md | 9 -- .../current/legacy/wiki-import/Glossary.md | 58 -------- .../wiki-import/HOOK-NAMING-CONVENTION.md | 9 -- .../current/legacy/wiki-import/HOOKS.md | 9 -- .../current/legacy/wiki-import/Home.md | 2 - .../wiki-import/Known-Incompatibilities.md | 56 -------- .../legacy/wiki-import/Letter-to-WASEKU.md | 59 -------- .../legacy/wiki-import/License-Legal.md | 51 ------- .../legacy/wiki-import/Lizenz-Rechtliches.md | 9 -- .../wiki-import/Lua-FFI-Start-Developing.md | 9 -- .../wiki-import/MODIAPI_FINAL_STATUS.md | 9 -- .../MODIAPI_INTEGRATION_SUMMARY.md | 9 -- .../current/legacy/wiki-import/MelonLoader.md | 9 -- .../legacy/wiki-import/Mod-Config-System.md | 9 -- .../legacy/wiki-import/Mod-Developer-Debug.md | 5 - .../ModDevs/Guides/Getting-Started.md | 13 -- .../wiki-import/ModDevs/Guides/Index.md | 3 - .../ModDevs/Guides/_category_.json | 3 - .../legacy/wiki-import/ModDevs/Index.md | 10 -- .../ModDevs/Mod-Developer-Debug.md | 132 ------------------ .../wiki-import/ModDevs/Modding-Guide.md | 8 -- .../ModDevs/Reference/Hook-Event-Reference.md | 10 -- .../wiki-import/ModDevs/Reference/Index.md | 3 - .../ModDevs/Reference/_category_.json | 3 - .../ModDevs/Troubleshooting/Index.md | 3 - .../ModDevs/Troubleshooting/_category_.json | 3 - .../ModDevs/Troubleshooting/overview.md | 7 - .../wiki-import/ModDevs/_category_.json | 5 - .../legacy/wiki-import/Modding-Guide.md | 5 - .../wiki-import/ModigAPI-Consolidation.md | 9 -- .../legacy/wiki-import/README_MODDING.md | 9 -- .../current/legacy/wiki-import/ROADMAP.md | 9 -- .../Release-Assets-and-Templates.md | 9 -- .../Repository-Status-2026-04-04.md | 9 -- .../current/legacy/wiki-import/Setup.md | 9 -- .../current/legacy/wiki-import/Sponsoren.md | 9 -- .../current/legacy/wiki-import/Sponsors.md | 49 ------- .../legacy/wiki-import/StandaloneMods.md | 9 -- .../Steamworks-P2P-Multiplayer-Roadmap.md | 9 -- .../current/legacy/wiki-import/TASKLIST.md | 9 -- .../TechnicalReference/Guides/Index.md | 4 - .../TechnicalReference/Guides/_category_.json | 3 - .../wiki-import/TechnicalReference/Index.md | 11 -- .../TechnicalReference/Reference/Index.md | 5 - .../Reference/_category_.json | 3 - .../Troubleshooting/Index.md | 3 - .../Troubleshooting/_category_.json | 3 - .../TechnicalReference/_category_.json | 5 - .../current/legacy/wiki-import/WIKI-MOVED.md | 1 - .../legacy/wiki-import/Web-UI-Bridge.md | 89 ------------ .../current/legacy/wiki-import/_Sidebar.md | 1 - .../current/legacy/wiki-import/ui.md | 9 -- sidebars.js | 13 -- src/css/custom.css | 93 ++++++------ src/i18n/homepage/sharedLinks.ts | 8 +- src/theme/Footer/LinkItem/index.tsx | 63 +++++++++ .../LocaleDropdownNavbarItem/index.tsx | 132 ++++++++++++++++++ .../styles.module.css | 20 +++ src/theme/NavbarItem/NavbarNavLink.tsx | 117 ++++++++++++++++ 227 files changed, 498 insertions(+), 2496 deletions(-) delete mode 100644 docs/legacy/index.md delete mode 100644 docs/legacy/wiki-import/AI-USAGE.md delete mode 100644 docs/legacy/wiki-import/Architecture.md delete mode 100644 docs/legacy/wiki-import/AssetExport.md delete mode 100644 docs/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md delete mode 100644 docs/legacy/wiki-import/Brief-an-WASEKU.md delete mode 100644 docs/legacy/wiki-import/Changelog-Versionen.md delete mode 100644 docs/legacy/wiki-import/Changelog-Versions.md delete mode 100644 docs/legacy/wiki-import/Community-Thanks.md delete mode 100644 docs/legacy/wiki-import/Contirbutors/Contributors-Debug.md delete mode 100644 docs/legacy/wiki-import/Contirbutors/_category_.json delete mode 100644 docs/legacy/wiki-import/Contributors-Debug.md delete mode 100644 docs/legacy/wiki-import/Contributors/Contributors-Debug.md delete mode 100644 docs/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md delete mode 100644 docs/legacy/wiki-import/Contributors/Guides/Index.md delete mode 100644 docs/legacy/wiki-import/Contributors/Guides/_category_.json delete mode 100644 docs/legacy/wiki-import/Contributors/Index.md delete mode 100644 docs/legacy/wiki-import/Contributors/Reference/Index.md delete mode 100644 docs/legacy/wiki-import/Contributors/Reference/Naming-Convention.md delete mode 100644 docs/legacy/wiki-import/Contributors/Reference/_category_.json delete mode 100644 docs/legacy/wiki-import/Contributors/Troubleshooting/Index.md delete mode 100644 docs/legacy/wiki-import/Contributors/Troubleshooting/_category_.json delete mode 100644 docs/legacy/wiki-import/Contributors/Troubleshooting/overview.md delete mode 100644 docs/legacy/wiki-import/Contributors/_category_.json delete mode 100644 docs/legacy/wiki-import/DataCenterFAQ/Index.md delete mode 100644 docs/legacy/wiki-import/DataCenterFAQ/Part-1.md delete mode 100644 docs/legacy/wiki-import/DataCenterFAQ/Part-2.md delete mode 100644 docs/legacy/wiki-import/DataCenterFAQ/Part-3.md delete mode 100644 docs/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md delete mode 100644 docs/legacy/wiki-import/DataCenterFAQ/_category_.json delete mode 100644 docs/legacy/wiki-import/Device-Reference.md delete mode 100644 docs/legacy/wiki-import/End-User-Release.md delete mode 100644 docs/legacy/wiki-import/EndUser/End-User-Release.md delete mode 100644 docs/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md delete mode 100644 docs/legacy/wiki-import/EndUser/Guides/Index.md delete mode 100644 docs/legacy/wiki-import/EndUser/Guides/_category_.json delete mode 100644 docs/legacy/wiki-import/EndUser/Index.md delete mode 100644 docs/legacy/wiki-import/EndUser/Reference/Disclaimer.md delete mode 100644 docs/legacy/wiki-import/EndUser/Reference/Index.md delete mode 100644 docs/legacy/wiki-import/EndUser/Reference/_category_.json delete mode 100644 docs/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md delete mode 100644 docs/legacy/wiki-import/EndUser/Troubleshooting/Index.md delete mode 100644 docs/legacy/wiki-import/EndUser/Troubleshooting/_category_.json delete mode 100644 docs/legacy/wiki-import/EndUser/Troubleshooting/overview.md delete mode 100644 docs/legacy/wiki-import/EndUser/_category_.json delete mode 100644 docs/legacy/wiki-import/FFI-Bridge-Reference.md delete mode 100644 docs/legacy/wiki-import/Framework-Features-Use-Cases.md delete mode 100644 docs/legacy/wiki-import/Glossar.md delete mode 100644 docs/legacy/wiki-import/Glossary.md delete mode 100644 docs/legacy/wiki-import/HOOK-NAMING-CONVENTION.md delete mode 100644 docs/legacy/wiki-import/HOOKS.md delete mode 100644 docs/legacy/wiki-import/Home.md delete mode 100644 docs/legacy/wiki-import/Known-Incompatibilities.md delete mode 100644 docs/legacy/wiki-import/Letter-to-WASEKU.md delete mode 100644 docs/legacy/wiki-import/License-Legal.md delete mode 100644 docs/legacy/wiki-import/Lizenz-Rechtliches.md delete mode 100644 docs/legacy/wiki-import/Lua-FFI-Start-Developing.md delete mode 100644 docs/legacy/wiki-import/MODIAPI_FINAL_STATUS.md delete mode 100644 docs/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md delete mode 100644 docs/legacy/wiki-import/MelonLoader.md delete mode 100644 docs/legacy/wiki-import/Mod-Config-System.md delete mode 100644 docs/legacy/wiki-import/Mod-Developer-Debug.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Guides/Getting-Started.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Guides/Index.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Guides/_category_.json delete mode 100644 docs/legacy/wiki-import/ModDevs/Index.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Modding-Guide.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Reference/Index.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Reference/_category_.json delete mode 100644 docs/legacy/wiki-import/ModDevs/Troubleshooting/Index.md delete mode 100644 docs/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json delete mode 100644 docs/legacy/wiki-import/ModDevs/Troubleshooting/overview.md delete mode 100644 docs/legacy/wiki-import/ModDevs/_category_.json delete mode 100644 docs/legacy/wiki-import/Modding-Guide.md delete mode 100644 docs/legacy/wiki-import/ModigAPI-Consolidation.md delete mode 100644 docs/legacy/wiki-import/README.md delete mode 100644 docs/legacy/wiki-import/README_MODDING.md delete mode 100644 docs/legacy/wiki-import/ROADMAP.md delete mode 100644 docs/legacy/wiki-import/Release-Assets-and-Templates.md delete mode 100644 docs/legacy/wiki-import/Repos/mleem97/_category_.json delete mode 100644 docs/legacy/wiki-import/Repository-Status-2026-04-04.md delete mode 100644 docs/legacy/wiki-import/Setup.md delete mode 100644 docs/legacy/wiki-import/Sponsoren.md delete mode 100644 docs/legacy/wiki-import/Sponsors.md delete mode 100644 docs/legacy/wiki-import/StandaloneMods.md delete mode 100644 docs/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md delete mode 100644 docs/legacy/wiki-import/TASKLIST.md delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Guides/Index.md delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Guides/_category_.json delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Index.md delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Reference/Index.md delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Reference/_category_.json delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md delete mode 100644 docs/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json delete mode 100644 docs/legacy/wiki-import/TechnicalReference/_category_.json delete mode 100644 docs/legacy/wiki-import/WIKI-MOVED.md delete mode 100644 docs/legacy/wiki-import/Web-UI-Bridge.md delete mode 100644 docs/legacy/wiki-import/_Sidebar.md delete mode 100644 docs/legacy/wiki-import/ui.md delete mode 100644 docs/topics/wiki-import/overview.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AI-USAGE.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Architecture.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AssetExport.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Brief-an-WASEKU.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versionen.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versions.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Community-Thanks.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/Contributors-Debug.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors-Debug.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Contributors-Debug.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Naming-Convention.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/overview.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-1.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-2.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-3.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Device-Reference.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/End-User-Release.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/End-User-Release.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Disclaimer.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/overview.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/FFI-Bridge-Reference.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Framework-Features-Use-Cases.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossar.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossary.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOK-NAMING-CONVENTION.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOKS.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Home.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Known-Incompatibilities.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Letter-to-WASEKU.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/License-Legal.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lizenz-Rechtliches.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lua-FFI-Start-Developing.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_FINAL_STATUS.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MelonLoader.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Config-System.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Developer-Debug.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Getting-Started.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Modding-Guide.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/overview.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Modding-Guide.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModigAPI-Consolidation.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/README_MODDING.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ROADMAP.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Release-Assets-and-Templates.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Repository-Status-2026-04-04.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Setup.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsoren.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsors.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/StandaloneMods.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TASKLIST.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/_category_.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/WIKI-MOVED.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Web-UI-Bridge.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/_Sidebar.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ui.md create mode 100644 src/theme/Footer/LinkItem/index.tsx create mode 100644 src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx create mode 100644 src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css create mode 100644 src/theme/NavbarItem/NavbarNavLink.tsx diff --git a/README.md b/README.md index fe1007d..d2749bf 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,74 @@ # gregWiki -Docusaurus-Site für **gregFramework** / Data-Center-Modding: `docusaurus.config.js`, `sidebars.js`, React unter `src/`, Inhalte unter [`docs/`](./docs/). Öffentliche Route-Basis: **`/wiki`**. +Docusaurus site for **gregFramework** / Data Center modding: `docusaurus.config.js`, `sidebars.js`, React under `src/`, content under [`docs/`](./docs/). Published route base path: **`/wiki`**. -| | | -|:---|:---| -| **Im Workspace** | Pfad `gregFramework/gregWiki/`. Überblick: [gregFramework README](../README.md). | -| **Remote** | [`mleem97/gregWiki`](https://github.com/mleem97/gregWiki) | +--- -## Lokale Entwicklung +## Part of gregFramework + +This directory is part of the **[gregFramework](https://github.com/mleem97/gregFramework)** workspace. Clone sibling repositories side by side so each project lives at `gregFramework//`. See the workspace [README](https://github.com/mleem97/gregFramework/blob/master/README.md) for the full layout and migration notes. + +**Remote:** [`mleem97/gregWiki`](https://github.com/mleem97/gregWiki) — on-disk path: `gregFramework/gregWiki/`. + +--- + +## Local development ```bash npm install npm run start ``` -Produktions-Build: +Production build: ```bash npm run build ``` -Optional: Legacy-GitHub-Wiki spiegeln — siehe [`docs/getting-started/documentation-layout.md`](./docs/getting-started/documentation-layout.md) und Skripte `wiki:sync` / `wiki:normalize-i18n`. +Optional: mirror the legacy GitHub Wiki — see [`docs/getting-started/documentation-layout.md`](./docs/getting-started/documentation-layout.md) and scripts `wiki:sync` / `wiki:normalize-i18n`. + +--- ## Deployment (Coolify / CI) -- **Standard-Branch:** `main` — für neue Arbeit und PRs. -- **`master`:** kann für ältere Deployments parallel existieren; in Coolify den Branch auf **`main`** stellen, wenn möglich. +- **Default branch:** `main` — use this for new work and PRs. +- **`master`:** may still exist for older deployments; in Coolify, set the branch to **`main`** when possible. -### Coolify (Dockerfile) — `/app/package.json` fehlt +### Coolify (Dockerfile) — missing `/app/package.json` -Das Image erwartet **`package.json` im Image-Root `/app`**. Das passt nur, wenn der **Docker-Build-Kontext** dieses Repo (gregWiki) ist — nicht ein übergeordneter Monorepo-Ordner ohne Anpassung. +The image expects **`package.json` at the image root `/app`**. That only works if the **Docker build context** is this repository (gregWiki), not a parent monorepo folder without adjustments. -| Einstellung | Wert | -|-------------|------| -| **Dockerfile** | `Dockerfile` im gregWiki-Root | -| **Base directory** | **`.`**, wenn nur `gregWiki` geklont wird. Liegt gregWiki **neben** gregCore im gleichen Clone, oft **`gregWiki`** als Unterverzeichnis setzen. | -| **Volumina** | Kein leerer Host-Mount über `/app`, der `package.json` verdeckt. | +| Setting | Value | +|---------|--------| +| **Dockerfile** | `Dockerfile` at the gregWiki root | +| **Base directory** | **`.`** when only `gregWiki` is cloned. If gregWiki sits **next to** gregCore in the same clone, often set **`gregWiki`** as the subdirectory. | +| **Volumes** | Do not use an empty host mount over `/app` that hides `package.json`. | -Symptom: `docker-entrypoint: ERROR: /app/package.json not found` → falscher Kontext oder Volume. +Symptom: `docker-entrypoint: ERROR: /app/package.json not found` → wrong context or volume. -## Docker (lokal) +--- -Build-Kontext = **dieses** Repository (Ordner mit `package.json`): +## Docker (local) + +Build context = **this** repository (folder that contains `package.json`): ```bash cd path/to/gregWiki docker compose up --build ``` -Liegt gregWiki in **gregFramework**, alternativ vom Workspace aus: +If gregWiki lives inside **gregFramework**, from the workspace root: ```bash cd path/to/gregFramework docker compose -f docker-compose.gregwiki.yml up --build ``` -(`docker-compose.gregwiki.yml` setzt `build.context: ./gregWiki`.) +(`docker-compose.gregwiki.yml` sets `build.context: ./gregWiki`.) -## Siehe auch +--- -- [gregFramework README](../README.md) — flaches Layout `gregFramework/{RepoName}/` -- Quellcode und Builds: **gregCore**, `gregMod.*`, `gregExt.*` als eigene Repos (nicht nur diese Doku) +## See also + +- [gregFramework README](../README.md) — flat layout `gregFramework/{RepoName}/` +- Source code and builds: **gregCore**, **gregMod.*** , **gregExt.*** as separate repositories (not only this documentation) diff --git a/docs/contributors/repo-inventory.md b/docs/contributors/repo-inventory.md index ddc6911..54ad0c1 100644 --- a/docs/contributors/repo-inventory.md +++ b/docs/contributors/repo-inventory.md @@ -41,7 +41,7 @@ These folders typically sit **next to each other** in a developer workspace (see ## Wiki import (legacy) -Long-form pages mirrored from the GitHub Wiki live under [`docs/legacy/wiki-import/`](../legacy/wiki-import/Home) and remain linked from many topics. +Documentation is maintained in this repository under `docs/`; historical GitHub Wiki content has been retired in favor of curated guides and reference pages. ## .NET projects on disk (`*.csproj`) diff --git a/docs/guides/contributors/topics-overview.md b/docs/guides/contributors/topics-overview.md index be037a6..3c45cc9 100644 --- a/docs/guides/contributors/topics-overview.md +++ b/docs/guides/contributors/topics-overview.md @@ -16,4 +16,4 @@ Operational docs for people changing the framework, site, or release pipeline. - [Docusaurus workflow](/wiki/contributors/docusaurus-workflow) — edit/build the wiki site. - [Plugin submission audit](/wiki/contributors/plugin-submission-audit) — checklist for new plugins. -Imported guides: [Contribution workflow](/wiki/legacy/wiki-import/Contributors/Guides/Contribution-Workflow). +- [Contributor workshop](./contributor-workshop) — branching, reviews, and release expectations. diff --git a/docs/guides/mod-developers/overview.md b/docs/guides/mod-developers/overview.md index a7dce66..f261be3 100644 --- a/docs/guides/mod-developers/overview.md +++ b/docs/guides/mod-developers/overview.md @@ -1,7 +1,7 @@ --- title: Mod developers sidebar_label: Mod developers (hub) -description: Getting started, mod config, debugging — links into legacy wiki-import ModDevs tree. +description: Getting started, mod config, debugging — curated docs for FMF mod authors. --- # Mod developers @@ -9,6 +9,8 @@ description: Getting started, mod config, debugging — links into legacy wiki-i **Mod-Autorinnen und -Autoren** — eigene Mods bauen (Hooks, Konfiguration, Debug). Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview). - [By audience — intermediates](/wiki/audiences/intermediates) and [professionals](/wiki/audiences/professionals) -- Wiki: [Framework overview](/wiki/mods/framework) -- Imported: [ModDevs](/wiki/legacy/wiki-import/ModDevs/), [Modding guide](/wiki/legacy/wiki-import/Modding-Guide), [Mod config system](/wiki/legacy/wiki-import/Mod-Config-System) -- Imported: [Standalone mods](/wiki/legacy/wiki-import/StandaloneMods) +- [Framework overview](/wiki/mods/framework) — runtime capabilities and repo layout +- [FMF hooks](/wiki/framework/fmf-hooks) — hook surface (generated article) +- [FMF hook naming](/wiki/reference/fmf-hook-naming) and [hooks catalog](/wiki/reference/fmf-hooks-catalog) +- [Contributor workshop](/wiki/guides/contributors/contributor-workshop) — builds, CI, and PRs +- [Mods](/wiki/mods/) — gameplay mods (`FMF.*`) and release pages diff --git a/docs/guides/players/audiences-overview.md b/docs/guides/players/audiences-overview.md index bbeb5f7..c18f884 100644 --- a/docs/guides/players/audiences-overview.md +++ b/docs/guides/players/audiences-overview.md @@ -7,16 +7,16 @@ description: Vier Rollen — Spieler, Moddevs, Contributor, Sponsoren — plus E # By audience -Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen darunter). Wähle, was zu dir passt — die Sprache der meisten Seiten ist **Englisch**, mit deutschsprachigen Importen unter `legacy/wiki-import/` wo vorhanden. +Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen darunter). Die meisten Seiten sind **Englisch**; ausgewählte Einstiege gibt es auch auf **Deutsch** (z. B. in dieser Übersicht und in `i18n/de`). ## Die vier Rollen | Rolle | Für wen? | Einstieg | |--------|----------|----------| -| **Spieler** (End users) | Installation, Mods nutzen, Troubleshooting, FAQ | [End users (hub)](./overview) → [End user wiki](/wiki/legacy/wiki-import/EndUser/), [Data center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/) | -| **Mod-Entwickler** (Mod developers) | Mods bauen, Hooks, Konfiguration, Debug | [Mod developers (hub)](../mod-developers/overview) → [ModDevs wiki](/wiki/legacy/wiki-import/ModDevs/), [Framework](/wiki/mods/framework) | -| **Contributor** (Repo & Framework) | PRs, Doku, Plugins, CI, Design | [Contributors (workflow)](../contributors/topics-overview) → [Contributors wiki](/wiki/legacy/wiki-import/Contributors/), [Repo inventory](/wiki/contributors/repo-inventory) | -| **Sponsorinnen & Sponsoren** | Unterstützung, Transparenz, rechtlicher Kontext | [Sponsors (hub)](../sponsors/overview) → [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors), [Sponsoren (DE)](/wiki/legacy/wiki-import/Sponsoren) | +| **Spieler** (End users) | Installation, Mods nutzen, Troubleshooting | [End users (hub)](./overview) · [End-user workshop](./enduser-workshop) | +| **Mod-Entwickler** (Mod developers) | Mods bauen, Hooks, Konfiguration, Debug | [Mod developers (hub)](../mod-developers/overview) · [Framework](/wiki/mods/framework) | +| **Contributor** (Repo & Framework) | PRs, Doku, Plugins, CI | [Contributors (workflow)](../contributors/topics-overview) · [Repo inventory](/wiki/contributors/repo-inventory) | +| **Sponsorinnen & Sponsoren** | Unterstützung, Transparenz | [Sponsors (hub)](../sponsors/overview) | ## Erfahrungsstufen (alle Rollen) @@ -27,4 +27,3 @@ Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen ## Thematische Übersicht - [Topics hub](/wiki/topics/) — Security, Multiplayer, Assets, FFI, Roadmap, Meta. -- Importierte Legacy-Guides: [Legacy wiki import](/wiki/topics/wiki-import/overview). diff --git a/docs/guides/players/overview.md b/docs/guides/players/overview.md index 445168a..ba72cc0 100644 --- a/docs/guides/players/overview.md +++ b/docs/guides/players/overview.md @@ -1,7 +1,7 @@ --- title: End users sidebar_label: End users (hub) -description: FAQs, install paths, troubleshooting — plus legacy wiki-import entry points. +description: FAQs, install paths, troubleshooting — entry point for players using mods. --- # End users @@ -9,5 +9,6 @@ description: FAQs, install paths, troubleshooting — plus legacy wiki-import en **Spielerinnen und Spieler** — Mods installieren und spielen, ohne am Framework mitzuentwickeln. Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview). - [By audience — newbies](/wiki/audiences/newbies) -- Imported: [End user index](/wiki/legacy/wiki-import/EndUser/), [Data center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/), [Known incompatibilities](/wiki/legacy/wiki-import/Known-Incompatibilities) -- Imported: [End user release notes](/wiki/legacy/wiki-import/EndUser/End-User-Release) +- [End-user workshop](/wiki/guides/players/enduser-workshop) — install, updates, Workshop +- [Workshop uploader (tool)](/wiki/tools/workshop-uploader) — publishing and project metadata +- [Release channels](/wiki/reference/release-channels) — Steam vs GitHub discovery diff --git a/docs/guides/sponsors/overview.md b/docs/guides/sponsors/overview.md index bbfe7d0..02d9450 100644 --- a/docs/guides/sponsors/overview.md +++ b/docs/guides/sponsors/overview.md @@ -1,7 +1,7 @@ --- title: Sponsors & support sidebar_label: Sponsors (hub) -description: Für Unterstützerinnen und Unterstützer — Sponsoring, Transparenz, englische Detailseiten. +description: Für Unterstützerinnen und Unterstützer — Sponsoring, Transparenz, Anlaufstellen. --- # Sponsors & support @@ -10,14 +10,9 @@ Die Community finanziert u. a. Infrastruktur, Tools und Zeit für Pflege der Dok ## Kurzüberblick -- **Englisch (ausführlich):** [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors) — Optionen (z. B. GitHub Sponsors), Nutzung von Mitteln, rechtlicher Kontext. -- **Deutsch:** [Sponsoren](/wiki/legacy/wiki-import/Sponsoren) — gleiche Themen, wo vorhanden auf Deutsch. -- **Dank:** [Community Thanks](/wiki/legacy/wiki-import/Community-Thanks) (Import), [Changelog & versions](/wiki/legacy/wiki-import/Changelog-Versions) für Release-Transparenz. - -## Verknüpft - -- [Security & legal](/wiki/topics/security-legal/overview) — Lizenz, Haftungsausschlüsse, Brief an die Entwickler. -- [License & legal (EN)](/wiki/legacy/wiki-import/License-Legal) — rechtlicher Rahmen des Projekts. +- **GitHub:** [mleem97/gregFramework](https://github.com/mleem97/gregFramework) — Sponsoring- und Community-Richtlinien stehen in `README`, `LICENSE` und `CONTRIBUTING`. +- **Transparenz:** Release-Notes und [Release-Kanäle](/wiki/reference/release-channels) beschreiben, wie Builds verteilt werden. +- **Rechtliches:** [Security & legal](/wiki/topics/security-legal/overview) — verbindliche Texte liegen im Repository, nicht nur im Wiki. :::note Zielgruppe Diese Seite richtet sich an **Sponsorinnen, Sponsoren und Fördernde**. Spielerinnen und Spieler finden den Einstieg unter [End users](/wiki/guides/players/overview); Mod-Autoren unter [Mod developers](/wiki/guides/mod-developers/overview); Mitwirkende am Repo unter [Contributors (workflow)](/wiki/guides/contributors/topics-overview). diff --git a/docs/intro.md b/docs/intro.md index c86be82..46c89f2 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -11,10 +11,10 @@ This documentation describes the **current split layout**: a local `gregFramewor | Audience | Start here | |----------|------------| -| **Players** — install, play, troubleshoot | [End users (hub)](./guides/players/overview.md) · [End user wiki (import)](./legacy/wiki-import/EndUser/) | -| **Mod developers** — build mods, hooks, debugging | [Mod developers (hub)](./guides/mod-developers/overview.md) · [ModDevs wiki (import)](./legacy/wiki-import/ModDevs/) · [Framework](./mods/framework.md) | -| **Contributors** — PRs, docs, plugins, CI | [Contributors (workflow)](./guides/contributors/topics-overview.md) · [Contributors wiki (import)](./legacy/wiki-import/Contributors/) | -| **Sponsors** — support & transparency | [Sponsors (hub)](./guides/sponsors/overview.md) · [Sponsors (EN)](./legacy/wiki-import/Sponsors) · [Sponsoren (DE)](./legacy/wiki-import/Sponsoren) | +| **Players** — install, play, troubleshoot | [End users (hub)](./guides/players/overview.md) · [End-user workshop](./guides/players/enduser-workshop.md) | +| **Mod developers** — build mods, hooks, debugging | [Mod developers (hub)](./guides/mod-developers/overview.md) · [Framework](./mods/framework.md) · [FMF hooks](/wiki/framework/fmf-hooks) | +| **Contributors** — PRs, docs, plugins, CI | [Contributors (workflow)](./guides/contributors/topics-overview.md) · [Contributor workshop](./guides/contributors/contributor-workshop.md) | +| **Sponsors** — support & transparency | [Sponsors (hub)](./guides/sponsors/overview.md) · [GitHub Sponsors](https://github.com/sponsors) (project policies in repo `LICENSE` / `CONTRIBUTING`) | **Experience tracks** (newbies → pros): [By audience](./guides/players/audiences-overview.md) → [Newbies](/wiki/audiences/newbies), [Intermediates](/wiki/audiences/intermediates), [Professionals](/wiki/audiences/professionals). diff --git a/docs/legacy/index.md b/docs/legacy/index.md deleted file mode 100644 index 7070b22..0000000 --- a/docs/legacy/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Legacy content -sidebar_label: Legacy -description: Imported GitHub Wiki mirror and deprecation policy. ---- - -# Legacy content - -Material under **[`legacy/wiki-import/`](./wiki-import/Home)** is the **GitHub Wiki mirror** (synced from `.wiki/`). It is searchable and versioned, but **curated** documentation lives under `framework/`, `guides/`, `reference/`, and `workspace/`. - -- **How sync works:** [Legacy wiki import process](../topics/wiki-import/overview) -- **Entry:** [Home](./wiki-import/Home) diff --git a/docs/legacy/wiki-import/AI-USAGE.md b/docs/legacy/wiki-import/AI-USAGE.md deleted file mode 100644 index e42cf1d..0000000 --- a/docs/legacy/wiki-import/AI-USAGE.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: AI-USAGE -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Architecture.md b/docs/legacy/wiki-import/Architecture.md deleted file mode 100644 index c3da2f3..0000000 --- a/docs/legacy/wiki-import/Architecture.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Architecture -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/AssetExport.md b/docs/legacy/wiki-import/AssetExport.md deleted file mode 100644 index e2e6a8d..0000000 --- a/docs/legacy/wiki-import/AssetExport.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: AssetExport -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md b/docs/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md deleted file mode 100644 index 827df65..0000000 --- a/docs/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Bekannte Inkompatibilitäten -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Brief-an-WASEKU.md b/docs/legacy/wiki-import/Brief-an-WASEKU.md deleted file mode 100644 index 05455be..0000000 --- a/docs/legacy/wiki-import/Brief-an-WASEKU.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Brief an WASEKU (Data Center) -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Changelog-Versionen.md b/docs/legacy/wiki-import/Changelog-Versionen.md deleted file mode 100644 index dc2c4f5..0000000 --- a/docs/legacy/wiki-import/Changelog-Versionen.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Changelog & Versionen -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Changelog-Versions.md b/docs/legacy/wiki-import/Changelog-Versions.md deleted file mode 100644 index 41bcc2b..0000000 --- a/docs/legacy/wiki-import/Changelog-Versions.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Changelog & Versions EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Community-Thanks.md b/docs/legacy/wiki-import/Community-Thanks.md deleted file mode 100644 index e41ffca..0000000 --- a/docs/legacy/wiki-import/Community-Thanks.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Community Thanks -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contirbutors/Contributors-Debug.md b/docs/legacy/wiki-import/Contirbutors/Contributors-Debug.md deleted file mode 100644 index 6d0d38c..0000000 --- a/docs/legacy/wiki-import/Contirbutors/Contributors-Debug.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Contributors (Debug) EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contirbutors/_category_.json b/docs/legacy/wiki-import/Contirbutors/_category_.json deleted file mode 100644 index ee85b68..0000000 --- a/docs/legacy/wiki-import/Contirbutors/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Contributors (typo path — prefer Contributors/)", - "position": 60, -} diff --git a/docs/legacy/wiki-import/Contributors-Debug.md b/docs/legacy/wiki-import/Contributors-Debug.md deleted file mode 100644 index faa4f0c..0000000 --- a/docs/legacy/wiki-import/Contributors-Debug.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Contributors-Debug -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Contributors-Debug.md b/docs/legacy/wiki-import/Contributors/Contributors-Debug.md deleted file mode 100644 index 6d0d38c..0000000 --- a/docs/legacy/wiki-import/Contributors/Contributors-Debug.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Contributors (Debug) EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md b/docs/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md deleted file mode 100644 index ebbb92a..0000000 --- a/docs/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Contribution-Workflow -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Guides/Index.md b/docs/legacy/wiki-import/Contributors/Guides/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/Contributors/Guides/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Guides/_category_.json b/docs/legacy/wiki-import/Contributors/Guides/_category_.json deleted file mode 100644 index b2d26ee..0000000 --- a/docs/legacy/wiki-import/Contributors/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-contributors-guides" -} diff --git a/docs/legacy/wiki-import/Contributors/Index.md b/docs/legacy/wiki-import/Contributors/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/Contributors/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Reference/Index.md b/docs/legacy/wiki-import/Contributors/Reference/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/Contributors/Reference/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Reference/Naming-Convention.md b/docs/legacy/wiki-import/Contributors/Reference/Naming-Convention.md deleted file mode 100644 index c58aff8..0000000 --- a/docs/legacy/wiki-import/Contributors/Reference/Naming-Convention.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Naming-Convention -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Reference/_category_.json b/docs/legacy/wiki-import/Contributors/Reference/_category_.json deleted file mode 100644 index 1c22f38..0000000 --- a/docs/legacy/wiki-import/Contributors/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-contributors-reference" -} diff --git a/docs/legacy/wiki-import/Contributors/Troubleshooting/Index.md b/docs/legacy/wiki-import/Contributors/Troubleshooting/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/Contributors/Troubleshooting/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/Troubleshooting/_category_.json b/docs/legacy/wiki-import/Contributors/Troubleshooting/_category_.json deleted file mode 100644 index d86d79e..0000000 --- a/docs/legacy/wiki-import/Contributors/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-contributors-troubleshooting" -} diff --git a/docs/legacy/wiki-import/Contributors/Troubleshooting/overview.md b/docs/legacy/wiki-import/Contributors/Troubleshooting/overview.md deleted file mode 100644 index 89a7849..0000000 --- a/docs/legacy/wiki-import/Contributors/Troubleshooting/overview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: overview -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Contributors/_category_.json b/docs/legacy/wiki-import/Contributors/_category_.json deleted file mode 100644 index d2ac4de..0000000 --- a/docs/legacy/wiki-import/Contributors/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Contributors", - "position": 30, -} diff --git a/docs/legacy/wiki-import/DataCenterFAQ/Index.md b/docs/legacy/wiki-import/DataCenterFAQ/Index.md deleted file mode 100644 index 837302a..0000000 --- a/docs/legacy/wiki-import/DataCenterFAQ/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Data Center FAQ -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/DataCenterFAQ/Part-1.md b/docs/legacy/wiki-import/DataCenterFAQ/Part-1.md deleted file mode 100644 index a3e1fe0..0000000 --- a/docs/legacy/wiki-import/DataCenterFAQ/Part-1.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Frequently Asked Questions Part 1 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/DataCenterFAQ/Part-2.md b/docs/legacy/wiki-import/DataCenterFAQ/Part-2.md deleted file mode 100644 index 7c1e925..0000000 --- a/docs/legacy/wiki-import/DataCenterFAQ/Part-2.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Frequently Asked Questions Part 2 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/DataCenterFAQ/Part-3.md b/docs/legacy/wiki-import/DataCenterFAQ/Part-3.md deleted file mode 100644 index d20a6b8..0000000 --- a/docs/legacy/wiki-import/DataCenterFAQ/Part-3.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Frequently Asked Questions Part 3 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md b/docs/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md deleted file mode 100644 index 5b50aa1..0000000 --- a/docs/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Patch Panel -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/DataCenterFAQ/_category_.json b/docs/legacy/wiki-import/DataCenterFAQ/_category_.json deleted file mode 100644 index 40fe686..0000000 --- a/docs/legacy/wiki-import/DataCenterFAQ/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Data Center FAQ", - "position": 50, -} diff --git a/docs/legacy/wiki-import/Device-Reference.md b/docs/legacy/wiki-import/Device-Reference.md deleted file mode 100644 index a410477..0000000 --- a/docs/legacy/wiki-import/Device-Reference.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Device-Reference -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/End-User-Release.md b/docs/legacy/wiki-import/End-User-Release.md deleted file mode 100644 index c80c1c2..0000000 --- a/docs/legacy/wiki-import/End-User-Release.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: End-User-Release -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/End-User-Release.md b/docs/legacy/wiki-import/EndUser/End-User-Release.md deleted file mode 100644 index 78273d2..0000000 --- a/docs/legacy/wiki-import/EndUser/End-User-Release.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: End-User (Release) EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md b/docs/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md deleted file mode 100644 index 12f279f..0000000 --- a/docs/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Framework-Dependency -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Guides/Index.md b/docs/legacy/wiki-import/EndUser/Guides/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/EndUser/Guides/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Guides/_category_.json b/docs/legacy/wiki-import/EndUser/Guides/_category_.json deleted file mode 100644 index 9264a97..0000000 --- a/docs/legacy/wiki-import/EndUser/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-enduser-guides" -} diff --git a/docs/legacy/wiki-import/EndUser/Index.md b/docs/legacy/wiki-import/EndUser/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/EndUser/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Reference/Disclaimer.md b/docs/legacy/wiki-import/EndUser/Reference/Disclaimer.md deleted file mode 100644 index 9269e02..0000000 --- a/docs/legacy/wiki-import/EndUser/Reference/Disclaimer.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Disclaimer -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Reference/Index.md b/docs/legacy/wiki-import/EndUser/Reference/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/EndUser/Reference/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Reference/_category_.json b/docs/legacy/wiki-import/EndUser/Reference/_category_.json deleted file mode 100644 index 5d3cab7..0000000 --- a/docs/legacy/wiki-import/EndUser/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-enduser-reference" -} diff --git a/docs/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md b/docs/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md deleted file mode 100644 index 6f51bc3..0000000 --- a/docs/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: FAQ -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Troubleshooting/Index.md b/docs/legacy/wiki-import/EndUser/Troubleshooting/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/EndUser/Troubleshooting/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/Troubleshooting/_category_.json b/docs/legacy/wiki-import/EndUser/Troubleshooting/_category_.json deleted file mode 100644 index 9d296a4..0000000 --- a/docs/legacy/wiki-import/EndUser/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-enduser-troubleshooting" -} diff --git a/docs/legacy/wiki-import/EndUser/Troubleshooting/overview.md b/docs/legacy/wiki-import/EndUser/Troubleshooting/overview.md deleted file mode 100644 index 89a7849..0000000 --- a/docs/legacy/wiki-import/EndUser/Troubleshooting/overview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: overview -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/EndUser/_category_.json b/docs/legacy/wiki-import/EndUser/_category_.json deleted file mode 100644 index 08b8d59..0000000 --- a/docs/legacy/wiki-import/EndUser/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "End users", - "position": 10, -} diff --git a/docs/legacy/wiki-import/FFI-Bridge-Reference.md b/docs/legacy/wiki-import/FFI-Bridge-Reference.md deleted file mode 100644 index fb57be1..0000000 --- a/docs/legacy/wiki-import/FFI-Bridge-Reference.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: FFI-Bridge-Reference -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Framework-Features-Use-Cases.md b/docs/legacy/wiki-import/Framework-Features-Use-Cases.md deleted file mode 100644 index 8ce7e46..0000000 --- a/docs/legacy/wiki-import/Framework-Features-Use-Cases.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Framework-Features-Use-Cases -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Glossar.md b/docs/legacy/wiki-import/Glossar.md deleted file mode 100644 index c7af548..0000000 --- a/docs/legacy/wiki-import/Glossar.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Glossar -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Glossary.md b/docs/legacy/wiki-import/Glossary.md deleted file mode 100644 index 1a549f2..0000000 --- a/docs/legacy/wiki-import/Glossary.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Glossary EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/HOOK-NAMING-CONVENTION.md b/docs/legacy/wiki-import/HOOK-NAMING-CONVENTION.md deleted file mode 100644 index f730e07..0000000 --- a/docs/legacy/wiki-import/HOOK-NAMING-CONVENTION.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: HOOK-NAMING-CONVENTION -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/HOOKS.md b/docs/legacy/wiki-import/HOOKS.md deleted file mode 100644 index 2881ff3..0000000 --- a/docs/legacy/wiki-import/HOOKS.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: HOOKS -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Home.md b/docs/legacy/wiki-import/Home.md deleted file mode 100644 index 4b97690..0000000 --- a/docs/legacy/wiki-import/Home.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Home -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Known-Incompatibilities.md b/docs/legacy/wiki-import/Known-Incompatibilities.md deleted file mode 100644 index a227325..0000000 --- a/docs/legacy/wiki-import/Known-Incompatibilities.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Known Incompatibilities EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Letter-to-WASEKU.md b/docs/legacy/wiki-import/Letter-to-WASEKU.md deleted file mode 100644 index d23a10b..0000000 --- a/docs/legacy/wiki-import/Letter-to-WASEKU.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Letter to WASEKU EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/License-Legal.md b/docs/legacy/wiki-import/License-Legal.md deleted file mode 100644 index 2aa4627..0000000 --- a/docs/legacy/wiki-import/License-Legal.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: License & Legal EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Lizenz-Rechtliches.md b/docs/legacy/wiki-import/Lizenz-Rechtliches.md deleted file mode 100644 index 98e38c7..0000000 --- a/docs/legacy/wiki-import/Lizenz-Rechtliches.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Lizenz & Rechtliches -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Lua-FFI-Start-Developing.md b/docs/legacy/wiki-import/Lua-FFI-Start-Developing.md deleted file mode 100644 index 68ff7dc..0000000 --- a/docs/legacy/wiki-import/Lua-FFI-Start-Developing.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Lua-FFI-Start-Developing -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/MODIAPI_FINAL_STATUS.md b/docs/legacy/wiki-import/MODIAPI_FINAL_STATUS.md deleted file mode 100644 index 2fbf6f0..0000000 --- a/docs/legacy/wiki-import/MODIAPI_FINAL_STATUS.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: MODIAPI_FINAL_STATUS -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md b/docs/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md deleted file mode 100644 index 85ffd08..0000000 --- a/docs/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: MODIAPI_INTEGRATION_SUMMARY -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/MelonLoader.md b/docs/legacy/wiki-import/MelonLoader.md deleted file mode 100644 index 777e5d5..0000000 --- a/docs/legacy/wiki-import/MelonLoader.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: MelonLoader -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Mod-Config-System.md b/docs/legacy/wiki-import/Mod-Config-System.md deleted file mode 100644 index a9eb960..0000000 --- a/docs/legacy/wiki-import/Mod-Config-System.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Mod-Config-System -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Mod-Developer-Debug.md b/docs/legacy/wiki-import/Mod-Developer-Debug.md deleted file mode 100644 index ad41fec..0000000 --- a/docs/legacy/wiki-import/Mod-Developer-Debug.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Mod-Developer-Debug -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Guides/Getting-Started.md b/docs/legacy/wiki-import/ModDevs/Guides/Getting-Started.md deleted file mode 100644 index cff5715..0000000 --- a/docs/legacy/wiki-import/ModDevs/Guides/Getting-Started.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Getting-Started -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Guides/Index.md b/docs/legacy/wiki-import/ModDevs/Guides/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/ModDevs/Guides/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Guides/_category_.json b/docs/legacy/wiki-import/ModDevs/Guides/_category_.json deleted file mode 100644 index 6061c4c..0000000 --- a/docs/legacy/wiki-import/ModDevs/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-moddevs-guides" -} diff --git a/docs/legacy/wiki-import/ModDevs/Index.md b/docs/legacy/wiki-import/ModDevs/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/ModDevs/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md b/docs/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md deleted file mode 100644 index 185cfc9..0000000 --- a/docs/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Mod-Developer (Debug) EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Modding-Guide.md b/docs/legacy/wiki-import/ModDevs/Modding-Guide.md deleted file mode 100644 index 252e71f..0000000 --- a/docs/legacy/wiki-import/ModDevs/Modding-Guide.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Modding-Guide -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md b/docs/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md deleted file mode 100644 index 99668ef..0000000 --- a/docs/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Hook-Event-Reference -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Reference/Index.md b/docs/legacy/wiki-import/ModDevs/Reference/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/ModDevs/Reference/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Reference/_category_.json b/docs/legacy/wiki-import/ModDevs/Reference/_category_.json deleted file mode 100644 index 337f76e..0000000 --- a/docs/legacy/wiki-import/ModDevs/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-moddevs-reference" -} diff --git a/docs/legacy/wiki-import/ModDevs/Troubleshooting/Index.md b/docs/legacy/wiki-import/ModDevs/Troubleshooting/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/ModDevs/Troubleshooting/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json b/docs/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json deleted file mode 100644 index 0979ace..0000000 --- a/docs/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-moddevs-troubleshooting" -} diff --git a/docs/legacy/wiki-import/ModDevs/Troubleshooting/overview.md b/docs/legacy/wiki-import/ModDevs/Troubleshooting/overview.md deleted file mode 100644 index 89a7849..0000000 --- a/docs/legacy/wiki-import/ModDevs/Troubleshooting/overview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: overview -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModDevs/_category_.json b/docs/legacy/wiki-import/ModDevs/_category_.json deleted file mode 100644 index 16979ad..0000000 --- a/docs/legacy/wiki-import/ModDevs/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Mod developers", - "position": 20, -} diff --git a/docs/legacy/wiki-import/Modding-Guide.md b/docs/legacy/wiki-import/Modding-Guide.md deleted file mode 100644 index 252e71f..0000000 --- a/docs/legacy/wiki-import/Modding-Guide.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Modding-Guide -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ModigAPI-Consolidation.md b/docs/legacy/wiki-import/ModigAPI-Consolidation.md deleted file mode 100644 index 6126d97..0000000 --- a/docs/legacy/wiki-import/ModigAPI-Consolidation.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: ModigAPI-Consolidation -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/README.md b/docs/legacy/wiki-import/README.md deleted file mode 100644 index 7beec7f..0000000 --- a/docs/legacy/wiki-import/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# Greg Wiki (Docusaurus) - -This folder is configured as a Docusaurus site using the existing Markdown wiki files. - -## Local run - -```bash -npm install -npm run start -``` - -## Production build - -```bash -npm run build -npm run serve -``` - -## Coolify deployment notes - -- Build command: `npm install ; npm run build` -- Start command: `npm run serve -- --host 0.0.0.0 --port $PORT` -- Port: `3000` (or use Coolify `$PORT`) - -If you use Docker deployment mode in Coolify, this repo includes a `Dockerfile`. - -## Multi-repo wiki import - -This workspace can import GitHub wiki pages for every repository of one or more owners. - -- Config file: `wiki-import.config.json` -- Import script: `scripts/import-wikis.mjs` - -### Configure owners - -Edit `wiki-import.config.json`: - -```json -{ - "owners": [ - { - "name": "mleem97", - "destination": "Repos/mleem97" - } - ], - "includeArchived": false, - "perPage": 100 -} -``` - -### Run import - -```bash -npm run import:wikis:dry -npm run import:wikis -``` - -Imported docs are placed under owner/repo folders such as `Repos/mleem97//` and automatically appear in the Docusaurus sidebar. diff --git a/docs/legacy/wiki-import/README_MODDING.md b/docs/legacy/wiki-import/README_MODDING.md deleted file mode 100644 index e4410d3..0000000 --- a/docs/legacy/wiki-import/README_MODDING.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: README_MODDING -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ROADMAP.md b/docs/legacy/wiki-import/ROADMAP.md deleted file mode 100644 index 92a0145..0000000 --- a/docs/legacy/wiki-import/ROADMAP.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: ROADMAP -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Release-Assets-and-Templates.md b/docs/legacy/wiki-import/Release-Assets-and-Templates.md deleted file mode 100644 index 9c38064..0000000 --- a/docs/legacy/wiki-import/Release-Assets-and-Templates.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Release Assets and Templates -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Repos/mleem97/_category_.json b/docs/legacy/wiki-import/Repos/mleem97/_category_.json deleted file mode 100644 index 6323ca6..0000000 --- a/docs/legacy/wiki-import/Repos/mleem97/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "label": "mleem97", - "position": 1, - "collapsed": true, - "collapsible": true -} diff --git a/docs/legacy/wiki-import/Repository-Status-2026-04-04.md b/docs/legacy/wiki-import/Repository-Status-2026-04-04.md deleted file mode 100644 index a78764d..0000000 --- a/docs/legacy/wiki-import/Repository-Status-2026-04-04.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Repository Status 2026-04-04 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Setup.md b/docs/legacy/wiki-import/Setup.md deleted file mode 100644 index da72164..0000000 --- a/docs/legacy/wiki-import/Setup.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Setup -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Sponsoren.md b/docs/legacy/wiki-import/Sponsoren.md deleted file mode 100644 index e13b6f7..0000000 --- a/docs/legacy/wiki-import/Sponsoren.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Sponsoren -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Sponsors.md b/docs/legacy/wiki-import/Sponsors.md deleted file mode 100644 index eab8135..0000000 --- a/docs/legacy/wiki-import/Sponsors.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Sponsors EN -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/StandaloneMods.md b/docs/legacy/wiki-import/StandaloneMods.md deleted file mode 100644 index c398ac9..0000000 --- a/docs/legacy/wiki-import/StandaloneMods.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Standalone Mods -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md b/docs/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md deleted file mode 100644 index fddfa6d..0000000 --- a/docs/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Steamworks-P2P-Multiplayer-Roadmap -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/TASKLIST.md b/docs/legacy/wiki-import/TASKLIST.md deleted file mode 100644 index d0bcc85..0000000 --- a/docs/legacy/wiki-import/TASKLIST.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: TASKLIST -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/TechnicalReference/Guides/Index.md b/docs/legacy/wiki-import/TechnicalReference/Guides/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Guides/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/TechnicalReference/Guides/_category_.json b/docs/legacy/wiki-import/TechnicalReference/Guides/_category_.json deleted file mode 100644 index 1eb988d..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-techref-guides" -} diff --git a/docs/legacy/wiki-import/TechnicalReference/Index.md b/docs/legacy/wiki-import/TechnicalReference/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/TechnicalReference/Reference/Index.md b/docs/legacy/wiki-import/TechnicalReference/Reference/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Reference/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/TechnicalReference/Reference/_category_.json b/docs/legacy/wiki-import/TechnicalReference/Reference/_category_.json deleted file mode 100644 index 8c6c7d5..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-techref-reference" -} diff --git a/docs/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md b/docs/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md deleted file mode 100644 index 0270b8e..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Index -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json b/docs/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json deleted file mode 100644 index fba851c..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-techref-troubleshooting" -} diff --git a/docs/legacy/wiki-import/TechnicalReference/_category_.json b/docs/legacy/wiki-import/TechnicalReference/_category_.json deleted file mode 100644 index 5ee5c2f..0000000 --- a/docs/legacy/wiki-import/TechnicalReference/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Technical reference", - "position": 40, -} diff --git a/docs/legacy/wiki-import/WIKI-MOVED.md b/docs/legacy/wiki-import/WIKI-MOVED.md deleted file mode 100644 index 28a72db..0000000 --- a/docs/legacy/wiki-import/WIKI-MOVED.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: WIKI-MOVED -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/Web-UI-Bridge.md b/docs/legacy/wiki-import/Web-UI-Bridge.md deleted file mode 100644 index 0abbbb3..0000000 --- a/docs/legacy/wiki-import/Web-UI-Bridge.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Web-UI-Bridge -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/_Sidebar.md b/docs/legacy/wiki-import/_Sidebar.md deleted file mode 100644 index 16d0551..0000000 --- a/docs/legacy/wiki-import/_Sidebar.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: _Sidebar -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/legacy/wiki-import/ui.md b/docs/legacy/wiki-import/ui.md deleted file mode 100644 index e7d5886..0000000 --- a/docs/legacy/wiki-import/ui.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: ui -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/legacy/wiki-import`. -::: - diff --git a/docs/mods/framework.md b/docs/mods/framework.md index cce53ef..17d1148 100644 --- a/docs/mods/framework.md +++ b/docs/mods/framework.md @@ -14,7 +14,7 @@ The core `FrikaMF` runtime provides: ## Core references -- [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases) -- [`HOOKS`](/wiki/legacy/wiki-import/HOOKS) -- [`FFI Bridge Reference`](/wiki/legacy/wiki-import/FFI-Bridge-Reference) -- [`Mod Developer Debug`](/wiki/legacy/wiki-import/Mod-Developer-Debug) +- [FMF hooks (generated)](/wiki/framework/fmf-hooks) — hook surface and categories +- [FMF hook naming](/wiki/reference/fmf-hook-naming) — `FMF.*` vs legacy `FFM.*` +- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) — strings from core `HookNames.cs` +- [Framework architecture](/wiki/framework/architecture) — runtime layout and bridges diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 7c7d1fa..ba7fe9e 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -20,4 +20,4 @@ Gameplay mods (`FMF.*`) are documented under **[Mods](../mods/index.md)** — no ## Additional context -- [Standalone mods (legacy wiki)](/wiki/legacy/wiki-import/StandaloneMods) +- [Mods overview](/wiki/mods/) — gameplay mods (`FMF.*`) and how they differ from plugins diff --git a/docs/reference/fmf-hook-naming.md b/docs/reference/fmf-hook-naming.md index ae8d802..971c427 100644 --- a/docs/reference/fmf-hook-naming.md +++ b/docs/reference/fmf-hook-naming.md @@ -67,4 +67,4 @@ Bindings are **not** auto-generated for all languages; stubs are for contributor ## Related - [FMF hooks catalog](./fmf-hooks-catalog.md) (generated) -- [Legacy wiki: HOOK-NAMING-CONVENTION](../legacy/wiki-import/HOOK-NAMING-CONVENTION) (extended examples) +- [FMF hooks](/wiki/framework/fmf-hooks) — generated hook surface and categories diff --git a/docs/topics/assets-and-export/overview.md b/docs/topics/assets-and-export/overview.md index b2f2484..9566373 100644 --- a/docs/topics/assets-and-export/overview.md +++ b/docs/topics/assets-and-export/overview.md @@ -1,11 +1,11 @@ --- title: Assets & export sidebar_label: Assets & export (hub) -description: Asset export plugin, templates, and related legacy wiki-import pages. +description: Asset export plugin, templates, and Workshop-related flows. --- # Assets & export -- Wiki: [FFM.Plugin.AssetExporter](/wiki/plugins/ffm-plugin-asset-exporter) -- Release: [FFM.Plugin.AssetExporter release](/wiki/releases/plugins/ffm-plugin-asset-exporter-release) -- Imported: [AssetExport](/wiki/legacy/wiki-import/AssetExport), [Release assets and templates](/wiki/legacy/wiki-import/Release-Assets-and-Templates) +- [FFM.Plugin.AssetExporter](/wiki/plugins/ffm-plugin-asset-exporter) +- [FFM.Plugin.AssetExporter release](/wiki/releases/plugins/ffm-plugin-asset-exporter-release) +- [Workshop uploader](/wiki/tools/workshop-uploader) — desktop app for publishing Workshop content diff --git a/docs/topics/ffi-and-hooks/overview.md b/docs/topics/ffi-and-hooks/overview.md index 4404c30..242f019 100644 --- a/docs/topics/ffi-and-hooks/overview.md +++ b/docs/topics/ffi-and-hooks/overview.md @@ -1,13 +1,13 @@ --- title: FFI, hooks & Lua sidebar_label: FFI, hooks & Lua (hub) -description: FFI, hook lists, naming — bridge between framework and legacy wiki. +description: FFI, hook lists, naming — curated reference for mod and plugin authors. --- # FFI, hooks & Lua -- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) (generated) -- [FMF hook naming](/wiki/reference/fmf-hook-naming) -- Imported: [HOOKS](/wiki/legacy/wiki-import/HOOKS), [Hook naming convention](/wiki/legacy/wiki-import/HOOK-NAMING-CONVENTION) -- Imported: [FFI bridge reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference), [Lua FFI start](/wiki/legacy/wiki-import/Lua-FFI-Start-Developing) -- Imported: [Mod developer debug](/wiki/legacy/wiki-import/Mod-Developer-Debug) +- [FMF hooks](/wiki/framework/fmf-hooks) — generated hook surface +- [FMF hooks catalog](/wiki/reference/fmf-hooks-catalog) — strings from core sources +- [FMF hook naming](/wiki/reference/fmf-hook-naming) — `FMF.*` vs legacy `FFM.*` +- [Framework architecture](/wiki/framework/architecture) — bridges (including Rust) and runtime layout +- [Modding language requirement](/wiki/reference/modding-language-requirement) — C# policy for mods/plugins diff --git a/docs/topics/index.md b/docs/topics/index.md index 1aae49b..9d8b140 100644 --- a/docs/topics/index.md +++ b/docs/topics/index.md @@ -6,7 +6,7 @@ description: Thematic index — cross-cutting overviews (assets, multiplayer, se # Topics hub -Documentation combines **curated pages** (guides, framework, reference), **generated reference** (hook catalogs), and **legacy imports** from the GitHub wiki (`.wiki` → `docs/legacy/wiki-import/`). +Documentation is **curated** in this repository: guides, framework articles, reference data (hook catalogs), and contributor workflow — versioned with **gregFramework** and **gregWiki**. ## Quick map @@ -17,7 +17,6 @@ Documentation combines **curated pages** (guides, framework, reference), **gener | **Technical reference** | [Reference & technical](/wiki/topics/reference/overview) | | **Ship planning** | [Roadmap & planning](/wiki/topics/roadmap/overview) | | **Repository inventory** | [Repo inventory](/wiki/contributors/repo-inventory) | -| **Imported legacy wiki** | [Legacy wiki import](/wiki/topics/wiki-import/overview) | | **Steam, betas, backlog, game paths** | [Meta & operations](/wiki/topics/meta/overview) — [Game folder layout](/wiki/topics/meta/game-folder-layout) | ## Thematic folders (deep links) diff --git a/docs/topics/meta/game-folder-layout.md b/docs/topics/meta/game-folder-layout.md index b1619ba..62287c0 100644 --- a/docs/topics/meta/game-folder-layout.md +++ b/docs/topics/meta/game-folder-layout.md @@ -59,4 +59,4 @@ Ohne Junction müssen MelonMods weiter physisch unter **`Mods/`** liegen oder ü ## Siehe auch - [Meta & operations](/wiki/topics/meta/overview) -- [Legacy: Mod Config System](/wiki/legacy/wiki-import/Mod-Config-System) (API-Contract; Pfade auf **ModCfg** beziehen) +- Mod configuration contracts are described alongside runtime docs in [Framework](/wiki/mods/framework) and core `README` in **gregFramework** (paths under **`UserData/ModCfg/`** follow the game + framework conventions above). diff --git a/docs/topics/multiplayer-and-networking/overview.md b/docs/topics/multiplayer-and-networking/overview.md index f1dcdab..ca58290 100644 --- a/docs/topics/multiplayer-and-networking/overview.md +++ b/docs/topics/multiplayer-and-networking/overview.md @@ -1,15 +1,11 @@ --- title: Multiplayer & networking sidebar_label: Multiplayer & networking (hub) -description: P2P roadmap and multiplayer plugin — separate from Sysadmin / Web UI. +description: Multiplayer plugin, releases, and related Web UI tooling. --- # Multiplayer & networking -This hub covers **networking and multiplayer** only. It does **not** include [FFM.Plugin.Sysadmin](/wiki/plugins/ffm-plugin-sysadmin) (UI settings / modernizer) or [FFM.Plugin.WebUIBridge](/wiki/plugins/ffm-plugin-web-ui-bridge) (DC2 web UI) — those are separate plugins. - -- Wiki: [FFM.Plugin.Multiplayer](/wiki/plugins/ffm-plugin-multiplayer) -- Release: [FFM.Plugin.Multiplayer release](/wiki/releases/plugins/ffm-plugin-multiplayer-release) -- Imported: [Steamworks P2P multiplayer roadmap](/wiki/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap) - -**Related (separate topic):** [Web UI bridge](/wiki/legacy/wiki-import/Web-UI-Bridge) — documentation import for browser-based UI; not part of the multiplayer stack. +- [FFM.Plugin.Multiplayer](/wiki/plugins/ffm-plugin-multiplayer) — documentation for the multiplayer plugin +- [FFM.Plugin.Multiplayer release](/wiki/releases/plugins/ffm-plugin-multiplayer-release) +- [FFM.Plugin.WebUIBridge](/wiki/plugins/ffm-plugin-web-ui-bridge) — browser-based UI bridge (separate from the core P2P stack) diff --git a/docs/topics/roadmap/overview.md b/docs/topics/roadmap/overview.md index 02398d8..534f471 100644 --- a/docs/topics/roadmap/overview.md +++ b/docs/topics/roadmap/overview.md @@ -6,7 +6,7 @@ description: Unified roadmap and mod-store staging notes. # Roadmap & planning -- [Unified roadmap](/wiki/roadmap/unified-roadmap) — cross-cutting priorities. +- [Unified roadmap](/wiki/roadmap/unified-roadmap) — cross-cutting priorities for gregFramework. - [Mod store stages](/wiki/roadmap/mod-store-stages) — staged rollout concepts. -Imported context: [ROADMAP](/wiki/legacy/wiki-import/ROADMAP), [TASKLIST](/wiki/legacy/wiki-import/TASKLIST), [Repository status](/wiki/legacy/wiki-import/Repository-Status-2026-04-04). +Historical task lists and status snapshots are folded into the unified roadmap; follow GitHub issues and releases for day-to-day execution. diff --git a/docs/topics/security-legal/overview.md b/docs/topics/security-legal/overview.md index c8b3773..37ae10f 100644 --- a/docs/topics/security-legal/overview.md +++ b/docs/topics/security-legal/overview.md @@ -1,16 +1,15 @@ --- title: Security & legal sidebar_label: Security & legal (hub) -description: Licenses, disclaimers, developer correspondence — links into wiki-import. +description: Licenses, disclaimers, and where canonical legal text lives for gregFramework. --- # Security & legal -Curated links into imported pages (canonical text may live under `wiki-import/`). +This wiki is a **community** documentation site. Binding license terms and policies are maintained **in the repositories**, not duplicated here as a second source of truth. -- [License / legal (EN)](/wiki/legacy/wiki-import/License-Legal) -- [Lizenz / Rechtliches (DE)](/wiki/legacy/wiki-import/Lizenz-Rechtliches) -- [Disclaimer (End user)](/wiki/legacy/wiki-import/EndUser/Reference/Disclaimer) -- [Brief an WASEKU](/wiki/legacy/wiki-import/Brief-an-WASEKU) / [Letter to WASEKU (EN)](/wiki/legacy/wiki-import/Letter-to-WASEKU) +- **Framework & core:** see [`LICENSE`](https://github.com/mleem97/gregFramework/blob/master/LICENSE.txt) and [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md) in [`mleem97/gregFramework`](https://github.com/mleem97/gregFramework). +- **This documentation site:** content is CC-BY-SA–style community material unless a file states otherwise; the wiki itself is not an official product of the game developer. +- **Support & conduct:** use [GitHub Issues](https://github.com/mleem97/gregFramework/issues) and [Discord](https://discord.gg/greg) under the project’s community guidelines. -For repository licensing, see the root `LICENSE.txt` in the GitHub repo. +For disclaimers about unofficial tooling, refer to the repository README and release notes packaged with builds. diff --git a/docs/topics/wiki-import/overview.md b/docs/topics/wiki-import/overview.md deleted file mode 100644 index 7edc484..0000000 --- a/docs/topics/wiki-import/overview.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Legacy wiki import -sidebar_label: Legacy wiki import -description: How GitHub Wiki content is mirrored into docs/legacy/wiki-import, sorted in the sidebar, and kept in sync with the repo. ---- - -# Legacy wiki import - -All material under **`docs/legacy/wiki-import/`** is part of the **GitHub Wiki mirror**: it tracks the wiki that lives alongside the repository, while the rest of **`docs/`** holds **curated** pages (guides, framework, reference). - -For a **map of the whole `docs/` tree**, see **[Documentation layout](../../getting-started/documentation-layout.md)**. - -## Why this exists - -- **Search & versioning**: Wiki text is in Git, reviewable in PRs, and indexed by the site. -- **i18n**: Paired `Page.md` (DE) + `Page-en.md` (EN) are split by `wiki:normalize-i18n` into the default locale and `i18n/de/.../legacy/wiki-import/`. -- **Sorting**: Audience trees (`EndUser/`, `ModDevs/`, `Contributors/`, `TechnicalReference/`, `DataCenterFAQ/`) use `_category_.json` **positions** so the sidebar order matches intent, not only A–Z. Root **`Home`** uses `sidebar_position: 1` so it appears first among loose pages. - -## Keep the mirror up to date - -1. Clone or pull the wiki repo into **`.wiki/`** at **`gregFramework/`** (sibling to your repo clones): - - ```bash - git clone https://github.com//.wiki.git .wiki - ``` - -2. From **`gregWiki/`** (the Docusaurus app): - - ```bash - npm run wiki:refresh - ``` - - This runs **`wiki:sync`** (copy `.wiki` → `docs/legacy/wiki-import/`) and then **`wiki:normalize-i18n`**. If `.wiki` is missing, `wiki:sync` exits with an error; run `wiki:normalize-i18n` alone only when you are fixing splits without pulling the wiki. - -3. Commit changes under **`docs/legacy/wiki-import/`** and **`i18n/de/.../legacy/wiki-import/`** as needed, then open a PR. - -## Editorial policy (recommended) - -| Goal | Action | -|------|--------| -| **Short-term fix** on the live site | Edit files under `docs/legacy/wiki-import/` (and DE mirror if applicable). Optionally backport to `.wiki` so the next sync does not overwrite you. | -| **Canonical, long-term doc** | Add or move content into **`docs/guides/`**, **`docs/reference/`**, or **`docs/framework/`**, and link from the legacy page. | -| **Duplicate path** | The folder **`Contirbutors/`** is a typo duplicate of **`Contributors/`**; prefer **`Contributors/`** for new links. | - -## Entry points (English default locale) - -- [Home](/wiki/legacy/wiki-import/Home) — audience hub. -- [End users](/wiki/legacy/wiki-import/EndUser/) · [Mod developers](/wiki/legacy/wiki-import/ModDevs/) · [Contributors](/wiki/legacy/wiki-import/Contributors/) -- [Technical reference](/wiki/legacy/wiki-import/TechnicalReference/) · [Data Center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/) -- [HOOKS](/wiki/legacy/wiki-import/HOOKS) · [FFI bridge reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference) - -The sidebar **Legacy** lists the **full** tree (autogenerated), not only these links. diff --git a/docusaurus.config.js b/docusaurus.config.js index 61dc3b0..10db676 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -58,11 +58,6 @@ const config = { return ['/docs']; } - // GitHub wiki mirror moved under /wiki/legacy/wiki-import/ - if (existingPath.startsWith('/wiki/legacy/wiki-import')) { - return [existingPath.replace('/wiki/legacy/wiki-import', '/wiki/wiki-import')]; - } - const redirectsToHere = { '/wiki/framework/architecture': ['/wiki/architecture'], '/wiki/framework/fmf-hooks': ['/wiki/fmf-hooks'], @@ -108,6 +103,27 @@ const config = { return undefined; }, redirects: [ + { + to: '/wiki/docs', + from: [ + '/wiki/legacy/wiki-import/Home', + '/wiki/wiki-import/Home', + '/wiki/legacy/wiki-import', + '/wiki/wiki-import', + ], + }, + { + to: '/wiki/guides/players/overview', + from: ['/wiki/legacy/wiki-import/EndUser/', '/wiki/wiki-import/EndUser/'], + }, + { + to: '/wiki/guides/mod-developers/overview', + from: ['/wiki/legacy/wiki-import/ModDevs/', '/wiki/wiki-import/ModDevs/'], + }, + { + to: '/wiki/guides/contributors/topics-overview', + from: ['/wiki/legacy/wiki-import/Contributors/', '/wiki/wiki-import/Contributors/'], + }, { to: '/wiki/mods/framework', from: ['/framework'], diff --git a/i18n/de/docusaurus-plugin-content-docs/current/intro.md b/i18n/de/docusaurus-plugin-content-docs/current/intro.md index 3e526c6..a01a30e 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/intro.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/intro.md @@ -11,10 +11,10 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a | Zielgruppe | Einstieg | |------------|----------| -| **Spieler** — installieren, spielen, Troubleshooting | [Endnutzer (Hub)](/wiki/guides/players/overview) · [Endnutzer-Wiki (Import)](/wiki/legacy/wiki-import/EndUser/) | -| **Moddevs** — Mods bauen, Hooks, Debugging | [Mod-Entwickler (Hub)](/wiki/guides/mod-developers/overview) · [ModDevs-Wiki (Import)](/wiki/legacy/wiki-import/ModDevs/) · [Framework](/wiki/mods/framework) | -| **Contributor** — PRs, Doku, Plugins, CI | [Contributors (Workflow)](/wiki/guides/contributors/topics-overview) · [Contributors-Wiki (Import)](/wiki/legacy/wiki-import/Contributors/) | -| **Sponsorinnen & Sponsoren** | [Sponsors (Hub)](/wiki/guides/sponsors/overview) · [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors) · [Sponsoren (DE)](/wiki/legacy/wiki-import/Sponsoren) | +| **Spieler** — installieren, spielen, Troubleshooting | [Endnutzer (Hub)](/wiki/guides/players/overview) · [Endnutzer-Workshop](/wiki/guides/players/enduser-workshop) | +| **Moddevs** — Mods bauen, Hooks, Debugging | [Mod-Entwickler (Hub)](/wiki/guides/mod-developers/overview) · [Framework](/wiki/mods/framework) · [FMF-Hooks](/wiki/framework/fmf-hooks) | +| **Contributor** — PRs, Doku, Plugins, CI | [Contributors (Workflow)](/wiki/guides/contributors/topics-overview) · [Contributor-Workshop](/wiki/guides/contributors/contributor-workshop) | +| **Sponsorinnen & Sponsoren** | [Sponsors (Hub)](/wiki/guides/sponsors/overview) · Lizenz & Richtlinien im GitHub-Repo (`LICENSE` / `CONTRIBUTING`) | **Erfahrungspfade** (Einsteiger → Profis): [Nach Zielgruppe](/wiki/guides/players/audiences-overview) → [Newbies](/wiki/audiences/newbies), [Intermediates](/wiki/audiences/intermediates), [Professionals](/wiki/audiences/professionals). diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AI-USAGE.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AI-USAGE.md deleted file mode 100644 index b4ab02e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AI-USAGE.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: AI-USAGE -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Architecture.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Architecture.md deleted file mode 100644 index cda72c2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Architecture.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Architecture -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AssetExport.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AssetExport.md deleted file mode 100644 index 3b143c3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/AssetExport.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: AssetExport -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md deleted file mode 100644 index 79850da..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Bekannte-Inkompatibilitaeten.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Bekannte Inkompatibilitäten -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Brief-an-WASEKU.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Brief-an-WASEKU.md deleted file mode 100644 index 718ac28..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Brief-an-WASEKU.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Brief an WASEKU (Data Center) -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versionen.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versionen.md deleted file mode 100644 index f82a1e6..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versionen.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Changelog & Versionen -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versions.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versions.md deleted file mode 100644 index 50362b9..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Changelog-Versions.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Changelog & Versions EN -description: Release history and versioning reference for FrikaMF. -sidebar_position: 180 -tags: - - audience:enduser - - audience:moddev - - audience:contributor - - audience:sponsor - - audience:gamedev ---- - -## Changelog & Versions - -Primary history: - -- [`CHANGELOG.md`](https://github.com/mleem97/gregFramework/blob/master/CHANGELOG.md) - -## Versioning - -- Framework format: `XX.XX.XXXX` -- Source of truth: `FrikaMF/ReleaseVersion.cs` - -## Release metadata commands - -```powershell -pwsh -ExecutionPolicy Bypass -File .\scripts\Update-ReleaseMetadata.ps1 -Bump major -pwsh -ExecutionPolicy Bypass -File .\scripts\Update-ReleaseMetadata.ps1 -Bump medium -pwsh -ExecutionPolicy Bypass -File .\scripts\Update-ReleaseMetadata.ps1 -Bump minor -``` - -## Example constants - -### 🦀 Rust - -```rust -pub const ABI_VERSION: u32 = 5; -``` - -### 🔷 C\# - -```csharp -public const uint API_VERSION = 5; -``` - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Community-Thanks.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Community-Thanks.md deleted file mode 100644 index e3b5a0f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Community-Thanks.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Community Thanks -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/Contributors-Debug.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/Contributors-Debug.md deleted file mode 100644 index 954d3dd..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/Contributors-Debug.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: Contributors (Debug) EN -description: Framework contributor setup, hook workflow, conventions, CI behavior, and PR checklist. -sidebar_position: 140 -tags: - - audience:contributor ---- - -## Contributors (Debug) - -This page is for contributors working on FrikaMF itself. - -For the complete and maintainable feature matrix with implementation use cases, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases). - -## Dev setup - -```powershell -dotnet build .\framework\framework/FrikaMF.csproj -c Debug -nologo -cargo build --release -``` - -Optional game path override: - -```powershell -dotnet build .\framework\framework/FrikaMF.csproj /p:GameDir="C:\Path\To\Data Center" -``` - -## Add a new hook workflow - -1. Find target in dnSpy/dotPeek. -2. Update `HOOKS.md`. -3. Add Harmony patch. -4. Add event id + dispatch wiring. -5. Add/update Rust ABI event handling if needed. -6. Test locally. -7. Open PR. - -## Conventions - -- Keep ABI structs blittable. -- Keep wrappers in framework, gameplay policy in mods. -- Use stable event names and explicit contracts. - -## IL2CPP pitfalls - -- `b###` compiler-generated members are unstable. -- Coroutine state-machine types (`d##`) are unstable. -- Prefer Postfix first unless behavior blocking is required. - -## Lua/Python/Web FFI contributor notes - -Current core status: - -- Rust native FFI bridge: implemented. -- Built-in Lua runtime host: not implemented. -- Built-in Python runtime host: not implemented. -- Built-in generic HTTP/WebSocket FFI transport: not implemented. - -Contribution guidance: - -- Treat Lua/Python as sidecar integration work unless core runtime hosting is explicitly added. -- Keep Unity and IL2CPP access constrained to C#/Rust boundaries. -- If adding transport, define strict command schemas, authentication for non-local access, and rate limits. - -## CI behavior - -- CI runs without game installation. -- `$(CI)=true` skips local game reference validation. -- Local builds require MelonLoader-generated interop files. - -## PR checklist - -- [ ] `HOOKS.md` updated -- [ ] Build passes locally -- [ ] Docs updated -- [ ] Conventional Commits used - -## Example pair - -### 🦀 Rust - -```rust -#[repr(C)] -pub struct MoneyChanged { - pub old_value: i32, - pub new_value: i32, -} -``` - -### 🔷 C\# - -```csharp -[StructLayout(LayoutKind.Sequential)] -public struct MoneyChanged -{ - public int OldValue; - public int NewValue; -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/_category_.json deleted file mode 100644 index f1f28cb..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contirbutors/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Contributors (typo path — prefer Contributors/)", - "position": 60, - "key": "wiki-import-root-contributors-typo" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors-Debug.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors-Debug.md deleted file mode 100644 index 40d0ef2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors-Debug.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributors (Debug) EN - -This page was moved to: - -- [Contributors](Contributors/) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Contributors-Debug.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Contributors-Debug.md deleted file mode 100644 index 954d3dd..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Contributors-Debug.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: Contributors (Debug) EN -description: Framework contributor setup, hook workflow, conventions, CI behavior, and PR checklist. -sidebar_position: 140 -tags: - - audience:contributor ---- - -## Contributors (Debug) - -This page is for contributors working on FrikaMF itself. - -For the complete and maintainable feature matrix with implementation use cases, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases). - -## Dev setup - -```powershell -dotnet build .\framework\framework/FrikaMF.csproj -c Debug -nologo -cargo build --release -``` - -Optional game path override: - -```powershell -dotnet build .\framework\framework/FrikaMF.csproj /p:GameDir="C:\Path\To\Data Center" -``` - -## Add a new hook workflow - -1. Find target in dnSpy/dotPeek. -2. Update `HOOKS.md`. -3. Add Harmony patch. -4. Add event id + dispatch wiring. -5. Add/update Rust ABI event handling if needed. -6. Test locally. -7. Open PR. - -## Conventions - -- Keep ABI structs blittable. -- Keep wrappers in framework, gameplay policy in mods. -- Use stable event names and explicit contracts. - -## IL2CPP pitfalls - -- `b###` compiler-generated members are unstable. -- Coroutine state-machine types (`d##`) are unstable. -- Prefer Postfix first unless behavior blocking is required. - -## Lua/Python/Web FFI contributor notes - -Current core status: - -- Rust native FFI bridge: implemented. -- Built-in Lua runtime host: not implemented. -- Built-in Python runtime host: not implemented. -- Built-in generic HTTP/WebSocket FFI transport: not implemented. - -Contribution guidance: - -- Treat Lua/Python as sidecar integration work unless core runtime hosting is explicitly added. -- Keep Unity and IL2CPP access constrained to C#/Rust boundaries. -- If adding transport, define strict command schemas, authentication for non-local access, and rate limits. - -## CI behavior - -- CI runs without game installation. -- `$(CI)=true` skips local game reference validation. -- Local builds require MelonLoader-generated interop files. - -## PR checklist - -- [ ] `HOOKS.md` updated -- [ ] Build passes locally -- [ ] Docs updated -- [ ] Conventional Commits used - -## Example pair - -### 🦀 Rust - -```rust -#[repr(C)] -pub struct MoneyChanged { - pub old_value: i32, - pub new_value: i32, -} -``` - -### 🔷 C\# - -```csharp -[StructLayout(LayoutKind.Sequential)] -public struct MoneyChanged -{ - public int OldValue; - public int NewValue; -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md deleted file mode 100644 index e0c0c77..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Contribution-Workflow.md +++ /dev/null @@ -1,9 +0,0 @@ -# Contribution Workflow EN - -## Quick Flow - -1. Create a branch. -2. Keep changes small and atomic. -3. Use Conventional Commits. -4. Update docs and links together. -5. Open a PR with a clear description. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Index.md deleted file mode 100644 index 6d21294..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Guides Index EN - -- [Contribution Workflow EN](Contribution-Workflow) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/_category_.json deleted file mode 100644 index b2d26ee..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-contributors-guides" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Index.md deleted file mode 100644 index 58c87bc..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Contributors Index EN - -Audience: contributors working on framework code and docs. - -## Contents - -- [Contribution Workflow EN](Guides/Contribution-Workflow) -- [Naming Convention EN](Reference/Naming-Convention) -- [Troubleshooting EN](Troubleshooting/overview) -- [AI Usage Policy](../AI-USAGE) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Index.md deleted file mode 100644 index 541b718..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Index EN - -- [Naming Convention EN](Naming-Convention) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Naming-Convention.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Naming-Convention.md deleted file mode 100644 index 8b07667..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/Naming-Convention.md +++ /dev/null @@ -1,12 +0,0 @@ -# Naming Convention EN - -## Unified Standard - -- Folders: `PascalCase` -- Files: `Title-Case-Kebab.md` -- English mirror: `-en` suffix (`Page-Name-en.md`) - -## Examples - -- `EndUser/Guides/Framework-Dependency.md` -- `EndUser/Guides/Framework-Dependency-en.md` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/_category_.json deleted file mode 100644 index 1c22f38..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-contributors-reference" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/Index.md deleted file mode 100644 index d77038f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Troubleshooting Index EN - -- [Troubleshooting EN](overview) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/_category_.json deleted file mode 100644 index d86d79e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-contributors-troubleshooting" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/overview.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/overview.md deleted file mode 100644 index fb883b9..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/Troubleshooting/overview.md +++ /dev/null @@ -1,12 +0,0 @@ -# Troubleshooting EN - -## Common Contributor Issues - -- Outdated links after restructuring -- Inconsistent file names -- Non-atomic commits - -## Fix - -- Always update sidebar and redirect pages together. -- Apply naming convention consistently. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/_category_.json deleted file mode 100644 index 7800653..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Contributors/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Contributors", - "position": 30, - "key": "wiki-import-root-contributors" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Index.md deleted file mode 100644 index dbe10be..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Data Center FAQ -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-1.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-1.md deleted file mode 100644 index fd0492d..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-1.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Frequently Asked Questions Part 1 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-2.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-2.md deleted file mode 100644 index b365b4e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-2.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Frequently Asked Questions Part 2 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-3.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-3.md deleted file mode 100644 index 1fcbac3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Part-3.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Frequently Asked Questions Part 3 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md deleted file mode 100644 index ff89c67..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/Patch-Panel.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Patch Panel -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/_category_.json deleted file mode 100644 index 755e790..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/DataCenterFAQ/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Data Center FAQ", - "position": 50, - "key": "wiki-import-root-dc-faq" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Device-Reference.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Device-Reference.md deleted file mode 100644 index b466317..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Device-Reference.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Device-Reference -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/End-User-Release.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/End-User-Release.md deleted file mode 100644 index e52693c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/End-User-Release.md +++ /dev/null @@ -1,5 +0,0 @@ -# End-User (Release) EN - -This page was moved to: - -- [EndUser](EndUser/) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/End-User-Release.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/End-User-Release.md deleted file mode 100644 index da55472..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/End-User-Release.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: End-User (Release) EN -description: Installation, updates, troubleshooting, and uninstall guide for players using FrikaMF as a dependency. -sidebar_position: 120 -tags: - - audience:enduser ---- - -## End-User (Release) - -This page is for players who do **not** develop mods and only install FrikaMF because another mod depends on it. - -For a complete overview of framework capabilities and setup flows, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases). - -## What you install - -- `FrikaModdingFramework.dll` is a runtime framework for `Data Center`. -- It provides stable runtime glue required by other mods. -- FrikaMF is **unofficial** and **community-driven**. - -## Quick install - -1. Install MelonLoader (IL2CPP, latest stable). -2. Launch the game once, then close it. -3. Put `FrikaModdingFramework.dll` into `Data Center/Mods`. -4. Put your actual mod into `Data Center/Mods`. -5. Start the game and verify `MelonLoader/Latest.log`. - -## Troubleshooting - -- Game crashes at startup: check `MelonLoader/Latest.log` for missing DLL/type errors. -- Mod not loading: verify correct folder and unblock files in Windows file properties. -- After game update: check compatibility page and wait for updated releases if hooks changed. - -## Update - -1. Close game. -2. Replace `FrikaModdingFramework.dll`. -3. Start game and verify logs. - -## Uninstall - -1. Close game. -2. Remove `FrikaModdingFramework.dll` from `Mods`. -3. Remove dependent mods. - -## Related pages - -- [Home EN](../Home) -- [ModDevs EN](../ModDevs/) -- [Contributors EN](../Contributors/) -- [FFI Bridge Reference](../FFI-Bridge-Reference) -- [Web UI Bridge EN (DC2WEB)](../Web-UI-Bridge) -- [Known Incompatibilities EN](../Known-Incompatibilities) - -## Minimal context example (both language tracks) - -### 🦀 Rust - -```rust -#[no_mangle] -pub extern "C" fn mod_info() -> *const i8 { - b"example-rust\0".as_ptr() as *const i8 -} -``` - -### 🔷 C\# - -```csharp -using MelonLoader; - -public sealed class ExampleMod : MelonMod -{ - public override void OnInitializeMelon() - { - LoggerInstance.Msg("Example C# mod loaded"); - } -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md deleted file mode 100644 index 920d6f7..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Framework-Dependency.md +++ /dev/null @@ -1,17 +0,0 @@ -# Framework Dependency Usage EN - -## Goal - -Use FrikaMF as a stable runtime dependency for custom mods. - -## Steps - -1. Place `FrikaModdingFramework.dll` in your `Mods` folder. -2. Build your mod with runtime dependency checks. -3. Disable gracefully if the dependency is missing. - -## Next Pages - -- [FAQ EN](../Troubleshooting/FAQ) -- [Troubleshooting EN](../Troubleshooting/overview) -- [Disclaimer EN](../Reference/Disclaimer) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Index.md deleted file mode 100644 index 1ff7730..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Guides Index EN - -- [Framework Dependency Usage EN](Framework-Dependency) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/_category_.json deleted file mode 100644 index 9264a97..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-enduser-guides" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Index.md deleted file mode 100644 index b8e7c82..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Index.md +++ /dev/null @@ -1,11 +0,0 @@ -# EndUser Index EN - -Audience: users who want to use FrikaMF as a dependency. - -## Contents - -- [Framework Dependency Usage EN](Guides/Framework-Dependency) -- [FAQ EN](Troubleshooting/FAQ) -- [Troubleshooting EN](Troubleshooting/overview) -- [Disclaimer EN](Reference/Disclaimer) -- [AI Usage Policy](../AI-USAGE) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Disclaimer.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Disclaimer.md deleted file mode 100644 index 52ae3f2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Disclaimer.md +++ /dev/null @@ -1,11 +0,0 @@ -# Disclaimer EN - -- FrikaMF is unofficial and community-driven. -- Use at your own risk. -- No compatibility guarantees after game updates. -- No affiliation with WASEKU. - -## Policies - -- [AI Usage Policy (Wiki)](../../AI-USAGE) -- [AI Usage Policy (Root)](/wiki/legacy/wiki-import/AI-USAGE) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Index.md deleted file mode 100644 index 4303c95..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Index EN - -- [Disclaimer EN](Disclaimer) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/_category_.json deleted file mode 100644 index 5d3cab7..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-enduser-reference" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md deleted file mode 100644 index b92f1cc..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/FAQ.md +++ /dev/null @@ -1,13 +0,0 @@ -# FAQ EN - -## Do I need Rust and C# together? - -No. You can choose one language. - -## Where is the framework DLL? - -`Data Center/Mods/FrikaModdingFramework.dll` - -## My mod is not loading - -See [Troubleshooting EN](overview). diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/Index.md deleted file mode 100644 index 137fa35..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/Index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Troubleshooting Index EN - -- [FAQ EN](FAQ) -- [Troubleshooting EN](overview) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/_category_.json deleted file mode 100644 index 9d296a4..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-enduser-troubleshooting" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/overview.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/overview.md deleted file mode 100644 index 4b34006..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/Troubleshooting/overview.md +++ /dev/null @@ -1,13 +0,0 @@ -# Troubleshooting EN - -## Standard Checks - -1. Check `MelonLoader/Latest.log`. -2. Verify game/FrikaMF/mod versions. -3. Confirm `FrikaModdingFramework.dll` is available. - -## Common Errors - -- `MissingMethodException` -- `TypeLoadException` -- Missing runtime dependency diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/_category_.json deleted file mode 100644 index cf235ff..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/EndUser/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "End users", - "position": 10, - "key": "wiki-import-root-enduser" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/FFI-Bridge-Reference.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/FFI-Bridge-Reference.md deleted file mode 100644 index 07d6f46..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/FFI-Bridge-Reference.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: FFI-Bridge-Reference -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Framework-Features-Use-Cases.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Framework-Features-Use-Cases.md deleted file mode 100644 index d542ead..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Framework-Features-Use-Cases.md +++ /dev/null @@ -1,7 +0,0 @@ -# Framework Features & Use Cases EN - -English mirror page. - -The maintained canonical page is currently: - -- [Framework Features & Use Cases](/wiki/legacy/wiki-import/Framework-Features-Use-Cases) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossar.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossar.md deleted file mode 100644 index df1c5d0..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossar.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Glossar -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossary.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossary.md deleted file mode 100644 index 9a4ae5f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Glossary.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Glossary EN -description: FrikaMF and IL2CPP terminology for all audiences. -sidebar_position: 170 -tags: - - audience:enduser - - audience:moddev - - audience:contributor - - audience:sponsor - - audience:gamedev ---- - -## Glossary - -### IL2CPP - -Unity backend converting managed code to native binaries. - -### Interop Assembly - -Generated assemblies exposing metadata/signatures for `Il2Cpp.*` access. - -### HarmonyX - -Runtime patching framework for Prefix/Postfix/Transpiler patterns. - -### C-ABI - -Stable binary boundary for C# ↔ Rust interoperability. - -### Blittable Types - -Types copied between managed/unmanaged memory without transformation. - -### RID/Token - -Metadata identifiers useful for traceability but limited in IL2CPP runtime mapping. - -### Example pair - -#### 🦀 Rust - -```rust -#[repr(C)] -pub struct TickInfo { - pub dt: f32, -} -``` - -#### 🔷 C\# - -```csharp -[StructLayout(LayoutKind.Sequential)] -public struct TickInfo -{ - public float Dt; -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOK-NAMING-CONVENTION.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOK-NAMING-CONVENTION.md deleted file mode 100644 index 8e94da3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOK-NAMING-CONVENTION.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: HOOK-NAMING-CONVENTION -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOKS.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOKS.md deleted file mode 100644 index b7e9394..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/HOOKS.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: HOOKS -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Home.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Home.md deleted file mode 100644 index c7034a1..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Home.md +++ /dev/null @@ -1,2 +0,0 @@ -Welcome to the FrikaModFramework wiki! -The Wiki was moved to [OUR OFFICIAL WEBSITE](https://gregframework.eu) \ No newline at end of file diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Known-Incompatibilities.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Known-Incompatibilities.md deleted file mode 100644 index 0efc1a0..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Known-Incompatibilities.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Known Incompatibilities EN -description: Known breakages after game updates and recommended mitigation steps. -sidebar_position: 190 -tags: - - audience:enduser - - audience:moddev - - audience:contributor - - audience:sponsor - - audience:gamedev ---- - -## Known Incompatibilities - -Game updates may change signatures and hook points, breaking framework-level patches. - -## Common symptoms - -- `MissingMethodException` -- `TypeLoadException` -- Harmony patch not firing -- Runtime regressions in modded flows - -## Immediate checks - -1. Capture `MelonLoader/Latest.log`. -2. Confirm game/framework/mod versions. -3. Review [`HOOKS.md`](/wiki/legacy/wiki-import/HOOKS) and compatibility notes. - -## Compatibility matrix template - -| Game Version | FrikaMF Version | Status | Notes | -| :--- | :--- | :--- | :--- | -| TBD | TBD | Unverified | Update after smoke validation | - -## Example diagnostics - -### 🦀 Rust - -```rust -#[no_mangle] -pub extern "C" fn mod_on_scene_loaded(scene_name: *const i8) { - if scene_name.is_null() { - return; - } -} -``` - -### 🔷 C\# - -```csharp -public override void OnSceneWasLoaded(int buildIndex, string sceneName) -{ - LoggerInstance.Msg($"Scene={sceneName}, Build={buildIndex}"); -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Letter-to-WASEKU.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Letter-to-WASEKU.md deleted file mode 100644 index d10cfaf..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Letter-to-WASEKU.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Letter to WASEKU EN -description: Open technical letter to the game developer about FrikaMF scope, safety posture, and cooperation. -sidebar_position: 160 -tags: - - audience:gamedev ---- - -## Letter to WASEKU (Data Center) - -FrikaMF is an **unofficial**, community-driven interoperability framework for `Data Center` modding. - -## Intent - -- Improve player experience in offline/singleplayer modding contexts. -- Reduce fragile ad-hoc patches via shared interfaces. -- Keep behavior transparent and documented. - -## Explicit non-goals - -- No anti-cheat bypass objective. -- No exploit tooling for competitive advantage. - -## Legal interoperability context - -- EU Software Directive Art. 6 -- German UrhG § 69e - -## Cooperation offer - -We are open to discussing stable modding surfaces or future official API opportunities. - -## Contact - -- `https://github.com/mleem97/gregFramework` - -## Technical sample - -### 🦀 Rust - -```rust -#[no_mangle] -pub extern "C" fn mod_on_scene_loaded(_scene: *const i8) {} -``` - -### 🔷 C\# - -```csharp -using MelonLoader; - -public sealed class SceneObserver : MelonMod -{ - public override void OnSceneWasLoaded(int buildIndex, string sceneName) - { - LoggerInstance.Msg($"Scene: {sceneName}"); - } -} -``` - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/License-Legal.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/License-Legal.md deleted file mode 100644 index 7884349..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/License-Legal.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: License & Legal EN -description: License model, disclaimers, and interoperability legal context. -sidebar_position: 200 -tags: - - audience:enduser - - audience:moddev - - audience:contributor - - audience:sponsor - - audience:gamedev ---- - -## License & Legal - -- License terms: [`LICENSE.txt`](https://github.com/mleem97/gregFramework/blob/master/LICENSE.txt) -- FrikaMF is unofficial and community-driven. -- No affiliation with WASEKU. - -## Disclaimer - -Use at your own risk. Compatibility is not guaranteed across future game updates. - -## Interoperability basis - -- EU Software Directive Article 6 -- German UrhG § 69e - -## Compliance guidance - -- No anti-cheat bypass intent. -- No unauthorized redistribution of protected content. -- No exploit-focused competitive abuse. - -## Shutdown examples - -### 🦀 Rust - -```rust -#[no_mangle] -pub extern "C" fn mod_shutdown() {} -``` - -### 🔷 C\# - -```csharp -public override void OnApplicationQuit() -{ - LoggerInstance.Msg("Framework shutdown"); -} -``` - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lizenz-Rechtliches.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lizenz-Rechtliches.md deleted file mode 100644 index b666fe3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lizenz-Rechtliches.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Lizenz & Rechtliches -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lua-FFI-Start-Developing.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lua-FFI-Start-Developing.md deleted file mode 100644 index 06167e3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Lua-FFI-Start-Developing.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Lua-FFI-Start-Developing -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_FINAL_STATUS.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_FINAL_STATUS.md deleted file mode 100644 index aa32e7e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_FINAL_STATUS.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: MODIAPI_FINAL_STATUS -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md deleted file mode 100644 index fa6ba1e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MODIAPI_INTEGRATION_SUMMARY.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: MODIAPI_INTEGRATION_SUMMARY -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MelonLoader.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MelonLoader.md deleted file mode 100644 index 2cee812..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/MelonLoader.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: MelonLoader -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Config-System.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Config-System.md deleted file mode 100644 index 86559d7..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Config-System.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Mod-Config-System -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Developer-Debug.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Developer-Debug.md deleted file mode 100644 index 400be66..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Mod-Developer-Debug.md +++ /dev/null @@ -1,5 +0,0 @@ -# Mod-Developer (Debug) EN - -This page was moved to: - -- [ModDevs](ModDevs/) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Getting-Started.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Getting-Started.md deleted file mode 100644 index dc312ca..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Getting-Started.md +++ /dev/null @@ -1,13 +0,0 @@ -# Getting Started EN - -## Steps - -1. Build FrikaMF locally (`dotnet build`). -2. Create your mod project. -3. Validate runtime dependency on `FrikaModdingFramework`. -4. Use hooks/events from the reference pages. - -## Next - -- [Hook Event Reference EN](../Reference/Hook-Event-Reference) -- [Troubleshooting EN](../Troubleshooting/overview) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Index.md deleted file mode 100644 index 08f9b11..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Guides Index EN - -- [Getting Started EN](Getting-Started) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/_category_.json deleted file mode 100644 index 6061c4c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-moddevs-guides" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Index.md deleted file mode 100644 index e4a6954..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Index.md +++ /dev/null @@ -1,10 +0,0 @@ -# ModDevs Index EN - -Audience: developers building mods on top of FrikaMF. - -## Contents - -- [Getting Started EN](Guides/Getting-Started) -- [Hook Event Reference EN](Reference/Hook-Event-Reference) -- [Troubleshooting EN](Troubleshooting/overview) -- [AI Usage Policy](../AI-USAGE) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md deleted file mode 100644 index 04fccb7..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Mod-Developer-Debug.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: Mod-Developer (Debug) EN -description: Rust vs C# decision guide, getting started for both tracks, hook discovery, architecture, and API orientation. -sidebar_position: 130 -tags: - - audience:moddev ---- - -## Mod-Developer (Debug) - -You only need one track: **Rust** or **C#**. FrikaMF bridges runtime communication. - -Full framework capability catalog with setup guides: [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases). - -## Rust vs C# decision guide - -| Criteria | 🔷 C# Track | 🦀 Rust Track | -| --- | --- | --- | -| Onboarding speed | Fast | Medium | -| Direct Unity/Il2Cpp access | Strong | Indirect | -| Native-level control | Medium | High | -| Safety model | Medium | High | -| Recommended for | Most gameplay mods | Performance/ABI-heavy systems | - -## Lua/Python/Web FFI status - -- Rust FFI in framework core: **implemented**. -- Built-in Lua runtime host: **not implemented**. -- Built-in Python runtime host: **not implemented**. -- Built-in generic HTTP/WebSocket FFI transport: **not implemented**. - -Recommended approach: - -- Run Lua/Python as a sidecar process and connect through your C# or Rust mod boundary. -- Use framework events as stable inputs and framework APIs as safe outputs. -- Keep Unity/IL2CPP object access in C# or Rust layers. - -For full DE/EN step-by-step tutorials per FFI entrypoint, see: - -- [Lua FFI — How to Start Developing (DE + EN)](/wiki/legacy/wiki-import/Lua-FFI-Start-Developing) - -## Architecture - -```text -Data Center (IL2CPP) - ↓ HarmonyX Patch -FrikaMF C# Bridge (Il2Cpp objects -> C-ABI structs) - ↓ P/Invoke / C-ABI ↓ MelonLoader API -Rust Mod (.dll) C# Mod (.dll) -``` - -## Source of truth for hooks - -- [`HOOKS.md`](../HOOKS) - -## C# track quick start - -```powershell -dotnet build .\framework\framework/FrikaMF.csproj /p:GameDir="C:\Path\To\Data Center" -``` - -```csharp -using HarmonyLib; -using MelonLoader; -using Il2Cpp; - -[HarmonyPatch(typeof(Server), nameof(Server.PowerButton))] -public static class Patch_Server_PowerButton -{ - public static void Prefix(Server __instance) - { - MelonLogger.Msg($"Server power toggle: {__instance.name}"); - } -} -``` - -## Rust track quick start - -```powershell -cargo build --release -``` - -```rust -#[no_mangle] -pub extern "C" fn mod_init(_api_table: *mut core::ffi::c_void) -> bool { - true -} -``` - -## dnSpy / dotPeek guidance - -- Open generated `Assembly-CSharp.dll` interop output. -- Validate signatures and call context. -- Document candidates in `HOOKS.md`. -- Implement Harmony patch and event dispatch. - -## Why many IL2CPP interop methods look empty - -Interop assemblies often contain metadata-facing stubs; real implementation lives in native IL2CPP binaries. - -## Web FFI vs Web UI (important) - -- `DC2WebBridge` provides Unity-side UI adaptation/styling. -- It is not a generic network FFI transport bus. -- For Web FFI, implement your own HTTP/WebSocket gateway with validation and rate limits. - -Config API reference: [`Mod Config System`](/wiki/legacy/wiki-import/Mod-Config-System) - -## Cross-track example - -### 🦀 Rust - -```rust -#[no_mangle] -pub extern "C" fn mod_on_event(event_id: u32, _ptr: *const u8, _len: u32) { - if event_id == 1001 { - } -} -``` - -### 🔷 C\# - -```csharp -[HarmonyPatch(typeof(CustomerBase), nameof(CustomerBase.AreAllAppRequirementsMet))] -public static class Patch_Requirements -{ - public static void Postfix(bool __result) - { - MelonLogger.Msg($"Requirements met: {__result}"); - } -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Modding-Guide.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Modding-Guide.md deleted file mode 100644 index b9fdaae..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Modding-Guide.md +++ /dev/null @@ -1,8 +0,0 @@ -# Modding Guide EN - -English mirror page. - -The maintained canonical page is currently: - -- [Modding Guide](Modding-Guide) -- [Lua FFI — How to Start Developing (DE + EN)](/wiki/legacy/wiki-import/Lua-FFI-Start-Developing) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md deleted file mode 100644 index 437ae85..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Hook-Event-Reference.md +++ /dev/null @@ -1,10 +0,0 @@ -# Hook Event Reference EN - -Primary source: - -- [HOOKS](../../HOOKS) -- [Hook Naming Convention](../../HOOK-NAMING-CONVENTION) - -Additional: - -- [FFI Bridge Reference](../../FFI-Bridge-Reference) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Index.md deleted file mode 100644 index e70c47b..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Index EN - -- [Hook Event Reference EN](Hook-Event-Reference) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/_category_.json deleted file mode 100644 index 337f76e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-moddevs-reference" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/Index.md deleted file mode 100644 index d77038f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Troubleshooting Index EN - -- [Troubleshooting EN](overview) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json deleted file mode 100644 index 0979ace..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-moddevs-troubleshooting" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/overview.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/overview.md deleted file mode 100644 index 2baaacb..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/Troubleshooting/overview.md +++ /dev/null @@ -1,7 +0,0 @@ -# Troubleshooting EN - -## Verify - -1. Validate hook signatures against `HOOKS`. -2. Check `MelonLoader/Latest.log` and framework logs. -3. Match game version and FrikaMF version. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/_category_.json deleted file mode 100644 index f44538f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModDevs/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Mod developers", - "position": 20, - "key": "wiki-import-root-moddevs" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Modding-Guide.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Modding-Guide.md deleted file mode 100644 index a5b7207..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Modding-Guide.md +++ /dev/null @@ -1,5 +0,0 @@ -# Modding Guide EN - -This page was moved to: - -- [ModDevs/Guides/Getting-Started](ModDevs/Guides/Getting-Started) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModigAPI-Consolidation.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModigAPI-Consolidation.md deleted file mode 100644 index cba32da..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ModigAPI-Consolidation.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: ModigAPI-Consolidation -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/README_MODDING.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/README_MODDING.md deleted file mode 100644 index 83e565c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/README_MODDING.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: README_MODDING -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ROADMAP.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ROADMAP.md deleted file mode 100644 index a39d2ff..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ROADMAP.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: ROADMAP -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Release-Assets-and-Templates.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Release-Assets-and-Templates.md deleted file mode 100644 index a81d1d9..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Release-Assets-and-Templates.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Release Assets and Templates -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Repository-Status-2026-04-04.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Repository-Status-2026-04-04.md deleted file mode 100644 index bc901ef..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Repository-Status-2026-04-04.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Repository Status 2026-04-04 -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Setup.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Setup.md deleted file mode 100644 index d567901..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Setup.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Setup -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsoren.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsoren.md deleted file mode 100644 index 6b4e6a6..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsoren.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Sponsoren -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsors.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsors.md deleted file mode 100644 index 0f88940..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Sponsors.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Sponsors EN -description: Why FrikaMF sponsorship matters, support options, and where funding is used. -sidebar_position: 150 -tags: - - audience:sponsor ---- - -## Sponsors - -FrikaMF is an unofficial, community-driven framework that improves modding stability for `Data Center`. - -## Why support this project - -- Faster compatibility recovery after game updates -- Better documentation and onboarding -- Shared runtime standards for mod authors - -## Sponsorship options - -- GitHub Sponsors -- Ko-fi (optional) -- One-time or recurring contributions - -## Funding usage - -- Maintenance and compatibility work -- Tooling/CI and release infrastructure -- Documentation quality - -## Technical context sample - -### 🦀 Rust - -```rust -#[no_mangle] -pub extern "C" fn mod_update(_dt: f32) {} -``` - -### 🔷 C\# - -```csharp -using MelonLoader; - -public sealed class SponsorDemoMod : MelonMod -{ - public override void OnUpdate() {} -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/StandaloneMods.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/StandaloneMods.md deleted file mode 100644 index ec8a08b..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/StandaloneMods.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Standalone Mods -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md deleted file mode 100644 index 4544cf1..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Steamworks-P2P-Multiplayer-Roadmap.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Steamworks-P2P-Multiplayer-Roadmap -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TASKLIST.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TASKLIST.md deleted file mode 100644 index b736074..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TASKLIST.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: TASKLIST -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/Index.md deleted file mode 100644 index 12007d4..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/Index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Guides Index EN - -- [Setup](../../Setup) -- [Lua FFI Start Developing](../../Lua-FFI-Start-Developing) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/_category_.json deleted file mode 100644 index 1eb988d..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Guides/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-techref-guides" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Index.md deleted file mode 100644 index 2534bcd..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Index.md +++ /dev/null @@ -1,11 +0,0 @@ -# TechnicalReference Index EN - -Core technical reference for hooks, runtime bridges, and API contracts. - -## Contents - -- [Hooks](../HOOKS) -- [Hook Naming Convention](../HOOK-NAMING-CONVENTION) -- [FFI Bridge Reference](../FFI-Bridge-Reference) -- [Framework Features & Use Cases EN](../Framework-Features-Use-Cases) -- [Architecture](../Architecture) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/Index.md deleted file mode 100644 index c12386c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/Index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Reference Index EN - -- [Architecture](../../Architecture) -- [FFI Bridge Reference](../../FFI-Bridge-Reference) -- [HOOKS](../../HOOKS) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/_category_.json deleted file mode 100644 index 8c6c7d5..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Reference/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-techref-reference" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md deleted file mode 100644 index 88cb02a..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/Index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Troubleshooting Index EN - -- [Known Incompatibilities EN](../../Known-Incompatibilities) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json deleted file mode 100644 index fba851c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/Troubleshooting/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "key": "wiki-import-techref-troubleshooting" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/_category_.json b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/_category_.json deleted file mode 100644 index 510e2bd..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/TechnicalReference/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Technical reference", - "position": 40, - "key": "wiki-import-root-techref" -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/WIKI-MOVED.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/WIKI-MOVED.md deleted file mode 100644 index e73dd27..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/WIKI-MOVED.md +++ /dev/null @@ -1 +0,0 @@ -The Wiki was moved to [OUR OFFICIAL WEBSITE](https://gregframework.eu) \ No newline at end of file diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Web-UI-Bridge.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Web-UI-Bridge.md deleted file mode 100644 index e2aecb0..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/Web-UI-Bridge.md +++ /dev/null @@ -1,89 +0,0 @@ -# Web UI Bridge (DC2WEB) EN - -Last updated: 2026-04-03 - -This page describes the framework web-style UI system (`DC2WebBridge`) and the in-game `Mod Settings` menu integration. - -## Overview - -- Entry point: `FrikaMF/DC2WebBridge.cs` -- Mod menu: `FrikaMF/ModSettingsMenuBridge.cs` -- Hook integration: `FrikaMF/HarmonyPatches.cs` - -Boundary: - -- `DC2WebBridge` is a Unity-side UI/styling bridge. -- `DC2WebBridge` is not a generic HTTP/WebSocket FFI transport layer. - -## What is currently supported - -- UI styling from `HTML`/`CSS` -- Utility styling frameworks: `TailwindCSS`, `SASS`/`SCSS` -- Script-style sources: `JavaScript` / `TypeScript` -- React-oriented adapter path: `React JSX/TSX` -- Image types: `SVG` (preferred), `PNG`, `JPG/JPEG`, `BMP`, `GIF`, `TGA` - -## In-game Mod Settings menu - -Clicking `Settings` in the main menu opens a chooser: - -- `Game Settings` -- `Mod Settings` - -The `Mod Settings` panel can toggle runtime options: - -- `DC2WEB Bridge enabled` -- `Unity UI Modernizer enabled` -- `Replace MainMenu Settings with Web overlay` - -## Image support and SVG strategy - -`DC2WebBridge` supports runtime sprite creation from `Dc2WebImageAsset`. - -- Raster images are loaded through Unity `Texture2D.LoadImage(...)`. -- SVG follows a prioritized path and is rasterized at runtime to the target size. - -Note: The internal SVG raster path is intentionally lightweight and focuses on common/simple shapes and fills. For advanced SVGs (complex paths, filters, masks), pre-bake assets in your mod pipeline and provide raster fallback. - -## From basic HTML to React-style apps - -The system is adapter-driven: - -- `Basic HTML/CSS`: direct translation into a Unity style profile -- `Tailwind/SASS`: translated into CSS variables/properties -- `JS/TS`: heuristic extraction for style fields (`backgroundColor`, `color`, `fontSize`, ...) -- `React`: adapter reads `className` and inline style-like content and translates to a profile - -### React support note - -The framework does not embed a full browser DOM/JS runtime. DC2WEB uses translation adapters that map web-like source bundles to Unity UI profiles and overlays. For larger app-like UIs, use a precompiled descriptor (`Dc2WebAppDescriptor`) with clear style and asset contracts. - -## Example: register a web app - -```csharp -DC2WebBridge.RegisterWebApp(new Dc2WebAppDescriptor -{ - ScreenKey = "MainMenuReact", - ReplaceExistingUi = true, - Framework = "react-ts", - Html = "

DC2WEB React UI

Runtime-translated app skin

", - Css = ":root{--panel-color:#111827dd;--text-color:#f9fafb;--accent:#60a5fa;}", - Script = "const App = () =>
React UI
;", -}); -``` - -## Recommended workflow - -1. Start with a simple `HTML/CSS` bundle. -2. Add `Tailwind/SASS` sources as needed. -3. Use `Dc2WebImageAsset` for icons/graphics (SVG-first). -4. For larger UI flows, move to app descriptor bundles (`React/TS`) with design tokens. -5. Tune behavior in-game through `Mod Settings`. - -## Related links - -- [Framework Features & Use Cases](/wiki/legacy/wiki-import/Framework-Features-Use-Cases) -- [FFI Bridge Reference](/wiki/legacy/wiki-import/FFI-Bridge-Reference) -- [Mod-Developer (Debug) EN](Mod-Developer-Debug) -- [Contributors (Debug) EN](Contributors-Debug) -- [Web UI Bridge (DC2WEB)](/wiki/legacy/wiki-import/Web-UI-Bridge) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/_Sidebar.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/_Sidebar.md deleted file mode 100644 index e73dd27..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/_Sidebar.md +++ /dev/null @@ -1 +0,0 @@ -The Wiki was moved to [OUR OFFICIAL WEBSITE](https://gregframework.eu) \ No newline at end of file diff --git a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ui.md b/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ui.md deleted file mode 100644 index 7f5d6d1..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/legacy/wiki-import/ui.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: ui -description: English translation pending; use the Deutsch locale for the full legacy page. ---- - -:::note -This page is available in **German** in the legacy wiki import. Use the language menu (**Deutsch**) for the full text, or contribute an English translation under `docs/wiki-import`. -::: - diff --git a/sidebars.js b/sidebars.js index 424000f..05e3c44 100644 --- a/sidebars.js +++ b/sidebars.js @@ -181,19 +181,6 @@ const sidebars = { }, ], }, - { - type: 'category', - label: 'Legacy', - link: {type: 'doc', id: 'legacy/index'}, - items: [ - 'legacy/index', - 'topics/wiki-import/overview', - { - type: 'autogenerated', - dirName: 'legacy/wiki-import', - }, - ], - }, 'SPONSORS', ], }; diff --git a/src/css/custom.css b/src/css/custom.css index 1e74b51..03a1c1f 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -147,7 +147,14 @@ body { color: var(--color-on-surface); } -.navbar__item .navbar__link { +.navbar__items--right { + display: flex; + align-items: center; + gap: 0.45rem; +} + +.navbar__item .navbar__link, +.navbar__item.navbar__link { font-family: var(--font-headline); font-weight: 500; letter-spacing: 0.06em; @@ -157,11 +164,13 @@ body { transition: color 0.25s ease; } -.navbar__item .navbar__link:hover { +.navbar__item .navbar__link:hover, +.navbar__item.navbar__link:hover { color: var(--color-on-surface); } -.navbar__item .navbar__link--active { +.navbar__item .navbar__link--active, +.navbar__item.navbar__link--active { color: var(--color-primary); box-shadow: inset 0 -2px 0 0 var(--color-primary); } @@ -175,41 +184,40 @@ body { display: inline-flex; align-items: center; justify-content: center; - width: 2.25rem; - height: 2.25rem; + min-width: 2.25rem; + min-height: 2.25rem; + padding: 0; border-radius: 999px; backdrop-filter: blur(12px); background: rgba(0, 30, 28, 0.65); box-shadow: inset 0 0 0 1px rgba(15, 81, 76, 0.15); } -.nav-icon-only { - color: transparent; -} - -.nav-icon-only::before { - font-size: 0.95rem; +.nav-right-icon.nav-icon-only { color: var(--color-on-surface-variant); } -.nav-link-mods::before { - content: '🧩'; +.nav-right-icon.nav-icon-only:hover, +.nav-right-icon.nav-icon-only:focus-visible { + color: var(--color-on-surface); } -.nav-link-discord::before { - content: '💬'; +.nav-icon-svg { + flex-shrink: 0; + display: block; + color: currentColor; } -.nav-link-support::before { - content: '🛟'; -} - -.nav-link-github::before { - content: '⌁'; -} - -.nav-locale::before { - content: '🌐'; +.nav-icon-sr-only { + position: absolute; + width: 1px; + height: 1px; + padding: 0; + margin: -1px; + overflow: hidden; + clip: rect(0, 0, 0, 0); + white-space: nowrap; + border: 0; } /* Editorial bleed + hero (homepage) */ @@ -423,11 +431,7 @@ body { /* Doc canvas — editorial bleed (wiki layout alignment); no hard section borders */ .theme-doc-wrapper { - background: linear-gradient( - 180deg, - var(--color-surface-container-low) 0%, - var(--color-background) 42% - ); + background: linear-gradient(180deg, var(--color-surface-container-low) 0%, var(--color-background) 42%); } .theme-doc-root .theme-doc-sidebar-container { @@ -562,27 +566,22 @@ body { color: var(--color-primary); } -.footer-link-icon { - position: relative; - padding-left: 1.4rem; +.footer-link-with-icon { + display: inline-flex; + align-items: center; + gap: 0.4rem; } -.footer-link-icon::before { - position: absolute; - left: 0; - opacity: 0.9; +.footer-icon-svg { + flex-shrink: 0; + opacity: 0.85; + color: rgba(192, 252, 246, 0.45); + transition: color 0.2s ease, opacity 0.2s ease; } -.footer-link-github::before { - content: '⌁'; -} - -.footer-link-discord::before { - content: '💬'; -} - -.footer-link-support::before { - content: '🛟'; +.footer__link-item:hover .footer-icon-svg { + opacity: 1; + color: var(--color-primary); } .button.button--primary { diff --git a/src/i18n/homepage/sharedLinks.ts b/src/i18n/homepage/sharedLinks.ts index 396a4ac..86fbb0f 100644 --- a/src/i18n/homepage/sharedLinks.ts +++ b/src/i18n/homepage/sharedLinks.ts @@ -36,12 +36,12 @@ export const sharedWorkflowLinksEn: HomepageDocLink[] = [ { title: 'End-user docs', description: 'Install, update, and troubleshooting paths.', - link: '/wiki/legacy/wiki-import/EndUser/End-User-Release', + link: '/wiki/guides/players/overview', }, { title: 'Mod developer docs', description: 'Setup, debugging, and hook integration.', - link: '/wiki/legacy/wiki-import/ModDevs/Mod-Developer-Debug', + link: '/wiki/guides/mod-developers/overview', }, { title: 'Repo inventory', @@ -95,12 +95,12 @@ export const sharedWorkflowLinksDe: HomepageDocLink[] = [ { title: 'Endnutzer-Doku', description: 'Installation, Updates und Fehlerbehebung.', - link: '/wiki/legacy/wiki-import/EndUser/End-User-Release', + link: '/wiki/guides/players/overview', }, { title: 'Mod-Entwickler-Doku', description: 'Setup, Debugging und Hook-Integration.', - link: '/wiki/legacy/wiki-import/ModDevs/Mod-Developer-Debug', + link: '/wiki/guides/mod-developers/overview', }, { title: 'Repo-Inventar', diff --git a/src/theme/Footer/LinkItem/index.tsx b/src/theme/Footer/LinkItem/index.tsx new file mode 100644 index 0000000..59b8962 --- /dev/null +++ b/src/theme/Footer/LinkItem/index.tsx @@ -0,0 +1,63 @@ +/** + * Swizzled: community footer links use react-icons instead of emoji/CSS pseudo-elements. + */ +import React, {type ReactNode} from 'react'; +import clsx from 'clsx'; +import Link from '@docusaurus/Link'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import isInternalUrl from '@docusaurus/isInternalUrl'; +import IconExternalLink from '@theme/Icon/ExternalLink'; +import type {Props} from '@theme/Footer/LinkItem'; +import {FaDiscord, FaGithub, FaLifeRing} from 'react-icons/fa6'; + +const footerIconProps = { + className: 'footer-icon-svg', + 'aria-hidden': true as const, + size: 14, +}; + +function getFooterIcon(className?: string): ReactNode | null { + if (!className) { + return null; + } + if (className.includes('footer-link-github')) { + return ; + } + if (className.includes('footer-link-discord')) { + return ; + } + if (className.includes('footer-link-support')) { + return ; + } + return null; +} + +export default function FooterLinkItem({item}: Props): ReactNode { + const {to, href, label, prependBaseUrlToHref, className, ...props} = item; + const toUrl = useBaseUrl(to); + const normalizedHref = useBaseUrl(href, {forcePrependBaseUrl: true}); + const icon = getFooterIcon(className); + + return ( + + {icon ? ( + + {icon} + {label} + + ) : ( + label + )} + {href && !isInternalUrl(href) && } + + ); +} diff --git a/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx b/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx new file mode 100644 index 0000000..08c047b --- /dev/null +++ b/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx @@ -0,0 +1,132 @@ +/** + * Swizzled: language control uses react-icons; compact desktop label matches icon-only navbar style. + */ +import React, {type ReactNode} from 'react'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import {useAlternatePageUtils} from '@docusaurus/theme-common/internal'; +import {translate} from '@docusaurus/Translate'; +import {mergeSearchStrings, useHistorySelector} from '@docusaurus/theme-common'; +import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem'; +import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem'; +import type {Props} from '@theme/NavbarItem/LocaleDropdownNavbarItem'; +import {IoLanguage} from 'react-icons/io5'; + +import styles from './styles.module.css'; + +function useLocaleDropdownUtils() { + const { + siteConfig, + i18n: {localeConfigs}, + } = useDocusaurusContext(); + const alternatePageUtils = useAlternatePageUtils(); + const search = useHistorySelector((history) => history.location.search); + const hash = useHistorySelector((history) => history.location.hash); + + const getLocaleConfig = (locale: string) => { + const localeConfig = localeConfigs[locale]; + if (!localeConfig) { + throw new Error( + `Docusaurus bug, no locale config found for locale=${locale}`, + ); + } + return localeConfig; + }; + + const getBaseURLForLocale = (locale: string) => { + const localeConfig = getLocaleConfig(locale); + const isSameDomain = localeConfig.url === siteConfig.url; + if (isSameDomain) { + return `pathname://${alternatePageUtils.createUrl({ + locale, + fullyQualified: false, + })}`; + } + return alternatePageUtils.createUrl({ + locale, + fullyQualified: true, + }); + }; + + return { + getURL: (locale: string, options: {queryString: string | undefined}) => { + const finalSearch = mergeSearchStrings( + [search, options.queryString], + 'append', + ); + return `${getBaseURLForLocale(locale)}${finalSearch}${hash}`; + }, + getLabel: (locale: string) => { + return getLocaleConfig(locale).label; + }, + getLang: (locale: string) => { + return getLocaleConfig(locale).htmlLang; + }, + }; +} + +export default function LocaleDropdownNavbarItem({ + mobile, + dropdownItemsBefore, + dropdownItemsAfter, + queryString, + className, + ...props +}: Props): ReactNode { + const utils = useLocaleDropdownUtils(); + + const { + i18n: {currentLocale, locales}, + } = useDocusaurusContext(); + const localeItems = locales.map((locale): LinkLikeNavbarItemProps => { + return { + label: utils.getLabel(locale), + lang: utils.getLang(locale), + to: utils.getURL(locale, {queryString}), + target: '_self', + autoAddBaseUrl: false, + className: + locale === currentLocale + ? mobile + ? 'menu__link--active' + : 'dropdown__link--active' + : '', + }; + }); + + const items = [...dropdownItemsBefore, ...localeItems, ...dropdownItemsAfter]; + + const dropdownLabel = mobile + ? translate({ + message: 'Languages', + id: 'theme.navbar.mobileLanguageDropdown.label', + description: 'The label for the mobile language switcher dropdown', + }) + : utils.getLabel(currentLocale); + + const iconOnlyDesktop = + !mobile && String(className ?? '').includes('nav-icon-only'); + + const label: ReactNode = ( + <> + + {mobile || !iconOnlyDesktop ? ( + dropdownLabel + ) : ( + {dropdownLabel} + )} + + ); + + return ( + + ); +} diff --git a/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css b/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css new file mode 100644 index 0000000..7738718 --- /dev/null +++ b/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css @@ -0,0 +1,20 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +.iconLanguage { + vertical-align: middle; + margin-right: 5px; + color: currentColor; + flex-shrink: 0; +} + +.iconOnly { + vertical-align: middle; + margin-right: 0; + color: currentColor; + flex-shrink: 0; +} diff --git a/src/theme/NavbarItem/NavbarNavLink.tsx b/src/theme/NavbarItem/NavbarNavLink.tsx new file mode 100644 index 0000000..72f51fb --- /dev/null +++ b/src/theme/NavbarItem/NavbarNavLink.tsx @@ -0,0 +1,117 @@ +/** + * Swizzled: icon-only navbar links use react-icons instead of CSS/emoji pseudo-elements. + */ +import React, {type ReactNode} from 'react'; +import Link from '@docusaurus/Link'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import isInternalUrl from '@docusaurus/isInternalUrl'; +import {isRegexpStringMatch} from '@docusaurus/theme-common'; +import IconExternalLink from '@theme/Icon/ExternalLink'; +import type {Props} from '@theme/NavbarItem/NavbarNavLink'; +import clsx from 'clsx'; +import {FaDiscord, FaGithub, FaLifeRing, FaPuzzlePiece} from 'react-icons/fa6'; + +const navIconProps = { + className: 'nav-icon-svg', + 'aria-hidden': true as const, + size: 18, +}; + +function getNavIcon(className?: string): ReactNode | null { + if (!className) { + return null; + } + if (className.includes('nav-link-mods')) { + return ; + } + if (className.includes('nav-link-discord')) { + return ; + } + if (className.includes('nav-link-support')) { + return ; + } + if (className.includes('nav-link-github')) { + return ; + } + return null; +} + +function isIconOnlyClass(className?: string) { + return Boolean(className?.includes('nav-icon-only')); +} + +export default function NavbarNavLink({ + activeBasePath, + activeBaseRegex, + to, + href, + label, + html, + isDropdownLink, + prependBaseUrlToHref, + className, + ...props +}: Props): ReactNode { + const toUrl = useBaseUrl(to); + const activeBaseUrl = useBaseUrl(activeBasePath); + const normalizedHref = useBaseUrl(href, {forcePrependBaseUrl: true}); + const cls = clsx(className); + const navIcon = getNavIcon(cls); + const iconOnly = isIconOnlyClass(cls) && Boolean(navIcon); + const isExternalLink = Boolean(label && href && !isInternalUrl(href)); + + const linkContentProps = html + ? {dangerouslySetInnerHTML: {__html: html}} + : iconOnly && navIcon + ? { + children: ( + <> + {navIcon} + {typeof label === 'string' || typeof label === 'number' ? ( + {label} + ) : ( + label + )} + + ), + } + : { + children: ( + <> + {label} + {isExternalLink && ( + + )} + + ), + }; + + if (href) { + return ( + + ); + } + + return ( + + activeBaseRegex + ? isRegexpStringMatch(activeBaseRegex, location.pathname) + : location.pathname.startsWith(activeBaseUrl), + })} + {...props} + {...linkContentProps} + /> + ); +}