teamGreg/gregWiki
1
0
Fork 0
mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update terminology and improve clarity across documentation

Browse Source 
- Revised the tagline in `docusaurus.config.js` to reflect the focus on Data Center.
- Enhanced descriptions in `getting-started.md`, `intro.md`, and various mod documentation files for consistency and clarity.
- Updated references to the game name, removing "Waseku" for a more streamlined presentation.
- Improved the structure and readability of tables and lists throughout the documentation.

This commit aims to ensure the documentation is clear, consistent, and accurately represents the project, enhancing usability for both mod developers and players.
This commit is contained in:
Marvin
2026-04-10 04:44:12 +02:00
parent e3d5f22aec
commit e818c78baa
19 changed files with 93 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guides/mod-developers/greg-hooks-showcase.md
View File

@@ -31,7 +31,7 @@ Authoritative documentation: [greg hooks registry (IL2CPP)](/wiki/reference/greg
**Pattern A — dynamic (anonymous types from compiler):**
```csharp
private static void OnMoneyChanged(object payload)
private static void OnCoinChanged(object payload)
{
dynamic p = payload;
float delta = (float)p.coinChangeAmount;
@@ -62,7 +62,7 @@ Use **`GregPayload.Dump(payload)`** for one-line debug strings.
## Prefix hooks and cancellation
Hooks that run **before** the original method (Harmony Prefix) can call **`GregEventDispatcher.InvokeCancelable(hookName, payload)`**. Mods register **`GregEventDispatcher.OnCancelable(hookName, p => bool, modId)`**; if any handler returns `false`, the integration can skip the original (e.g. `Player.UpdateCoin`).
Hooks that run **before** the original method (Harmony Prefix) can call **`GregEventDispatcher.InvokeCancelable(hookName, payload)`**. Mods register **`GregEventDispatcher.OnCancelable(hookName, p => bool, modId)`**; if any handler returns `false`, the integration can skip the original (e.g. `Player.UpdateCoin`). Der Showcase nutzt **`GregNativeEventHooks.PlayerCoinChanged`** (`greg.PLAYER.CoinChanged`).
Showcase: enable `blockNegativeTransactions` in `content/modconfig.json` to register a veto on large negative `coinChangeAmount` values.

2
docs/guides/mod-developers/overview.md
View File

@@ -13,6 +13,6 @@ description: Getting started, mod config, debugging — curated docs for FMF mod
- [Getting started](/wiki/getting-started) and [Documentation hub](/wiki/developers)
- [Framework overview](/wiki/mods/framework) — runtime capabilities and repo layout
- [FMF hooks](/wiki/framework/fmf-hooks) — hook surface (generated article)
- [FMF hook naming](/wiki/reference/fmf-hook-naming) and [hooks catalog](/wiki/reference/fmf-hooks-catalog)
- [FMF hook naming](/wiki/reference/fmf-hook-naming); runtime map: [greg hooks catalog](/wiki/reference/greg-hooks-catalog) (see also [FMF hooks catalog (legacy redirect)](/wiki/reference/fmf-hooks-catalog))
- [Contributor workshop](/wiki/guides/contributors/contributor-workshop) — builds, CI, and PRs
- [Mods](/wiki/mods/) — gameplay mods (`FMF.*`) and release pages