gregWiki/i18n/de/docusaurus-plugin-content-docs/current/intro.md at 8d8fda49c414a24739af69139ec285d5f489c347

mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00

Files

Marvin 8d8fda49c4 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.

2026-04-10 02:12:06 +02:00

2.8 KiB

Raw Blame History

id, title, slug, description

id	title	slug	description
intro	gregFramework Dokumentation	/docs	Einstieg für den Split-Repo-Workspace — Core, Mods, Extensions und dieses Wiki.

Diese Dokumentation beschreibt den aktuellen Split-Stand: gregFramework/ als Wrapper mit Einzel-Repositories für Core, Mods, Extensions und Wiki. Sie richtet sich an Spieler, Mod-Developer, Contributors und Sponsoren.

Für wen?

Zielgruppe	Einstieg
Spieler — installieren, spielen, Troubleshooting	Endnutzer (Hub) · Endnutzer-Workshop
Moddevs — Mods bauen, Hooks, Debugging	Mod-Entwickler (Hub) · Framework · FMF-Hooks
Contributor — PRs, Doku, Plugins, CI	Contributors (Workflow) · Contributor-Workshop
Sponsorinnen & Sponsoren	Sponsors (Hub) · Lizenz & Richtlinien im GitHub-Repo (`LICENSE` / `CONTRIBUTING`)

Erfahrungspfade (Einsteiger → Profis): Nach Zielgruppe → Newbies, Intermediates, Professionals.

Repository-Hub

Workspace-Karte — Ordner → Repos
Core: gregCore/ (framework/FrikaMF, mcp-server/, bridges/gregSta.RustBridge/)
Mods: gregMod.<Name>/ (Split-Repos, direkt unter gregFramework/)
Extensions (FFM-Plugins): gregExt.<Name>/ (Split-Repos, direkt unter gregFramework/)
Workshop-App: gregModmanager/ (Gregtools Modmanager — WorkshopUploader.exe)
Exporter/Templates: gregDataCenterExporter/
Wiki: gregWiki/

Hooks und Releases

FMF Hook-Naming — FMF.<Domain>.… und Legacy FFM.*
FMF-Hooks-Katalog — generiert aus Core-HookNames.cs
Release-Kanäle — Steam Workshop vs GitHub (Beta)
MCP-Server — optionale LLM/IDE-Tools über Doku + fmf_hooks.json

Layout (Contributors)

Repo-Inventar — Projekt- und Repo-Übersicht
Split-Konvention: gregMod.<Name>, gregExt.<Name>, gregSta.<Name> (Rust-Bridge-Repo), plus Apps wie gregModmanager/, gregDataCenterExporter/, gregIPAM/, gregStore/

Quellenmodell

Authoring: Inhalte liegen im gregWiki-Repo.
Technische Wahrheit: Runtime/Bridge-Details kommen aus gregCore.
RustBridge: gregCore/bridges/gregSta.RustBridge/.

2.8 KiB Raw Blame History