Guide GGU OpenMod Permissions Setup Guide

[- Alex - 36]

GGU OpenMod Permissions Setup Guide
This guide is continuously being updated as information changes, this can happen without warning. Last update 9/27/25.

---

Introduction
This guide provides comprehensive instructions for configuring OpenMod permissions, roles, and access control on your Unturned game servers. OpenMod's advanced permission system allows for granular control over player and admin privileges while maintaining security and operational integrity in compliance with GGU hosting standards.

Who can configure OpenMod permissions?
- GGU Leadership Team (Staff, Manager, Senior Manager, Community Leader)
- GGU Development Team
- Server owners with full administrative access
- Internal/External partners with authorized server management permissions

Prerequisites and Requirements
- OpenMod properly installed and running on Unturned server
- SFTP or FTP access to server configuration files
- Understanding of Steam ID formats and identification
- Basic knowledge of YAML configuration syntax
- Access to restart server or reload OpenMod configurations

Understanding OpenMod Permission System
Permission Components:
- Permissions: Specific node-based access rights (e.g., plugin.command.kick)
- Roles: Groups of permissions with inheritance support
- Actors: Users or groups that can be assigned permissions
- Priority: Determines permission resolution order

Configuration Files:
- permissions.yaml: Main permission configuration file
- openmod.yaml: Core OpenMod configuration
- Plugin-specific permission files (varies by plugin)

Permission Node Structure:
- Hierarchical dot notation (e.g., RocketMod.Essentials.kick)
- Wildcard support (*) for broad permissions
- Negation support (-) to explicitly deny permissions

Step 1: Locating Configuration Files
File Locations:
- Navigate to your Unturned server directory
- OpenMod files are typically in: /Servers/YourServer/OpenMod/
- Main config: /OpenMod/openmod.yaml
- Permissions: /OpenMod/permissions.yaml

Backup Existing Configuration:
- Always create backups before making changes
- Copy permissions.yaml to permissions.yaml.backup
- Document current permission structure for reference

Step 2: Basic Permission Configuration
Example permissions.yaml Structure:

Spoiler

roles:
  default:
    permissions:
    - "OpenMod.Core.Commands.help"
    - "OpenMod.Core.Commands.openmod"
    priority: 0

  vip:
    parents:
    - "default"
    permissions:
    - "RocketMod.Essentials.home"
    - "RocketMod.Essentials.tpa"
    priority: 10

  moderator:
    parents:
    - "vip"
    permissions:
    - "RocketMod.Essentials.kick"
    - "RocketMod.Essentials.teleport"
    - "RocketMod.Essentials.god"
    priority: 50

  admin:
    parents:
    - "moderator"
    permissions:
    - "RocketMod.Essentials.ban"
    - "RocketMod.Essentials.unban"
    - "RocketMod.Essentials.save"
    priority: 80

  owner:
    permissions:
    - "*"
    priority: 100

Step 3: Assigning Users to Roles
User Assignment in permissions.yaml:

Spoiler

users:
  76561198024691356: # Steam64 ID
    roles:
    - "owner"
    permissions:
    - "OpenMod.Core.*"

  76561198087654321:
    roles:
    - "admin"
    permissions: []

  76561198011111111:
    roles:
    - "moderator"
    permissions:
    - "RocketMod.Essentials.heal"

Alternative Actor Types:
- Steam64 ID: 76561198024691356
- Steam ID: STEAM_1:0:32345678
- Player name: "PlayerName" (not recommended for permanent assignments)

Step 4: Advanced Permission Features
Permission Wildcards:
- "*" grants all permissions
- "RocketMod.Essentials.*" grants all Essentials commands
- "OpenMod.Core.Commands.*" grants all core OpenMod commands

Permission Negation:
permissions:
  - "RocketMod.Essentials.*"
  - "-RocketMod.Essentials.ban" # Deny ban command
  - "-RocketMod.Essentials.kick" # Deny kick command

Conditional Permissions:
permissions:
  - permission: "RocketMod.Essentials.god"
    conditions:
    - type: "location"
      data: "safezone"

Step 5: Plugin-Specific Permissions
Common RocketMod Essentials Permissions:
Basic Commands:
- RocketMod.Essentials.help
- RocketMod.Essentials.experience
- RocketMod.Essentials.reputation
- RocketMod.Essentials.time

Teleportation Commands:
- RocketMod.Essentials.teleport
- RocketMod.Essentials.tpa
- RocketMod.Essentials.home
- RocketMod.Essentials.warp

Administrative Commands:
- RocketMod.Essentials.kick
- RocketMod.Essentials.ban
- RocketMod.Essentials.unban
- RocketMod.Essentials.god
- RocketMod.Essentials.heal
- RocketMod.Essentials.save
- RocketMod.Essentials.shutdown

Step 6: Role Hierarchy and Inheritance
Understanding Role Inheritance:
- Child roles inherit permissions from parent roles
- Multiple parents can be specified
- Higher priority roles override lower priority permissions
- Explicit denials (-permission) override inherited permissions

