mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
fcac837bd9
Revised multiple documentation files to replace instances of "FrikaMF" with "gregCore," reflecting the updated naming conventions and project structure. This change enhances consistency and clarity across the documentation, ensuring that users and contributors have accurate information regarding the framework and its components.
31 lines
2.4 KiB
Plaintext
31 lines
2.4 KiB
Plaintext
---
|
|
title: Workspace map
|
|
sidebar_label: Workspace map
|
|
description: How gregFramework repositories on disk map to code and documentation.
|
|
---
|
|
|
|
# Workspace map
|
|
|
|
The **gregFramework** folder groups several repositories (split layout). Use this hub before diving into a specific repo.
|
|
|
|
| Area | Folder | Role |
|
|
|------|--------|------|
|
|
| **Framework core** | `gregCore/` | MelonLoader host: **`gregCore/gregCore.sln`** / **`gregCore/framework/gregCore.csproj`** → runtime **`gregCore.dll`**; **`framework/ModLoader/LanguageBridges/`** (incl. **`LuaModules/`** for Lua `greg.*`); templates, **`gregCore/mcp-server/`**, optional `gregCore/plugins/` mirrors |
|
|
| **Gameplay mods** | `gregMod.<Name>/` | Standalone mods (`FMF.*`) — **directly under `gregFramework/`** (the `gregMods/` umbrella is deprecated) |
|
|
| **Framework plugins** | `gregExt.<Name>/` | FFM plugins (`FFM.Plugin.*`) — **directly under `gregFramework/`** (the `gregExtensions/` umbrella is deprecated) |
|
|
| **GregModManager (MAUI)** | `gregModmanager/` | **Gregtools Modmanager** — UI for managing mods/plugins; `WorkshopUploader.csproj`, **`WorkshopUploader.exe`**. See [Architecture principles](/wiki/meta/system-architecture-principles). |
|
|
| **Data Center exporter / assets** | `gregDataCenterExporter/` | Templates, exporter tooling, `FrikaModFramework/fmf_hooks.json` (among copies) |
|
|
| **Documentation** | `gregWiki/` | This Docusaurus site (`docs/`) |
|
|
| **Mod store / web (if cloned)** | `gregStore/` | Private Next.js modstore stack (`web/`, …) — optional sibling repo |
|
|
| **IPAM / DHCP mod** | `gregIPAM/` | Gameplay tooling (e.g. `DHCPSwitches.csproj`) |
|
|
| **References & IL2CPP** | `gregReferences/` | Unpacked assemblies, tooling baselines |
|
|
| **Meta / internal docs** | `gregMeta/`, `gregInternalDocs/` | Notes and internal documentation |
|
|
| **Examples** | `exGregFramework/` | Example / bootstrap layout |
|
|
| **Helper** | `siblingRepos/` | Scripts to clone related repos |
|
|
|
|
**Rust / native FFI:** implementiert im **Framework-Core** (`gregCore/framework/ModLoader/FfiBridge.cs`, zusammen mit `Core.cs`).
|
|
|
|
**Lua script mods (in-game):** nach Build/Install unter **`Data Center/Mods/ScriptMods/lua/`** (Modulordner mit `.lua`-Dateien; siehe [Language Bridges README](https://github.com/mleem97/gregFramework/blob/main/gregCore/framework/ModLoader/LanguageBridges/README.md)).
|
|
|
|
**Detailed inventory** (paths, `.csproj`, hooks): [Repository inventory](../contributors/repo-inventory).
|