mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
8d8fda49c4
- 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.
48 lines
2.8 KiB
Markdown
48 lines
2.8 KiB
Markdown
---
|
|
id: intro
|
|
title: gregFramework documentation
|
|
slug: /docs
|
|
description: Entry point for the split-repo workspace — core, mods, extensions, and this wiki.
|
|
---
|
|
|
|
This documentation describes the **current split layout**: a local `gregFramework/` workspace with separate repositories for **core**, **mods**, **extensions**, and **wiki**. It is written for **players**, **mod developers**, **contributors**, and **sponsors**.
|
|
|
|
## Who is this for?
|
|
|
|
| Audience | Start here |
|
|
|----------|------------|
|
|
| **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).
|
|
|
|
## Repository hub
|
|
|
|
- [Workspace map](./workspace/index.mdx) — how folders map to repos
|
|
- Core: `gregCore/` (`framework/FrikaMF`, `mcp-server/`, `bridges/gregSta.RustBridge/`)
|
|
- Mods: `gregMod.<Name>/` (split repos, directly under `gregFramework/`)
|
|
- Extensions (FFM plugins): `gregExt.<Name>/` (split repos, directly under `gregFramework/`)
|
|
- Workshop app: `gregModmanager/` (Gregtools Modmanager — `WorkshopUploader.exe`)
|
|
- Exporter / templates: `gregDataCenterExporter/`
|
|
- Wiki: `gregWiki/` (this site)
|
|
|
|
## Hooks and releases
|
|
|
|
- [FMF hook naming](./reference/fmf-hook-naming.md) — `FMF.<Domain>.…` and legacy `FFM.*`
|
|
- [FMF hooks catalog](./reference/fmf-hooks-catalog.md) — generated from core `HookNames.cs`
|
|
- [Release channels](./reference/release-channels.md) — Steam Workshop vs GitHub (beta)
|
|
- [MCP server](./reference/mcp-server.md) — optional LLM/IDE tooling over docs + `fmf_hooks.json`
|
|
|
|
## Layout (contributors)
|
|
|
|
- [Repo inventory](./contributors/repo-inventory.md) — project and repository overview
|
|
- Split naming: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>` (Rust bridge repo), plus apps like `gregModmanager/`, `gregDataCenterExporter/`, `gregIPAM/`, `gregStore/`
|
|
|
|
## Source model
|
|
|
|
- **Authoring:** Markdown/MDX lives in the **gregWiki** repository.
|
|
- **Technical source of truth:** runtime and bridge details come from **gregCore**.
|
|
- **Rust bridge:** `gregCore/bridges/gregSta.RustBridge/`.
|