gregWiki/docs/getting-started.md at ea92a0baf8a1a6c2fd4530237e9d41023b60aa2d

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

Files

Marvin ea92a0baf8 refactor: update project branding and structure for gregFramework

- Changed project title and tagline in docusaurus.config.js to reflect the new branding.
- Updated package.json and package-lock.json to rename the project to gregwiki-docs-site.
- Adjusted sidebar and documentation files to align with the new project structure and naming conventions.
- Enhanced documentation content for clarity and consistency across various sections.
- Added Prettier as a development dependency for code formatting.

This commit aligns the project with the new branding and improves overall documentation quality.

2026-04-10 01:20:22 +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/ — framework core (under FrikaMF-StandaloneRepo/): translations, hooks, Harmony/event runtime, templates, bridges, and related core features
gregMods/ (per-mod repositories)
gregExtensions/ (per-extension repositories)
gregWiki/ (this documentation site)
gregStore/ (Gregweb, private repository — modstore web + infra; Next.js under web/)

The upstream DataCenter-RustBridge project is integrated into the core tree at:

gregCore/FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/

Build the core

dotnet build gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln -c Release

Or open gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln in your IDE.

Language (mods / plugins / extensions)

Mandatory: implement all gameplay and integration logic for mods, MelonLoader plugins, and extensions in C#. See Modding language (C# only).

Hook naming

Target convention: FMF.<DOMAIN>.<Event> (see CONTRIBUTING.md).
Registry: FrikaModFramework/fmf_hooks.json (path may vary by branch).
Legacy runtime strings may still use FFM.* in HookNames until migrated.

Start a mod

Create a new mod repo under gregMods/ using the gregMod.<Name> pattern.
Use templates from gregCore/FrikaMF-StandaloneRepo/Templates/.
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 — the server lives next to the core sources (gregCore/FrikaMF-StandaloneRepo/mcp-server/).

2.3 KiB Raw Blame History