Unturned: RocketMod

From Free Knowledge Base- The DUCK Project: information for everyone
Jump to: navigation, search

RocketMod .NET Game Server Plugin Framework for the Unturned: Server. The Legally Distinct Missile aka LDM is the latest version of RocketMod.

OpenMod is an alternative or replacement for RocketMod, however, it is less used and furthermore can be run along with RocketMod.

RocketMod used to be a popular modding framework for Unturned, but has disbanded and the project was discontinued in late 2019.

The Legally Distinct Missile (or LDM) is a fork of Rocket for Unturned maintained by the game developers (SDG) after the resignation of its original community team. Using this fork is recommended because it preserves compatibility, and has fixes for important legacy Rocket issues like multithreading exceptions and teleportation exploits. Nelson, the creator of Unturned, has forked RocketMod 4 and continues to keep up combability to Unturned 3. The core mod is now part of the game distribution.

Installation

The necessary modules must be installed. The original Rocket Mod is an abandoned project. A fork is maintained by the game developers so that functionality can be maintained.
The dedicated server includes the latest version, so an external download is not necessary.

  1. Install "Legally Distinct Missile (RocketMod 4) - Fork of Rocket for Unturned maintained by the game developers"
  2. Install the necessary RocketMod Libraries
  3. Install the RocketMod 4 Plugin: RocketTools.dll

RCON

Remote Console connection is made with a simple telnet client. You can use the 'telnet' command on linux or software for Windows such as Putty or CRT. RCON must be enabled on your Unturned server. Navigate to the configuration file and set the service to 'true' then restart the server.

  1. Edit Rocket.config.xml ( Servers/server/Rocket/Rocket.config.xml )
  2. Change <RCON Enabled="false" Port="0" Password="" to <RCON Enabled="true" Port="25444" Password="yourpassword"
  3. Save and restart the server

Example Rocket.config.xml 

<?xml version="1.0" encoding="utf-8"?>
<RocketSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RCON Enabled="true" Port="25444" Password="l9FccX92q" EnableMaxGlobalConnections="true" MaxGlobalConnections="1" EnableMaxLocalConnections="true" MaxLocalConnections="1" />
  <AutomaticShutdown Enabled="false" Interval="86400" />
  <WebConfigurations Enabled="false" Url="" />
  <WebPermissions Enabled="false" Url="" Interval="180" />
  <LanguageCode>en</LanguageCode>
  <MaxFrames>60</MaxFrames>
</RocketSettings>

Commands / Usage

The following is a list of default RocketMod 4 Commands:

Tip: If you make some settings modifications in the RocketMod configuration you can often simply reset the module without restarting the entire Unturned server. If you are only making minor changes, or there's players on the server, use the command reload command: 

   /rocket reload

Admin Commands 

   /admin <player> - adds the specified player to admin list
   /broadcast <message> - broadcasts a message to server
   /exit - disconnects you from server
   /god - turns on and off god mode
   /heal [player] - heals a given player / leave blank for self-heal
   /help - shows help information
   /i <item> [amount] - gives you items
   /item <item> [amount] - gives you items
   /more - gives more items
   /tp <player> - teleports you to a given player
   /tphere <player> - teleports a given player to you
   /unadmin <player> - removes the specified player from admin list
   /vanish - turns on and off invisibility to other players
   /v <vehicle> - gives you a vehicle

Feature Commands 

   /compass - tells you what direction you are facing
   /effect <effect id> - spawns Unturned effect
   /home- teleports you to your last bed placed

Informative Commands 

   /investigate <player> - tells you the player's Steam 64 id
   /p <player> - shows your permissions, or the permissions of others (p)
   /p reload - reloads the permissions (p.reload)
   /p [add | remove] <player> <group> - add / remove player to group (p.add, p.remove)
   /rocket <plugins | reload> | <reload | unload | load> <plugin> - Reloading Rocket or individual plugins (rocket.plugins, rocket.reload, rocket.reloadplugin, rocket.unloadplugin, rocket.loadplugin)

You can limit the total number of times that the user or certain group can spawn using the /i or /item command. Edit Servers/unturned/Rocket/Rocket.Unturned.config.xml 

 <MaxSpawnAmount>10</MaxSpawnAmount>

