Files
gregWiki/docs/getting-started.md
Marvin e2839584f4 Merge Docusaurus site: all content under docs/, align with gregFramework split layout
- Move markdown and wiki-import tree into docs/; keep app shell at repo root
- Point docusaurus docs path to docs/; edit links to mleem97/gregWiki
- Sync and i18n scripts use gregWiki root and ../.wiki under gregFramework
- Sidebars: workspace layout from root docs ids; plugins under mods/extensions
- Fix redirects, module catalog URLs, release note paths, and wiki-import category keys
- Update repo inventory for split repos; Dockerfile for single-repo context

Made-with: Cursor
2026-04-09 23:39:32 +02:00

51 lines
2.1 KiB
Markdown

---
title: Getting started
sidebar_label: Getting started
description: "Aktueller Stand nach Repo-Split: Wrapper-Struktur, Core-Build und Mod-/Extension-Repos."
---
Die Struktur ist jetzt **Multi-Repo** mit `gregFramework/` als lokalem Wrapper-Ordner. Darin liegen die eigenständigen Repositories, z. B.:
- `gregCore/` (Core SDK, inkl. `FrikaMF-StandaloneRepo/`)
- `gregMods/` (einzelne Mod-Repos)
- `gregExtensions/` (einzelne Extension-Repos)
- `gregWiki/` (Dokumentation)
`DataCenter-RustBridge` wird in den Core integriert und liegt im Core-Baum unter:
- `gregCore/FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`
## Core bauen
```text
dotnet build gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln -c Release
```
Alternativ in IDE: `gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln` öffnen.
## Hook naming
- **Target convention:** `FMF.<DOMAIN>.<Event>` (see [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md)).
- **Registry:** [`FrikaModFramework/fmf_hooks.json`](https://github.com/mleem97/gregFramework/blob/master/FrikaModFramework/fmf_hooks.json).
- **Legacy runtime strings** may still use `FFM.*` in [`HookNames`](https://github.com/mleem97/gregFramework/blob/master/framework/FrikaMF/HookNames.cs) until migrated.
## Mod starten
1. Neues Mod-Repo unter `gregMods/` nach Schema `gregMod.<Name>` anlegen.
2. Templates aus `gregCore/FrikaMF-StandaloneRepo/Templates/` nutzen.
3. Hook-Metadaten pflegen und Mod im eigenen Repo versionieren.
## Documentation site
- **Repo:** `gregWiki/`
- **Inhalt:** Markdown/MDX in diesem Repo, angepasst an den Split-Stand.
### Docker
- **Dev server with hot reload:** from the `gregWiki` repo root, `docker build -t gregwiki-docs .` then `docker run --rm -p 3000:3000 gregwiki-docs` (or use your host compose file if you mount this repo).
- **MCP:** see [`reference/mcp-server`](./reference/mcp-server.md) in the core repository (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`).
## Assistants / MCP
Der MCP-Server für Framework-Scan/Tooling liegt im Core-Umfeld (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`).