NidToolbox: Player Manager module

Contains commands useful in day-to-day player management, ability to Reset Skills, Talents and progression, set Job Level and refund specialisation points of any player on the server, geo-location and more.

NIDTOOLBOX' DOWNLOAD LOCATION CHANGED TO -> https://eco.mod.io <-

! UP TO DATE DOCUMENTATION ONLY UNDER THE ABOVE ADDRESS !

I had to limit the amout of places I need to update the texts whenever I add or remove commands and update individual modules, sorry!

Player Manager module

for NidToolbox Light

requries nid-core module available here

NEW - if you would like to have your server logo appear in the notifications area in messages that come from NidToolbox. Please join my Discord https://discord.nidaren.net/ and post them in #server-logos channel.

Useful in day to day administration of your citizens.

Support is provided as well as suggestions are accepted on my Discord here

Player Manager module allows:

• Easy player resets to the starting state, including reimbursement of any deleted alpha backer items, (see below for screenshots) each time you reset a player, a confirmation window will be displayed - providing the details of the reset, as well as targeted player and their information. This allows you to abort the procedure at any time.
• Vehicle management commands, self rescue vehicle command with cooldown and configurable limitations caloric cost, maximum distance and load level.
• Fixes some of the errors present in the vanilla game reset commands: non updating skill tree and ghosting issue.
• Setting of required profession levels, including up levels and de-levels;
• Checking and changing the tastiness of food items as well as setting/changing favorite and worst food for person.
• Ability to alter and sync player levels.
• Module takes into account translated and localised names, should your server be running in language other than English. For example: You can use Готовка for Cooking or Holzfällen for Logging.
• Module accepts partial names for easier lookup.
• Granting and deducting of specialty points, with respect and checks against locked and already invested points.
• Additional user tooltip information - IP, SteamId and SLGId, with customisation of which user groups can see these.
• Resetting individual professions to the unlearnt state;
• As it is impossible to target talents by their localised (translated and displayed names), this module provides a helpful way to remove talents either one by one or enmasse. Popup window will list all of the player's talents, including their links, so administrator may ensure they remove a desired talent.
• Ability to obtain geo-location info on the player, their IP address and details about it. Allows to detect players using same IP address, for administrators who use this feature.
• Custom announcements, warnings, offline messages.

Settings file:

Settings for the module are located in Configs/NidToolbox/PlayerManager.json and deal mainly with visibility of the additional user tooltip information.

{
  "Info1": "NidToolbox Light: Player Manager settings.",
  "ShowIPinTooltip": true,
  "ShowSteamIdinTooltip": true,
  "ShowSlgIdInTooltip": true,
  "ShowShopsInTooltip": true,
  "ShowTooltipInfoToGroups": [
    "Admin"
  ],
  "EnableUserVehicleRescueCommand": true,
  "UserVehicleCommandCooldownMinutes": 120.0,
  "BlackListed": false
}

ShowIPinTooltip - sets IP Address visibility in the user's tooltip. Can be also changed in game via /tooltip-conf

ShowSteamIdinTooltip - sets Steam Id visibility in the user's tooltip. Can be also changed in game via /tooltip-conf

ShowSlgIdInTooltip - sets Slg Id visibility in the user's tooltip. Can be also changed in game via /tooltip-conf

ShowTooltipInfoToGroups - EM Groups included in this list can view additional tooltip info, mentioned above. Can be set in game via /tooltip-grpAddand /tooltip-grpdel

EnableUserVehicleRescueCommand - Enables /car-rez command. Used on the issuing user, allows for rescue of stuck or otherwise inaccessible vehicle. Teleports vehicle to player.

UserVehicleCommandCooldownMinutes - Cooldown for /car-rez in minutes.

Requirements:

As any module of NidToolbox set, it requires nid-core version 1.0.3+ module, available in the main forum thread: here

How to install:

1. Unpack .zip archive
2. Copy nid-playermanager.dll to Mods\NidToolbox\Modules

Usage Notes:

Module accepts partial names for skills, if serveral same partial names exist, you will have to be more specific.

Module accepts skill names in the language set on server. For example: You can use Готовка for Cooking or Holzfällen for Logging.

Available commands:

Command Groups

/help ManagePlayer

Displays information about all commands contained within this module.

/NidFood

Displays food related commands.

/Cars

Displays vehicles related commands.

General

/Player-rl

Reloads and validates module configuration from file.

Code

/player-rl

/Ann

Sends server wide announcements. Has several advantages over the default announce: possibility to add the message to Notifications, possibility to leave the message for offline users, to check when they come online, ability to show the PopUp message as either OKBox - requiring user to confirm before it disappears (all actions blocked until OK is clicked), or standard InfoWindow - resizable but prone to disappearance at any click. Both popups accept all formatting options. Sending the message with different tag, for example General instead of Notifications - this was requested by users that have Notifications cleared in chat filters.

