gregWiki/docs/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 documentation	/docs	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) · End-user workshop
Mod developers — build mods, hooks, debugging	Mod developers (hub) · Framework · FMF hooks
Contributors — PRs, docs, plugins, CI	Contributors (workflow) · Contributor workshop
Sponsors — support & transparency	Sponsors (hub) · GitHub Sponsors (project policies in repo `LICENSE` / `CONTRIBUTING`)

Experience tracks (newbies → pros): By audience → Newbies, Intermediates, Professionals.

Repository hub

Workspace map — 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 — FMF.<Domain>.… and legacy FFM.*
FMF hooks catalog — generated from core HookNames.cs
Release channels — Steam Workshop vs GitHub (beta)
MCP server — optional LLM/IDE tooling over docs + fmf_hooks.json

Layout (contributors)

Repo inventory — 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/.

2.8 KiB Raw Blame History