premium banner

Generic Mod Documentation Framework

Generic Mod Documentation Framework (GMDF) adds an in-game mod documentation viewer to Stardew Valley. WebGUI documentation builder tool for mod authors linked.

Description

Generic Mod Documentation Framework (GMDF) adds an in-game documentation viewer to Stardew Valley. A small HUD button appears on-screen during gameplay. Clicking it opens a sidebar-style menu that shows documentation for every installed mod that has opted in. Players can flip between pages, read guides, view images and animations, and reference config options — all without leaving the game.

Mod authors do not need to write any C# to participate. Drop a documentation.json file into your mod folder and GMDF picks it up automatically at launch.

Installation :

  • Download latest mod file
    e.g. "GenericModDocumentationFramework.zip"
  • Extract the contents of the mod file to your Stardew Valley mods folder
    e.g. "C:\Program Files (x86)\Steam\SteamApps\common\Stardew Valley\Mods\"
  • Launch Stardew Valley using SMAPI

For Players: 

Install GMDF and any mods that ship a documentation.json . The documentation button will appear on your HUD. Click it to browse help pages for all supporting mods. If you find the framework icon on the top left of the screen annoying, you can disable it in the GMCM settings. 

Requirement:

  • Stardew Valley 1.6.0 or later
  • SMAPI 4.1 or later

For Mod Authors: 

Use the following interface to build documentation files instead of writing it manually : GMDFBuilder


Steps to integrate with this framework:
1. Create a documentation.json file in your mods base path. Use the Documentation Builder to write your desired documentation.
2. If you are using i18n tags in your documentation, make sure your i18n jsons inside <mod-base-folder>\i18n folder.
3. Add GMDF as a dependency for your mod.
4. Build your mod, open the game and check for the framework icon at top-left, click and find your mod documentation.

Compatibility :

  • Tested on Stardew Valley 1.6.15 and SMAPI 4.5.1
  • Not tested on Android yet
  • This mod supports the mobile phone mod, if the app is installed, GMDF icon shows up inside the mobile phone interface instead of top left of the screen. ( Thanks to @To2morrow for the integration suggestion )

Language Support(i18n):


Framework Source Code : Github
If this mods helps you, please consider donating on Ko-fi