Unturned: OpenMod

From Free Knowledge Base- The DUCK Project: information for everyone
Revision as of 01:43, 20 January 2022 by Littleguy (Talk | contribs)

Jump to: navigation, search

OpenMod is the successor of RocketMod. OpenMod supports all RocketMod plugins. Plugins add new functionality to your server. OpenMod provides commands to download, install, update, and remove plugins at runtime. You can convert from RocketMod to OpenMod using their installation and conversion script. Plugins from https://imperialplugins.com/ mostly require OpenMod, if not exclusively.

Installation

Installing OpenMod for Unturned (RocketMod plugin)

  1. Download the latest OpenMod Installer Plugin for RocketMod.
  2. Move it to the /Rocket/Plugins folder and restart your server.
  3. Run /openmod install and follow the instructions.

Installing and Updating Plugins

There are two ways to install plugins:

Option 1: Installing plugins from NuGet. You can install plugins from NuGet using the openmod install <package id> command, e.g. openmod install Kr4ken.NewEssentials. To install specific versions, use openmod install <package id>@<version>. If you want to enable installation of pre-release versions, add the -Pre option: openmod install <package id> -Pre. To update plugins, run openmod install <package id> again.

Option 2: Installing plugins manually. You can install plugins manually by moving the plugin dll file and all libraries of the plugin to the openmod/plugins folder. You can also install libraries with openmod install <package id> instead. To update plugins replace the .dll file with the newer one.

You must reload OpenMod with openmod reload to apply changes after installing or updating plugins.

Specific Plugins (examples)

To install the SilK's Plugin called ShopsUI you must first purchase the plugin from imperialplugins.com

1. Purchase the plugin and obtain the license key.

2. Download the zip file from your purcahase. In this case it is openmod-ImperialPluginsLoader.zip

3. Stop the Unturned Server or ensure it is not running. Extract contents and then upload them to the Unturned serer. Specific files go in specific places.

  • Copy (2) files from the archive folder called "native" to: Servers/unturned/OpenMod/native
  • Those two files are ImperialPluginsNativeLoader.dll and ImperialPluginsNativeLoader.so
  • Copy (2) files from the archive folder called "plugins to: Servers/unturned/OpenMod/plugins
  • Those two files are ImperialPlugins.Loader.dll and K4os.Compression.LZ4.dll

4. Now edit "config.yaml" in the OpenMod/Plugins/ImperialPlugins.Loader folder.


Edit Servers/unturned/OpenMod/plugins/ShopsUI/config.yaml

Removing Plugins

To remove plugins which have been installed using openmod install, use openmod remove <package id>. If you installed the plugin manually instead, delete the .dll file.