User can spawn no more than 10 of a given item with a single use of the command. /i 14 22 shows user wants 22 water bottles but will only get 10. The admin user has no limitation, admin overrides.

Groups and Permissions

By default Rocket installs with (3) player levels, or groups. Each has access to certain commands and abilities. Default groups are "default" and "vip". Those two are defined in Rocket/Permissions.config.xml and the third level is the admin level which has no group entry. To define what commands and abilities are available to a group you must edit Permissions.config.xml. For example, if we want regular non-privileged players to be able to use the /ammo /i /v and /heal commands, some of which are from other mods, we must add entries to make Rocket/Permissions.config.xml contain: 

  <DefaultGroup>default</DefaultGroup>
  <Groups>
    <Group>
      <Id>default</Id>
      <DisplayName>Guest</DisplayName>
      <Prefix>Player</Prefix>
      <Suffix />
      <Color>white</Color>
      <Members />
      <Priority>100</Priority>
      <Permissions>
        <Permission Cooldown="0">p</Permission>
        <Permission Cooldown="5">ammo</Permission>
        <Permission Cooldown="5">i</Permission>
        <Permission Cooldown="5">v</Permission>
        <Permission Cooldown="60">heal</Permission>
        <Permission Cooldown="0">essentials.command.kits</Permission>
        <Permission Cooldown="0">essentials.command.kit</Permission>
        <Permission Cooldown="90">essentials.kit.fuel</Permission>
        <Permission Cooldown="90">essentials.kit.starter</Permission>
      </Permissions>
    </Group>

When a normal player connects to the server, his name will be displayed with the word "player" appended to the front because of line 6 (Prefix). If you don't want that, change that line to: 

      <Prefix />

The commands like v to spawn a vehicle and i to spawn an item are now available to regular players in the default player group, the group everyone starts out in.

For some reason if the command is part of the uEssentials mod then it has to be formatted with "essentials." prefixed to the command in this configuration even though the command is one word, such as with the kits command. Two word commands like /kit fuel and /kit starter work the same way, as part of uEssentials they require prefixed to their entry in this config file the "essentials." It is not like that with most plugins, but with some it is. Try it without first and if that doesn't work then whatever plugin the command is coming from must have specific requirements for the formatting.

If you modified kit or command permissions in Permissions.config.xml and want to refresh them without stopping and restarting the sever, as admin simply type: 

/p reload

TPA

tpa is part of uEssentials and therefore when added to Permissions.config.xml it will require the "essentials.kit." prefix. 

        <Permission Cooldown="60">essentials.command.tpa</Permission>
        <Permission Cooldown="60">essentials.command.tpa.send</Permission>
        <Permission Cooldown="60">essentials.command.tpa.cancel</Permission>
        <Permission Cooldown="60">essentials.command.tpa.accept</Permission>
        <Permission Cooldown="60">essentials.command.tpa.deny</Permission>

Rocket Permissions

On the official Rocket Wiki (outdated version) you can find some sample configuration and information.

You can blacklist items and vehicles. This does not restrict the admin group, however it will prevent any other player from using something like the /i command to obtain blacklisted items and vehicles. The items may still naturally spawn.

At the bottom of ( unturned/Rocket/Plugins/uEssentials/config.json ) look for the following 2 lines: 

"GiveItemBlacklist": [],
"VehicleBlacklist": [].

They are not populated with any example id's. Use the correct format and add those items and vehicles you want blacklisted. See syntax example: 

 "GiveItemBlacklist": [
   58886,
   58680,
   58709,
   58870
 ],
 "VehicleBlacklist": [
   375,
   376,
   377
 ],

change requires complete server restart.

Additional Modules: RocketMod 4 Plugins

In the permissions.config file, (In the server > rocket) you'll need to add player-accessable commands. Here's some common ones: Home, tpa, tpa.accept, tpa.deny, kit.kitname

All of the modules are not covered here, only some of the current modules commonly used. Plugins need to be compiled in order to be used. Some may not support the latest versions of Rocket or Unturned. If you are using a game hosting provider then odds are that they will provide many of these already compiled.

  • AdvancedSpawnProtection.dll - Period of invulnerability for player in seconds after spawn or respawn, protection against spawn killing.
configure by editing /Servers/server/Rocket/Plugins/AdvancedSpawnProtection/AdvancedSpawnProtection.configuration.xml
  • ChatControl.dll - Banlist and Mute, based on word recognition.
