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

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

Files

Marvin 331847013d docs: update docusaurus configuration and documentation structure

- Revised the tagline in `docusaurus.config.js` for improved clarity on the documentation's focus.
- Removed German localization support from the configuration to streamline the user experience.
- Updated navigation items in the sidebar to better reflect the current structure, emphasizing player and developer resources.
- Enhanced the README and various documentation files to clarify the repository layout and improve accessibility for users.
- Adjusted links and descriptions throughout the documentation to ensure consistency and accuracy.

This commit aims to enhance the overall clarity and usability of the documentation.

2026-04-10 02:26:32 +02:00

2.5 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. Logical stack: ModManager → framework / SDK → plugins → mods — see System architecture & documentation principles.

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.5 KiB Raw Blame History Unescape Escape