mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
42 lines
2.7 KiB
Markdown
42 lines
2.7 KiB
Markdown
---
|
|
id: intro
|
|
title: FrikaMF Docs Start
|
|
slug: /docs
|
|
---
|
|
|
|
This documentation matches the **current monorepo**: MelonLoader framework under `framework/`, gameplay mods under `mods/`, FFM plugins under `plugins/`, Docusaurus content in `docs/`, and the wiki app in `wiki/`. It is written for **players**, **mod developers**, **contributors**, and **sponsors** — pick a lane below.
|
|
|
|
## Für wen? — Who is this for?
|
|
|
|
| Audience | Start here |
|
|
|----------|------------|
|
|
| **Spieler** — install, play, troubleshoot | [End users (hub)](./topics/end-user/overview.md) · [End user wiki (import)](./wiki-import/EndUser/) |
|
|
| **Moddevs** — build mods, hooks, debugging | [Mod developers (hub)](./topics/mod-developers/overview.md) · [ModDevs wiki (import)](./wiki-import/ModDevs/) · [Framework](./mods/framework.md) |
|
|
| **Contributor** — PRs, docs, plugins, CI | [Contributors (workflow)](./topics/contributors/overview.md) · [Contributors wiki (import)](./wiki-import/Contributors/) |
|
|
| **Sponsorinnen & Sponsoren** — support & transparency | [Sponsors (hub)](./topics/sponsors/overview.md) · [Sponsors (EN)](./wiki-import/Sponsors.md) · [Sponsoren (DE)](./wiki-import/Sponsoren.md) |
|
|
|
|
**Experience tracks** (newbies → pros): [By audience](./topics/audiences/overview.md) → [Newbies](./audiences/newbies.md), [Intermediates](./audiences/intermediates.md), [Professionals](./audiences/professionals.md).
|
|
|
|
## Mods Hub
|
|
|
|
- Framework entry: [`Framework`](./mods/framework.md)
|
|
- Standalone / mod list: [`Standalone Mods`](./mods/standalone/index.md)
|
|
|
|
## 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 `framework/FrikaMF/HookNames.cs`
|
|
- [Release channels](./reference/release-channels.md) — Steam Workshop vs GitHub (beta)
|
|
- [MCP server](./reference/mcp-server.md) — LLM/IDE tools over docs + `fmf_hooks.json` (optional Docker bundle)
|
|
|
|
## Repository layout (contributors)
|
|
|
|
- [Repo inventory](./contributors/repo-inventory.md) — projects, solution scope, entry points
|
|
- [Monorepo target layout](./contributors/monorepo-target-layout.md) — phased migration goals
|
|
|
|
## Source model
|
|
|
|
- **Authoring:** Markdown and MDX live in the repo-root **`docs/`** folder (this tree). See the **[`docs/` layout map](./README.md)** for what lives where (curated topics vs `wiki-import/` vs `wiki/` stubs).
|
|
- **Site:** The Docusaurus application is in **`wiki/`**; routes use base **`/wiki`** (see [Docusaurus workflow](./contributors/docusaurus-workflow.md)).
|
|
- **Legacy GitHub Wiki:** Mirrored under **`docs/wiki-import/`**; refresh from **`.wiki/`** with `npm run wiki:refresh` in `wiki/`. Details: [Legacy wiki import](./topics/wiki-import/overview.md).
|