Recommended Role Hierarchy:
1. default (Priority: 0) - Basic player permissions
2. vip (Priority: 10) - Enhanced player features
3. helper (Priority: 20) - Limited moderation tools
4. moderator (Priority: 50) - Full moderation capabilities
5. admin (Priority: 80) - Server administration
6. owner (Priority: 100) - Full server control

Steam ID Formats and Identification
Steam ID Formats:
- Steam64 ID: 76561198024691356 (Recommended for OpenMod)
- Legacy Steam ID: STEAM_1:0:12345678
- Steam3 ID: [U:1:24691356]

Finding Steam64 IDs:
- Use Steam profile URL: steamcommunity.com/profiles/76561198024691356
- Visit steamid.io for ID conversion
- Use Unturned server logs to find connected player IDs
- Check /logs folder for player connection records

Example Steam64 Usage:
users:
  76561198024691356:
    roles: ["admin"]
  76561198087654321:
    roles: ["moderator"]

Configuration Validation and Testing
YAML Syntax Validation:
- Use online YAML validators before uploading
- Check proper indentation (2 spaces, no tabs)
- Ensure quotation marks are properly closed
- Verify array and object syntax

Reload Permissions:
- Use "/openmod reload" command in game or console
- Or restart the server for guaranteed reload
- Monitor console for configuration errors

Test Permission Access:
- Connect with configured Steam accounts
- Test various commands at different permission levels
- Verify role inheritance works correctly
- Check that denied permissions are blocked

Permission Templates for Common Roles

Spoiler

Server Owner Template:
owner:
  permissions:
  - "*"
  - "OpenMod.Core.*"
  priority: 100

Administrator Template:
admin:
  parents: ["moderator"]
  permissions:
  - "RocketMod.Essentials.ban"
  - "RocketMod.Essentials.unban"
  - "RocketMod.Essentials.save"
  - "RocketMod.Essentials.shutdown"
  - "OpenMod.Core.reload"
  priority: 80

Moderator Template:
moderator:
  parents: ["vip"]
  permissions:
  - "RocketMod.Essentials.kick"
  - "RocketMod.Essentials.teleport"
  - "RocketMod.Essentials.god"
  - "RocketMod.Essentials.heal"
  - "RocketMod.Essentials.freeze"
  priority: 50

VIP Template:
vip:
  parents: ["default"]
  permissions:
  - "RocketMod.Essentials.home"
  - "RocketMod.Essentials.tpa"
  - "RocketMod.Essentials.warp"
  - "RocketMod.Essentials.experience"
  priority: 10

Troubleshooting Permission Issues
Configuration Not Loading:
- Check YAML syntax for errors
- Verify file permissions are readable
- Review OpenMod console logs for error messages
- Ensure proper file encoding (UTF-8)

User Permissions Not Working:
- Confirm Steam64 ID is correct
- Check if user is connecting with the right Steam account
- Verify role assignments and inheritance
- Test with explicit permission grants

Commands Still Restricted:
- Check for permission negations (-permission)
- Verify plugin-specific permission nodes
- Review priority order conflicts
- Ensure plugins are loaded and functional

Advanced Permission Management
Time-Based Permissions:
permissions:
  - permission: "RocketMod.Essentials.god"
    conditions:
    - type: "time"
      start: "09:00"
      end: "17:00"

Location-Based Permissions:
permissions:
  - permission: "RocketMod.Essentials.creative"
    conditions:
    - type: "region"
      data: "build_zone"

Group-Based Management:
- Create role groups for team management
- Use consistent naming conventions
- Document permission structures for team reference

Security and Best Practices
- Use the principle of least privilege - grant only necessary permissions
- Regularly audit user permissions and remove inactive administrators
- Implement proper role hierarchy with clear separation of duties
- Golden Gamers United (GGU) configuration files may not be modified or removed unless given explicit permission from the GGU Leadership Team (Manager+)
- Keep backup copies of permissions.yaml before making changes
- Monitor server logs for permission-related errors and unauthorized access attempts
- Use Steam64 IDs rather than player names for permanent assignments

Useful Permission Management Commands
OpenMod Commands:
- /openmod reload (Reload all configurations)
- /openmod reload permissions (Reload permissions only)
- /openmod plugins (List loaded plugins)
- /permission add <actor> <permission> (Grant permission)
- /permission remove <actor> <permission> (Revoke permission)

Information Commands:
- /permission check <actor> <permission> (Check specific permission)
- /permission list <actor> (List actor permissions)
- /role add <actor> <role> (Assign role)
- /role remove <actor> <role> (Remove role)

Reporting and Compliance
- Report any unauthorized permission access or configuration issues to the GGU Leadership Team immediately
- Document all permission changes and maintain detailed change logs
- Include configuration files and OpenMod logs when seeking technical support
- Golden Gamers United (GGU) reserves the right to monitor and audit OpenMod permission configurations to ensure compliance with security policies and prevent administrative abuse

Conclusion
By following this comprehensive OpenMod permissions setup guide and adhering to GGU's security policies, administrators can establish a robust and flexible permission system for their Unturned servers. OpenMod's advanced permission features enable precise control over player and admin capabilities while maintaining the security standards that Golden Gamers United (GGU) is committed to upholding across all hosted gaming environments.