mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 11:39:18 +02:00
refactor: update project branding and structure for gregFramework
- 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.
This commit is contained in:
Marvin
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: End-User (Release) EN
|
||||
description: Installation, updates, troubleshooting, and uninstall guide for players using FrikaMF as a dependency.
|
||||
sidebar_position: 120
|
||||
tags:
|
||||
- audience:enduser
|
||||
---
|
||||
|
||||
## End-User (Release)
|
||||
|
||||
This page is for players who do **not** develop mods and only install FrikaMF because another mod depends on it.
|
||||
|
||||
For a complete overview of framework capabilities and setup flows, see [`Framework Features & Use Cases`](/wiki/legacy/wiki-import/Framework-Features-Use-Cases).
|
||||
|
||||
## What you install
|
||||
|
||||
- `FrikaModdingFramework.dll` is a runtime framework for `Data Center`.
|
||||
- It provides stable runtime glue required by other mods.
|
||||
- FrikaMF is **unofficial** and **community-driven**.
|
||||
|
||||
## Quick install
|
||||
|
||||
1. Install MelonLoader (IL2CPP, latest stable).
|
||||
2. Launch the game once, then close it.
|
||||
3. Put `FrikaModdingFramework.dll` into `Data Center/Mods`.
|
||||
4. Put your actual mod into `Data Center/Mods`.
|
||||
5. Start the game and verify `MelonLoader/Latest.log`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Game crashes at startup: check `MelonLoader/Latest.log` for missing DLL/type errors.
|
||||
- Mod not loading: verify correct folder and unblock files in Windows file properties.
|
||||
- After game update: check compatibility page and wait for updated releases if hooks changed.
|
||||
|
||||
## Update
|
||||
|
||||
1. Close game.
|
||||
2. Replace `FrikaModdingFramework.dll`.
|
||||
3. Start game and verify logs.
|
||||
|
||||
## Uninstall
|
||||
|
||||
1. Close game.
|
||||
2. Remove `FrikaModdingFramework.dll` from `Mods`.
|
||||
3. Remove dependent mods.
|
||||
|
||||
## Related pages
|
||||
|
||||
- [Home EN](../Home)
|
||||
- [ModDevs EN](../ModDevs/)
|
||||
- [Contributors EN](../Contributors/)
|
||||
- [FFI Bridge Reference](../FFI-Bridge-Reference)
|
||||
- [Web UI Bridge EN (DC2WEB)](../Web-UI-Bridge)
|
||||
- [Known Incompatibilities EN](../Known-Incompatibilities)
|
||||
|
||||
## Minimal context example (both language tracks)
|
||||
|
||||
### 🦀 Rust
|
||||
|
||||
```rust
|
||||
#[no_mangle]
|
||||
pub extern "C" fn mod_info() -> *const i8 {
|
||||
b"example-rust\0".as_ptr() as *const i8
|
||||
}
|
||||
```
|
||||
|
||||
### 🔷 C\#
|
||||
|
||||
```csharp
|
||||
using MelonLoader;
|
||||
|
||||
public sealed class ExampleMod : MelonMod
|
||||
{
|
||||
public override void OnInitializeMelon()
|
||||
{
|
||||
LoggerInstance.Msg("Example C# mod loaded");
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# Framework Dependency Usage EN
|
||||
|
||||
## Goal
|
||||
|
||||
Use FrikaMF as a stable runtime dependency for custom mods.
|
||||
|
||||
## Steps
|
||||
|
||||
1. Place `FrikaModdingFramework.dll` in your `Mods` folder.
|
||||
2. Build your mod with runtime dependency checks.
|
||||
3. Disable gracefully if the dependency is missing.
|
||||
|
||||
## Next Pages
|
||||
|
||||
- [FAQ EN](../Troubleshooting/FAQ)
|
||||
- [Troubleshooting EN](../Troubleshooting/overview)
|
||||
- [Disclaimer EN](../Reference/Disclaimer)
|
||||
@@ -0,0 +1,3 @@
|
||||
# Guides Index EN
|
||||
|
||||
- [Framework Dependency Usage EN](Framework-Dependency)
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"key": "wiki-import-enduser-guides"
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
# EndUser Index EN
|
||||
|
||||
Audience: users who want to use FrikaMF as a dependency.
|
||||
|
||||
## Contents
|
||||
|
||||
- [Framework Dependency Usage EN](Guides/Framework-Dependency)
|
||||
- [FAQ EN](Troubleshooting/FAQ)
|
||||
- [Troubleshooting EN](Troubleshooting/overview)
|
||||
- [Disclaimer EN](Reference/Disclaimer)
|
||||
- [AI Usage Policy](../AI-USAGE)
|
||||
@@ -0,0 +1,11 @@
|
||||
# Disclaimer EN
|
||||
|
||||
- FrikaMF is unofficial and community-driven.
|
||||
- Use at your own risk.
|
||||
- No compatibility guarantees after game updates.
|
||||
- No affiliation with WASEKU.
|
||||
|
||||
## Policies
|
||||
|
||||
- [AI Usage Policy (Wiki)](../../AI-USAGE)
|
||||
- [AI Usage Policy (Root)](/wiki/legacy/wiki-import/AI-USAGE)
|
||||
@@ -0,0 +1,3 @@
|
||||
# Reference Index EN
|
||||
|
||||
- [Disclaimer EN](Disclaimer)
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"key": "wiki-import-enduser-reference"
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
# FAQ EN
|
||||
|
||||
## Do I need Rust and C# together?
|
||||
|
||||
No. You can choose one language.
|
||||
|
||||
## Where is the framework DLL?
|
||||
|
||||
`Data Center/Mods/FrikaModdingFramework.dll`
|
||||
|
||||
## My mod is not loading
|
||||
|
||||
See [Troubleshooting EN](overview).
|
||||
@@ -0,0 +1,4 @@
|
||||
# Troubleshooting Index EN
|
||||
|
||||
- [FAQ EN](FAQ)
|
||||
- [Troubleshooting EN](overview)
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"key": "wiki-import-enduser-troubleshooting"
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
# Troubleshooting EN
|
||||
|
||||
## Standard Checks
|
||||
|
||||
1. Check `MelonLoader/Latest.log`.
|
||||
2. Verify game/FrikaMF/mod versions.
|
||||
3. Confirm `FrikaModdingFramework.dll` is available.
|
||||
|
||||
## Common Errors
|
||||
|
||||
- `MissingMethodException`
|
||||
- `TypeLoadException`
|
||||
- Missing runtime dependency
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"label": "End users",
|
||||
"position": 10,
|
||||
"key": "wiki-import-root-enduser"
|
||||
}
|
||||
Reference in New Issue
Block a user