Duplicate from readme
parent
88fa5da4a5
commit
dbfdd1270e
51
Plugins.md
51
Plugins.md
@ -8,3 +8,54 @@ The following options can be configured by modifying `ActionOnReport.js`
|
|||||||
| reportAction | Type of action to perform when threshold is reached | Ban\|TempBan |
|
| reportAction | Type of action to perform when threshold is reached | Ban\|TempBan |
|
||||||
| maxReportCount | How many reports can occur before action is taken | >0 |
|
| maxReportCount | How many reports can occur before action is taken | >0 |
|
||||||
| tempBanDurationMinutes | How long to temporarily ban the client | >0 |
|
| tempBanDurationMinutes | How long to temporarily ban the client | >0 |
|
||||||
|
|
||||||
|
|
||||||
|
#### Welcome
|
||||||
|
- This plugin uses geo-location data to welcome a player based on their country of origin
|
||||||
|
- All privileged users ( Trusted or higher ) receive a specialized welcome message as well
|
||||||
|
- Welcome messages can be customized in `WelcomePluginSettings.json`
|
||||||
|
|
||||||
|
#### Stats
|
||||||
|
- This plugin calculates basic player performance, skill approximation, and kill/death ratio
|
||||||
|
- Skill is an number derived from an algorithmic processing of a player's Kill Death Ratio (KDR) and Score per Minute (SPM).
|
||||||
|
- Elo Rating is based off of the number of encounters a player wins.
|
||||||
|
- Performance is the average of Skill + Elo Rating
|
||||||
|
|
||||||
|
**Commands added by this plugin**
|
||||||
|
|
||||||
|
|Name |Alias|Description |Requires Target|Syntax |Required Level|
|
||||||
|
|--------------| -----| --------------------------------------------------------| -----------------| -------------| ----------------|
|
||||||
|
|resetstats|rs|reset your stats to factory-new|False|!rs |User|
|
||||||
|
|stats|xlrstats|view your stats|False|!xlrstats \<optional player\>|User|
|
||||||
|
|topstats|ts|view the top 5 players on this server|False|!ts |User|
|
||||||
|
|mostplayed|mp|view the top 5 dedicated players on the server|False|!mp |User|
|
||||||
|
|
||||||
|
- To qualify for top stats, a client must have played for at least `3 hours` and connected within the past `15 days`.
|
||||||
|
|
||||||
|
#### Login
|
||||||
|
- This plugin deters GUID spoofing by requiring privileged users to login with their password before executing commands
|
||||||
|
- A password must be set using the `setpassword` command before logging in
|
||||||
|
|
||||||
|
**Commands added by this plugin**
|
||||||
|
|
||||||
|
|Name |Alias|Description |Requires Target|Syntax |Required Level|
|
||||||
|
|--------------| -----| --------------------------------------------------------| -----------------| -------------| ----------------|
|
||||||
|
|login|l|login using password|False|!l \<password\>|Trusted|
|
||||||
|
|
||||||
|
#### Profanity Determent
|
||||||
|
- This plugin warns and kicks players for using profanity
|
||||||
|
- Profane words and warning message can be specified in `ProfanityDetermentSettings.json`
|
||||||
|
- If a client's name contains a word listed in the settings, they will immediately be kicked
|
||||||
|
|
||||||
|
#### IW4 Script Commands
|
||||||
|
- This plugin provides additional integration to IW4x
|
||||||
|
- In order to take advantage of it, copy the `userraw` folder into your IW4x server directory
|
||||||
|
|
||||||
|
#### VPN Detection [Script Plugin]
|
||||||
|
- This plugin detects if a client is using a VPN and kicks them if they are
|
||||||
|
- To disable this plugin, delete `Plugins\VPNDetection.js`
|
||||||
|
- Adding **Client IDs** to the `vpnExceptionIds` array will prevent a client from being kicked.
|
||||||
|
|
||||||
|
#### Shared GUID Kicker [Script Plugin]
|
||||||
|
- This plugin kicks users using a specific GUID
|
||||||
|
- GUID `F4D2C30B712AC6E3` on IW4x was packed into a torrent version of the game.
|
Loading…
x
Reference in New Issue
Block a user