gregWiki/docs/getting-started.md at 8d8fda49c414a24739af69139ec285d5f489c347

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

Files

Marvin cfaa5550d4 docs: enhance documentation structure and clarify repository layout

- Updated the README and various documentation files to reflect the new flat layout of the `gregFramework`, emphasizing the direct placement of repositories like `gregMod.<Name>/` and `gregExt.<Name>/` under `gregFramework/`.
- Added details about the `gregModmanager/` and `gregDataCenterExporter/` directories, clarifying their roles and contents.
- Improved descriptions and links throughout the documentation to ensure consistency and accuracy, enhancing user navigation and understanding of the project structure.
- Adjusted language in several sections to better communicate the purpose and organization of the repositories.

This commit improves the overall clarity and usability of the documentation.

2026-04-10 02:03:00 +02:00

2.3 KiB

Raw Blame History

title, sidebar_label, description

title	sidebar_label	description
Getting started	Getting started	Split-repo workspace: gregFramework layout, building the core, and where docs live.

The workspace is multi-repo with a local gregFramework/ folder containing standalone repositories, for example:

gregCore/ — core SDK (gregCore/framework/FrikaMF.csproj), MCP server under gregCore/mcp-server/
gregMod.<Name>/ — gameplay mods (FMF.*), flat next to gregCore/ (legacy umbrella gregMods/ is deprecated)
gregExt.<Name>/ — framework plugins (FFM.Plugin.*), same flat layout (legacy gregExtensions/ deprecated)
gregModmanager/ — Gregtools Modmanager (WorkshopManager; WorkshopUploader.csproj)
gregDataCenterExporter/ — exporter, templates, hook JSON mirrors
gregWiki/ — this documentation site

The Rust bridge lives under:

gregCore/bridges/gregSta.RustBridge/

Build the core

dotnet build gregCore/FrikaMF.sln -c Release

Or open gregCore/FrikaMF.sln in your IDE.

Hook naming

Target convention: FMF.<DOMAIN>.<Event> (see CONTRIBUTING.md).
Registry (example path in workspace): gregDataCenterExporter/FrikaModFramework/fmf_hooks.json (exact copy may exist in other repos).
Legacy runtime strings may still use FFM.* in HookNames.cs until migrated.

Start a mod

Add a new mod repo as gregMod.<Name>/ under gregFramework/ (clone or create next to gregCore/).
Use templates from gregCore/Templates/ (and mirrored templates under gregDataCenterExporter/Templates/ where applicable).
Maintain hook metadata and version the mod in its own repository.

Documentation site

Repository: gregWiki/
Content: Markdown/MDX in this repo, aligned with the split layout.

Docker

From the gregWiki root: docker build -t gregwiki-docs . then docker run --rm -p 3000:3000 gregwiki-docs.

MCP

See reference/mcp-server — implementation under gregCore/mcp-server/ (install and --data-root per that folder’s README.md).

2.3 KiB Raw Blame History Unescape Escape