/ann string text (required), int size, bool showAsPopUp, bool showAsOKBox, bool leaveIfOffline, bool showInNotifications, string windowHeader, string tag

showAsPopUp - (Default: false) - sets message to be displayed as InfoBox - resizable and scrollable ;

showAsOKBox - (Default: true) - sets message to be displayed as OKBOx - requires click on OK from the user to go away, all actions are blocked;

leaveIfOffline - (Default: true) - stores message if the user is offline at the moment of sending, this message can be found and read through notification interface when user logs back in.

showInNotifications - (Default: true) - adds message to the notifications panel. If leaveIfOffline is set to on and user is offline, this setting is always true.

windowHeader - (Default: "Server Announcement") - sets title of the announcement as well as title of the window, if any of the popups are selected.

tag - (Default: Notifications) - sets the tag of the message. Requested by people who have everything but General filtered off. Accepts either Notifications or General.

Code

/Ann We are wiping the server in two days!

/Ann Free items available at the general stockpile, 32, false, true 

/AnnTest

Sends testing announcement, only to the issuer, to check it graphically.

Code

/AnnTest Here is my test announcement.

/Warn

Sends warning to the target user. Requires only two arguments, rest is assumed automatically. Advantages over the vanilla warning are the same like in case of the announcement: ability to leave this message if user is offline, different popup options, sizing etc.

/Warn User targetUser (required), string text(required), int size, bool showAsPopUp, bool showAsOKBox, bool leaveIfOffline, string windowHeader

showAsPopUp - (Default: false) - sets message to be displayed as InfoBox - resizable and scrollable ;

showAsOKBox - (Default: true) - sets message to be displayed as OKBOx - requires click on OK from the user to go away, all actions are blocked;

leaveIfOffline - (Default: true) - stores message if the user is offline at the moment of sending, this message can be found and read through notification interface when user logs back in.

showInNotifications - (Default: true) - adds message to the notifications panel. If leaveIfOffline is set to on and user is offline, this setting is always true.

windowHeader - (Default: "Server Announcement") - sets title of the announcement as well as title of the window, if any of the popups are selected.

Code

/Warn Boop, Clean up your rubble!

/Warn Boop, Clean up your rubble!, 28, false, true, true, Warning

/online

Shows online players. Has two optional parameters - format and maxPerLine. Format accepts two values: v for vertical list and h for horizontal; maxPerLine is an integer limiting max number of usernames per line.

Command can be triggered with just its name and then it will launch with default values - vertical list.

/on string format, int maxPerLine.

Code

/online
/online h, 6

Skills

/grant-spec

Grants or deducts exact amount of specialty points. Use negative numbers to deduct. It has checks against already invested points and those that are otherwise locked.

/grant-spec User targetPlayer, int amount

Code

/grant-spec targetPlayer, amount

/grant-specAll

Grants exact amount of specialty points to all players.

/grant-specAll int amount

Code

/grant-specAll amount

/spec-report

Lists free and invested speciality points of the target player.

/spec-report User targetPlayer,

Code

/spec-report targetPlayer

/talent-unlearn

Unlearns specified talent. IMPORTANT: As talents follow own naming format, it is recommended to use /talents-list to obtain ID names for this command. If the requested talent is not found, information window will appear by default.

/talent-unlearn User targetPlayer, string talentName

Code

/talent-unlearn targetPlayer, talentName

/talents-list

Lists talents currently known by the target player. Provides naming IDs for the command /talent-unlearn. Provided talents are linked and available for mouse over to ensure proper talent is removed.

/talents-list User targetPlayer

Code

/talents-list targetPlayer

/talents-reset

Resets ALL talents of the target player.

/talents-reset User targetPlayer

Code

/talents-reset targetPlayer

/player-reset

Resets skills, talents, inventory, stats of the target player to the starting state. Effectively making them born anew. Contrary to the game method, this one will also reimburse the player any alpha backer items, they have entitlement for. Targets keep all of their plots and other owned property. Before the reset occurs, confirmation window is provided with all details of the reset. See below for screenshots.

/player-reset User targetPlayer

Code

/player-reset targetPlayer

/player-refundspec

Refunds specialisation points and resets skills, but preserves character's progress: levels and experience points.

After the refund player can pick their skills anew.

/player-refundspec User targetPlayer

Code

/player-refundspec targetPlayer

/job-reset

Resets specified profession to the starting, unlearnt state. Contrary to the game method, it uses own way of searching through skills, making sure the correct skill is targeted. Has optional attribute toUnlearnt which will set targeted skill to unlearnt state if the skill required a skill scroll to learn.

/job-reset User targetPlayer, string skillName, (optional) toUnlearnt = true

Code

/job-reset targetPlayer, skillName, true 

/job-set

