mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
ea92a0baf8
- 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.
55 lines
2.3 KiB
Markdown
55 lines
2.3 KiB
Markdown
---
|
|
title: Getting started
|
|
sidebar_label: Getting started
|
|
description: "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
|
|
|
|
```text
|
|
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)](./reference/modding-language-requirement.md).
|
|
|
|
## Hook naming
|
|
|
|
- **Target convention:** `FMF.<DOMAIN>.<Event>` (see [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md)).
|
|
- **Registry:** [`FrikaModFramework/fmf_hooks.json`](https://github.com/mleem97/gregFramework/blob/master/FrikaModFramework/fmf_hooks.json) (path may vary by branch).
|
|
- **Legacy runtime strings** may still use `FFM.*` in [`HookNames`](https://github.com/mleem97/gregFramework/blob/master/framework/FrikaMF/HookNames.cs) until migrated.
|
|
|
|
## Start a mod
|
|
|
|
1. Create a new mod repo under `gregMods/` using the `gregMod.<Name>` pattern.
|
|
2. Use templates from `gregCore/FrikaMF-StandaloneRepo/Templates/`.
|
|
3. 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`](./reference/mcp-server.md) — the server lives next to the core sources (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`).
|