OpenMod: What It Is & How It Fits Together

[- Alex - 36]

OpenMod: What It Is & How It Fits Together
Framework Architecture for Server Operators
GGU Public Technical Knowledge Base

Public Knowledge Base:
This article is written for both GGU administrators and the wider server-hosting community. General instructions are platform-neutral where possible; GGU-specific practices are identified separately.

 

Applies To

• OpenMod administrators
• Unturned/OpenMod server operators
• Plugin developers

 

Prerequisites

• A server or test environment where OpenMod is installed or planned

 

What You’ll Accomplish

Understand the framework, plugin, permission, configuration, and logging layers before making changes.

 

What OpenMod Is

OpenMod is a plugin framework used by supported game servers to add commands, permissions, configuration, logging, and plugin-provided functionality. For administrators, the important distinction is between the OpenMod framework itself and the individual plugins installed on top of it.

 

Core Concepts

• OpenMod framework: loads and manages plugins and shared services.
• Plugins: add features such as commands, moderation, economy, integrations, or server utilities.
• Roles and permissions: determine which users can execute protected actions.
• Configuration: OpenMod and plugins commonly use YAML files.
• Runtime management: OpenMod provides commands to install, update, remove, reload, and inspect components.
• Logging: OpenMod uses structured logging and can be configured through its logging configuration.

 

Typical Directory Layout

OpenMod/
├── openmod.yaml
├── openmod.roles.yaml
├── openmod.translations.yaml
├── logging.yaml
└── plugins/
    ├── <plugin id>/
    │   └── config.yaml
    └── ...

Exact capitalization or surrounding game-server paths can differ by platform, package, or host. The important part is to distinguish framework configuration from plugin-specific configuration.

 

Administration Model

OpenMod's public administrator documentation describes a role-based permission system. Users inherit permissions from assigned roles, and roles can inherit from parent roles. This is more maintainable than individually granting every permission to every user.

 

When to Use This KB

• Installing or updating a plugin.
• Building a role hierarchy.
• Finding why a command returns a permission error.
• Editing plugin YAML.
• Troubleshooting a plugin that will not load.
• Deploying a custom OpenMod plugin.
• Understanding where OpenMod logs and configuration live.

 

GGU Implementation Notes

GGU uses OpenMod primarily on supported game servers such as Unturned. Public articles should remain useful to any OpenMod operator; where GGU has an in-house plugin, role naming scheme, Pelican deployment workflow, or Gitea repository, those details are documented as implementation examples rather than universal requirements.

 

Upstream References

• OpenMod Permissions
• OpenMod Plugins
• OpenMod Configuration Files

 

Golden Gamers United — Public Technical Knowledge Base
General guidance first. GGU implementation details second.