Set specified skill to the desired level. This command sets the job level to the one indicated by the issuer. It ensures that server stats are updated properly as well as the user info available in real time. Information on the command effect is sent both to the issuer and to the receiver but not to the whole server.

/job-set User targetPlayer, string skillName, int level

Code

/job-set targetPlayer, skillName, level

/player-LvlSet

Sets player's current level to the selected level.

/player-LvlSet User targetPlayer, int level

Code

/player-LvlSet targetPlayer, level

/player-LvlSync

Calculates a proper level character should be at, basing on invested specialities and earned stars and synchronises current level to it.

/player-LvlSync User targetPlayer

Code

/player-LvlSync targetPlayer

Info

/ip

Gets current IP address of the player. Allow for detailed (default) or simple check. Detailed check offers approximate location (country and city of the Internet Service Provider), simple check returns only IP address.

/ip User targetPlayer, bool simple

Code

/ip targetPlayer, true/false

/ip-list

Displays pop-up windows with a list of currently connected players with their IP Addresses.

/ip-list

Code

/ip-list

/ip-same

Returns list of players who are connected from the same IP Address.

/ip-same

Code

/ip-same

/tooltip-conf

Sets player info tooltip options. (IP Address, Steam ID, SLG ID)

/tooltip-conf bool showIp, bool showSteamId, bool showSLGId

Code

/tooltip-conf true, true, true

/tooltip-grpAdd

Allows members of EM group to see additional player tooltip info (IP Address, Steam ID, SLG ID). EM Group must already exist.

/tooltip-grpAdd string groupName

Code

/tooltip-grpAdd groupName

/tooltip-grpDel

Removes members of EM group from seeing additional player tooltip info. (IP Address, Steam ID, SLG ID)

/tooltip-grpDel string groupName

Code

/tooltip-grpDel groupName

/tooltip-grpLs

Lists EM Groups able to see player tooltip info. (IP Address, Steam ID, SLG ID)

/tooltip-grpLs

Code

/tooltip-grpLs

Food

/food-CheckTaste

Check user's taste in specific food item. Displays user's favorite and worst foods.

If specific food item is specified, comamnd checks the tastiness of this item, if none is given, command displays worst and favorite foods.

/food-CheckTaste User targetPlayer, optional string foodItem

Code

/food-CheckTaste User targetPlayer, string foodItem, string taste

/food-ChangeTaste

Changes player's food tastiness. Values for taste parameter: Horrible, Bad, Ok, Good, Delicious

/food-ChangeTaste User targetPlayer, string foodItem, string taste

Code

/food-ChangeTaste User targetPlayer, string foodItem, string taste

/food-SetFavorite

Sets specified food as favorite.

/food-SetFavorite User targetPlayer, string foodItem

Code

/food-SetFavorite User targetPlayer, string foodItem

/food-SetWorst

Sets specified food as worst.

/food-SetWorstUser targetPlayer, string foodItem

Code

/food-SetWorst User targetPlayer, string foodItem

Cars

/car-List

Lists player's vehicles. The list also contains ready to copy commands helpful in vehicle rescue and teleportation.

Has optional parameter focusCopyOnIssuer if set to true, all the copy commands will contain the issuing user rather than the target.

/car-List User targetUser, bool focusCopyOnIssuer

Code

/car-List userName, true/false

/car-TpToUsr

Rescue user's vehicle. Teleports vehicle with all its content the to target user's position. User must be online.

Vehicle Id needed for this command can be easily obtained by using /car-List on the target user.

/car-TpToUse string vehicleId, User targetUser

Code

/car-List userName, true/false

/car-MyCars

Lists player's own vehicles.

The list also contains ready to copy commands helpful in vehicle rescue and teleportation.

Ids and ready to copy commands are used with /car-rez if enabled on server.

/car-MyCars

Code

/car-MyCars

/car-Rez

Teleports user's vehicle, with all its content - to the user. Subject to cooldown.

Ids and ready to use commands for this one, can be obtained from /car-MyCars.

/car-MyCars string vehicleId

Code

/car-MyCars vehicleId

/car-Cd

Checks target user's timer on self vehicle rescue command.

/car-Cd User targetUser

Code

/car-Cd targetUserName

/car-EnableRez

Enable user vehicle rescue self command (car-Rez).

/car-EnableRez bool true/false

Code

/car-EnableRez true/false

/car-SetCd

Enable user vehicle rescue self command (car-Rez).

/car-SetCd float cooldownInMinutes

Code

/car-SetCd 120

/car-clearCd

Clears car rez cooldown on target user.

/car-clearCd string targetUser

Code

/car-clearCd userName

/car-setLimits

Set car self rez command limitations.

/car-setLimits bool requireEmpty, float maximumDistance, float caloricCost

Code

/car-clearCd true/false, 100, 500

Screenshots: