G1R Modding API

Description

G1R Modding API is an unofficial community modding API for Gothic 1 Remake, designed to provide a shared foundation for UE4SS Lua mods.

Its purpose is to centralize commonly needed game-facing functionality so individual mods do not have to repeatedly discover, implement, test and maintain the same low-level systems themselves. Mods can use only the functionality they need while relying on a common, reusable underlying implementation.

The API has grown into a broad interface to Gothic 1 Remake's runtime systems. The current API catalogue contains more than 600 documented public functions and helpers covering areas such as player and actor access, movement, interaction, inventory and equipment, spawning, regions, game time, camera behavior, combat, progression, trading, sleep, input, UI, lifecycle management and runtime diagnostics.

A major focus of the project is safe and cooperative mod interoperability. Where possible, the API provides guarded access, lifecycle-aware helpers, caching and restoration mechanisms instead of requiring every mod to directly manipulate game internals on its own.

The API also distinguishes between established functionality and experimental or context-sensitive systems where runtime evidence is still developing. This allows the project to expand without presenting unverified functionality as universally safe.

Development and testing of the API is supported by the G1R Modding Diagnostics/Debugger, which provides dedicated API validation, runtime inspection, snapshotting and diagnostic tools.

See the included README, API Reference and Function Catalogue for detailed documentation of the available modules, functions, safety considerations and usage.

This is an unofficial community project and is not affiliated with or endorsed by Alkimia Interactive or THQ Nordic.

Installation

Extract the mod folder into:

G1R/Binaries/Win64/ue4ss/Mods/

Alternatively, install it using a supported mod manager.

The resulting installation should contain:

G1R/Binaries/Win64/ue4ss/Mods/G1R_Modding_API/

Mods that require G1R Modding API can then access its shared functionality without bundling their own copies of the same systems.

Main Features

• []Shared Lua modding API for Gothic 1 Remake [/]

  []More than 600 documented public API functions and helpers [/]

  []Common player, pawn, actor and world access [/]

  []Movement and locomotion helpers [/]

  []Interaction and focused-actor access and classification [/]

  []Inventory and equipment functionality [/]

  []Managed spawning and despawning with shared spawn lifecycle functionality [/]

  []Location and region detection with canonical region mapping [/]

  []Shared game-time and world-state functionality [/]

  []Actor orientation, rotation and facing helpers [/]

  []Camera behavior inspection, snapshot, modification and restoration helpers [/]

  []Combat, damage and ability related runtime access [/]

  []Progression and XP observation helpers [/]

  []Trading and economy helpers, including guarded trade-boundary functionality [/]

  []Sleep and recovery lifecycle access [/]

  []Shared input and key-binding functionality [/]

  []UI and menu inspection and helper functionality [/]

  []Game, world and map lifecycle helpers [/]

  []Reusable hooks, guards, caching and restoration infrastructure [/]

  []Runtime utilities intended to reduce duplicated low-level code between mods [/]

  []Designed as a shared dependency for multiple mods [/]

  []Experimental research surfaces for functionality that is still being investigated or validated [/]

  []Dedicated API validation through the G1R Modding Diagnostics/Debugger [/]

  []Included README, API Reference, Function Catalogue and research documentation [/]

  For Mod Authors

  G1R Modding API is intended to act as a common compatibility and development layer rather than a collection of gameplay changes.

  Mods can call the API only where required and remain responsible for their own gameplay logic. Shared systems can therefore be improved or hardened in one place instead of every dependent mod maintaining a separate implementation.

  The API includes functionality ranging from simple read-only helpers to guarded runtime operations and experimental research surfaces. Mod authors should consult the included documentation for the verification and safety status of functionality they intend to use.

  The API itself does not attem