Commands

Introduction

uMod integrates with command-line and chat interfaces available in various games. A number of built-in commands are available for users by default.

The commands below should not be confused with uMod Agent commands and are only available in a running game server terminal. Some games might allow access to the server terminal from tools (e.g. RCON) or even from within the game itself.

Plugin commands

• Plugins

  umod.plugins
  

  Prints a list of loaded plugins similar to...
  ## "Title" (version) by Author (####s) - Filename
  The duration column above will show the average execution speed of hooks, timers, and web requests in seconds.

  uMod tracks the average execution speed of hooks, timers, and web requests in every plugin.

  If any given hook call exceeds the average execution by a significant margin, uMod will log a Time Warning.

• Load

  umod.load PluginName [PluginName] [..]
  

  Loads the specified plugin(s)

• Reload

  umod.reload PluginName [PluginName] [..]
  

  Reloads the specified plugin(s)

• Unload

  umod.unload PluginName [PluginName] [..]
  

  Unload the specified plugin(s)

Authorization commands

Consider the Permissions documentation for example usage of the authorization commands below.

• Grant

  umod.grant [player/group] [name/id] [permission]
  

  Grants the specified permission to the specified player or group
• Revoke

  umod.revoke [player/group] [name/id] [permission]
  

  Revokes the specified permission to the specified player or group
• Group

  umod.group [add/remove] [name] [title] [rank]
  

  Adds or removes a group from the server
• Show

  umod.show groups
  

  Prints a list of all groups

  umod.show group [name]
  

  Prints a list of group members and permissions

  umod.show perms
  

  Prints a list of all currently registered permissions

  umod.show perm [permission]
  

  Prints a list of all players or groups who currently have the specified permission
  u.show player [name/id]
  Prints a list of all of the specified player's permissions
• UserGroup

  umod.usergroup [add/remove] [player name/id] [group name]
  

  Adds or removes a player to/from the specified group

Administration

• Shutdown

  umod.shutdown
  

  Initiates a shutdown procedure
• Save

  u.save
  

  Initiates a world save procedure

Agent

The following agent commands are available from server console.

• Show
  The show command will list all available packages.
• Require
  The require command installs new plugins into the umod/plugins directory.
• Update
  The update command updates installed plugins
• Remove/Uninstall
  The remove command removes plugins from the server.
• Old/Obsolete/Outdated
  The old command shows a list of installed plugins and packages with updates available.
• Suggests
  The suggests command lists any plugins suggested by other installed plugins.
• Depends
  The depends command lists any plugin that depend on a specified plugin
• Prohibits
  The prohibits command lists any plugins that are blocking a specified plugin from being installed.
• Status
  The status command lists any plugins or packages which have local changes.
• Licenses
  The licenses command lists the name and license of every installed plugin.
• Fund
  The fund command lists all the donation links from installed plugins.

Miscellaneous

• Lang

  umod.lang [language]
  

  Gets or sets the player or server language
• Version

  umod.version
  

  Prints the current server version
• Import

  umod.import [driver/connection]
  

  Examples:

  umod.import protobuf
  umod.import sqlite
  umod.import mysql
  

  Imports existing player/group data to the currently configured auth.driver

Developers

To implement custom commands consider the developer Commands documentation.