configure by editing /Servers/server/Rocket/Plugins/ChatControl/ChatControl.configuration.xml
  • ChatGod.dll - control over chat, similar to ChatControl.dll so you probably won't need them both. This one has more configuration options.
configure by editing /Servers/server/Rocket/Plugins/ChatGod/*
  • EasyAmmo.dll - use the /ammo command to obtain magazines for the active weapon being held. You can ban specific weapon ammo magazine types by Id from being replenished by this command.
configure by editing /Servers/server/Rocket/Plugins/EasyAmmo/EasyAmmo.configuration.xml
  • PlayerInfoLib.dll - More Advanced / Detailed Investigate Command - this requires mysql
configure by editing /Servers/server/Rocket/Plugins/PlayerInfoLib/PlayerInfoLib.configuration.xml
  • RocketMod_TPA.dll - Just like TPA in Minecraft, this allows players to request a teleport to other players and the other player can accept or deny their request.
  • uEssentials - see Unturned: uEssentials
  • Vaults.dll - Store Items for Later Access (requires mysql)
configure by editing /Servers/server/Rocket/Plugins/Vaults.configuration.xml
  • WreckingBall.dll - clear structures that players build by parameters such as within range. You can include or exclude items in the config.
configure by editing /Servers/server/Rocket/Plugins/WreckingBall/WreckingBall.configuration.xml

AdvancedZones

  • unturned/Rocket/Plugins/AdvancedZones/AdvancedZones.configuration.xml

Zone command examples 

/zone add zone MySafeZone
/zone add mesage MySafeZone blah blah
/zone list zones
/zone show border MySafeZone on
/zone show node MySafeZone on

Uconomy and ZaupShop

It is not necessary to have ZaupShop to have Uconomy, however, ZaupShop requres Uconomy. Some people erroneously search for the term Ueconomy instead of Uconomy so it is mentioned here.

A digital economy. Players can get paid for killing Zombies or each other. You also need ZaupUconomyEsentials: you can change how much people get in the configuration from every zombie killed.

Uconomy Provides: Only those players who are whitelisted will be able to use the uconomy commands.

Commands:

  • /balance
  • /pay - use /pay [player name] [amount] -

ZaupShop Provides:

Allows a shop for players to use Uconomy currency to buy items and vehicles. Buying vehicles is turned off by default.

3 commands: /shop, /cost, /buy, and /sell.

  1. /shop - meant for admin use only to configure items in the shop
  2. /cost
  3. /sell 
/buy [v.]<item name or id>/[amount]

This will use the same name to id find as /i. Use v for vehicles. Amount is only available for items and is optional, default is 1. 

/cost [v.]<item name or id>

Same as above but will display the user the cost of asked for item/vehicle as well as the sell cost if there is one (sell cost for magazines and ammunition boxes is for full capacity not individual bullets). 

/sell <item name or id>/[amount]

This will allow you to sell items (no vehicles) back to the shop. If QualityCounts is set to true, the quality of the item will determine how much of the price is received. If buyback is 1.00 and quality is 45%, you’ll receive 0.45 for example. For magazines and ammunition boxes, it will buy back individual bullets. Quality isn’t used here as there is none. So if you want to sell a full military ammo box of 40, you’ll do /sell military ammunition/40. 

/shop <add/rem/chng/buy>/[v.]<itemid>/<cost>

This is the most complicated as it has multiple options. add (Adding), rem (Removing), chng (Change cost), buy (Buyback amount), v is needed if dealing with vehicles. Itemids only (no names) for this command and one is required. Cost is not required for rem, but is required for the others. You do have to add the buyback amount separately from the add or chng.

Permissions.config.xml

In the default group: 

<Permissions> <Permission Cooldown="0">pay</Permission> </Permissions>

Troubleshooting and Support

You can force an update to LDM on most hosting providers by removing all contents of the directory: 

Modules/Rocket.Unturned

and reboot

imperial

Some pay plugins use LDM, like Advanced Regions. Configuration to enable or disable is controlled by the file: 

/Servers/unturned/Rocket/Plugins/ImperialPluginsLoader/ImperialPluginsLoader.configuration.xml

All the license keys are in this file.

Retrieved from "http://wiki.robotz.com/index.php?title=Unturned:_RocketMod&oldid=20725"