mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
cfaa5550d4
- 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.
29 lines
1.9 KiB
Plaintext
29 lines
1.9 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/framework/FrikaMF.csproj`), 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) |
|
|
| **Workshop desktop app** | `gregModmanager/` | **Gregtools Modmanager** (MAUI); project file `WorkshopUploader.csproj`, executable **`WorkshopUploader.exe`** |
|
|
| **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 FFI bridge:** `gregCore/bridges/gregSta.RustBridge/` (not under a separate `DataCenter-RustBridge` top-level folder).
|
|
|
|
**Detailed inventory** (paths, `.csproj`, hooks): [Repository inventory](../contributors/repo-inventory).
|