NidToolbox: IP Logger module 1.7.3

Contains IP logger module for NidToolbox Light server tool-set. It allows for real time motoring and logging of all login and logout events. Highly customisable.

IP Logger 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.

Provides ability to log Login and Logout events of your citizens, registering IP Address, time, date, steam ID, slg ID and more.

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

IP Logger module allows:

• Registers each event of login, logout (or both) of each citizen connecting to your server.
• Server owners may decide which events they want to monitor and where if at all to store the data.
• Allows for global IP history file, per user ones, or both.
• Enabling of the features can be done via in-game commands or through editing of the settings file.
  
• Target of the log can be set to server console, server log, NidToolbox log - none, some or all of these in any combination that suits the server owner.
• Ability to create a comma-delimited .csv file for administrators who like to export their server data to external tools for analytics.
• Can notify about players using same IP address.
• Possible to whitelist user or specific IP Address.
  
• Whitelist for players who are allowed to play from the same IP Address (won't trigger the notification for them).

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-iplogger.dll to Mods\NidToolbox\Modules

Settings files:

Config files are located at Configs\Mods\NidToolbox\IPLogger.json

{
  "Info1": "NidToolbox Light: IP Logger settings.",
  "IPLoggerEnabled": true,
  "LogLogouts": true,
  "PerUserLogFiles": true,
  "GlobalLogFiles": true,
  "ReportInConsole": true,
  "ReportInGameLog": true,
  "MakeCSVFile": false,
  "NotifySameIPs": false,
  "AllowedIPAddresses": [],
  "AllowedSameIPs": []
}

Output files:

Output files (logs) are stored at Configs\Mods\NidToolbox\Logs\IPLogger\

Global IP Log file: 0-Global.log and 0-Global.csv

Per user log file name has a form of userName_ServerID.log i.e nidaren_SrvID-1.log and is per user.

Same IP Notifications:

When enabled online Admins will get a notification to their mailbox, when there are two players with same IP address.

Example output:

Date          Hour        Event     IP Address      SteamID               slg ID        Server ID     Character Name
28.09.2020    11:12:50    Login     123.456.7.8     11222222211111110     slg123455     1             nidaren       28.09.2020    11:14:56    Logout    disconnecting   11222222211111110     slg123455     1             nidaren       

Available commands:

/help IPLog

Displays information about all commands contained within this module.

/iplog-enable

Sets the whole module to enabled or disabled state

/iplog-enable bool trueFalse

/iplog-enable true/false

/iplog-sameip

Enables or disables the notifications about users connecting from same IP Address. Disabled by default.

/iplog-sameip bool trueFalse

/iplog-sameip true/false

/iplog-logouts

Sets the module to also register citizen's logouts. Set to true by default.

/iplog-logouts bool trueFalse

/iplog-logouts true/false

/iplog-console

Sets the module to write to server console.

/iplog-console bool trueFalse

/iplog-console true/false

/iplog-global

Sets creation of a gloal IP log history file.

/iplog-global bool trueFalse

/iplog-global true/false

/iplog-perUser

Sets creation of a per user IP log history files.

/iplog-per user bool trueFalse

/iplog-peruser true/false

/iplog-reload

Reload module configuration from the config files.

/iplog-reload

/iplog-reload

/iplog-serverlog

Sets the module to write to server log - located at Server\Logs\ (default eco log).

/iplog-serverlog bool trueFalse

/iplog-serverlog true/false

/iplog-csv

Enables or disables the comma delimited file with all the login and logout data, with user information. Disabled by default.

/iplog-csv bool trueFalse

/iplog-csv true/false

/iplog-AllowSameIpUser

Adds player to the same IP whitelist.

/iplog-AllowSameIpUser User targetUser

/iplog-AllowSameIpUser userName

/iplog-RemoveSameIpUser

Removes player from the same IP whitelist.

/iplog-RemoveSameIpUser User targetUser

/iplog-RemoveSameIpUser userName

/iplog-AllowSameAddress

Adds IP Address to the same IP whitelist.

/iplog-AllowSameAddress string ipAddress

/iplog-AllowSameAddress ipAddress

/iplog-RemoveSameAddress

Removes IP Address from the same IP whitelist.

/iplog-RemoveSameAddress string ipAddress

/iplog-RemoveSameAddress ipAddress

/iplog-SameAddressList

Lists all players on the same IP whitelist.

/iplog-SameAddressList

/iplog-SameAddressList

/iplog-SameIpWhitelist

Lists all players on the same IP whitelist.

/iplog-SameIpWhitelist

/iplog-SameIpWhitelist