5.5 KiB
id, title, sidebar_label, description
| id | title | sidebar_label | description |
|---|---|---|---|
| repo-inventory | Repository inventory | Repo inventory | Current monorepo layout, projects, and known solution drift (contributors). |
Repository inventory
This page is the source of truth snapshot for how the gregFramework workspace (split repositories on disk) is organized today. Use it before large refactors or when onboarding.
Top-level workspace (gregFramework/)
These folders typically sit next to each other in a developer workspace (see also intro):
| Area | Path (on disk) | Role |
|---|---|---|
| Framework core | gregCore/ |
Runtime, hooks, Harmony, bridge — main project gregCore/framework/FrikaMF.csproj; templates under gregCore/Templates/ |
| Mods (split repos) | gregMod.<Name>/ (directly under gregFramework/) |
Standalone gameplay mods (FMF.* assemblies); not nested under a gregMods/ umbrella |
| Extensions / framework plugins (split repos) | gregExt.<Name>/ (directly under gregFramework/) |
FFM framework plugins (FFM.Plugin.*); not under legacy StandaloneMods/ paths |
| Documentation | gregWiki/ (mleem97/gregWiki) |
This site: Docusaurus app at repo root, all authored pages under docs/ |
| Tools | gregModmanager/ (WorkshopManager), gregDataCenterExporter/, etc. |
Supporting apps and templates |
| Other | gregIPAM/, gregReferences/, … |
Side projects and references |
Canonical code locations (split repos)
| Concern | Where to look |
|---|---|
Framework .csproj |
gregCore/framework/FrikaMF.csproj |
Plugins (FFM.Plugin.*) — authoring |
gregExt.<Name>/ (e.g. gregExt.AssetExporter/) |
| Plugins — optional mirrors | gregCore/plugins/FFM.Plugin.* |
Mod sources (FMF.*) |
gregMod.<Name>/ |
| Templates | gregCore/Templates/ |
| Wiki content | gregWiki/docs/ |
Wiki import (legacy)
Long-form pages mirrored from the GitHub Wiki live under docs/legacy/wiki-import/ and remain linked from many topics.
.NET projects on disk (*.csproj)
- Framework:
gregCore/framework/FrikaMF.csproj(solutiongregCore/FrikaMF.slnwhen present). - Plugins: primary checkouts
gregExt.<Name>/(assemblyFFM.Plugin.*.dll); duplicates undergregCore/plugins/for all-in-one builds. - Mods:
gregMod.<Name>/at workspace root (FMF.*.csprojnames vary). - WorkshopManager:
gregModmanager/WorkshopUploader.csproj(separate from the MelonLoader framework solution).
Build status (framework project)
gregCore/framework/FrikaMF.csprojdoes not compile the WorkshopManager app; that builds fromgregModmanager/WorkshopUploader.csproj.dotnet buildon the framework solution (when present undergregCore/) builds core + optionalgregCore/plugins/*— not split-repogregExt.*/gregMod.*folders unless you add them to the solution.
FrikaMF.sln drift (action items)
-
Mods outside solution: Standalone mod projects under
gregMod.*are usually not inFrikaMF.sln; build them per repo or add them if you want onedotnet buildfor everything. -
Templates in
framework/FrikaMF.csproj: Template sources underTemplates/may faildotnet build framework/FrikaMF.csprojwithCS0122ifCorevisibility does not match template expectations — treat templates as samples until the project graph is cleaned up.
Documentation (Docusaurus)
- Entry:
/wiki→intro - Sidebar:
sidebars.js - Module catalog (downloads table):
src/data/moduleCatalog.ts - Landing:
/→src/pages/index.tsx - Static catalog page:
/mods
Hook / event sources of truth (code)
- String constants:
gregCore/framework/FrikaMF/HookNames.cs(FFM.*hook IDs today). - Numeric IDs:
gregCore/framework/FrikaMF/EventIds.cs. - Generated wiki mirror: run
tools/Generate-FmfHookCatalog.ps1→fmf-hooks-catalog.
Debugging (MelonLoader, IL2CPP, Unity)
- Build first:
dotnet build gregCore/FrikaMF.sln -c Debug(requires MelonLoader + IL2CPP interop underMelonLoader/for your game install, orlib/references/MelonLoader— seetools/refresh_refs.py). - Attach: Run Data Center with MelonLoader, then attach your IDE’s .NET / CoreCLR debugger to the game process (process name usually matches the game executable). Breakpoints hit in Debug builds of mods/plugins copied into
Mods/. FFM.Plugin.AssetExporter: The project linksframework/Main.cs(and related files) and referencesFrikaMF.csproj, which would normally produce CS0436 duplicate-type warnings. Those are suppressed in the plugin.csproj(NoWarn); do not remove the project reference without linking the rest of theFrikaMFsources.
Related
- Monorepo target layout — phased folder goals
- FMF hook naming — naming convention
- Release channels — Steam vs GitHub beta