6.4 KiB
Configuration
This page is an in depth documentation on what each Setting does in the config.
Settings
Basic settings
| Config.Point | Version introduced | Type | Default | Description |
|---|---|---|---|---|
| Debug | 3.0.0 | boolean | false | Enables debug messages on console. |
| Locale | 2.5.0 | String | default | Two letter Locale combination. Can be set to one of the Available locales. If a faulty combination is used, default locale will be used. Available locales |
| UseTextUI | 3.0.0 | boolean | false | Redirects /plan inspect and /plan analyze commands to display same messages as /plan qinspect & /plan qanalyze |
| Data.GatherLocations | 2.2.0 | boolean | true | Enables PlanPlayerMoveEventListener |
Analysis settings
| Config.Point | Version introduced | Type | Default | Description |
|---|---|---|---|---|
| LogProgressOnConsole | 2.4.0 | boolean | false | More detailed analysis progress to console. |
| NotifyWhenFinished | 3.0.0 | boolean | true | Enables "Analysis Complete"-message will be shown on the console after analysis is complete. |
| MinutesPlayedUntilConsidiredActive | 2.0.0 | Integer | 10 | This setting affects how the Analysis treats player's activity. Whether or not a player is active is determined with 3 values: Last Login, Playtime and Login Times. If the player has logged in in the last 2 weeks, has playtime higher than in the config, and has logged in 3 times, the player is considered active. Otherwise the player is counted as inactive. |
Cache settings
| Config.Point | Version introduced | Type | Default | Description |
|---|---|---|---|---|
| Processing.GetLimit | 2.8.0 | Integer | 2000 | Changes the queue size for database get actions. If queue runs out notification is given on console. |
| Processing.SaveLimit | 2.8.0 | Integer | 1000 | Changes the queue size for database save actions. If queue runs out notification is given on console. |
| Processing.ClearLimit | 2.8.0 | Integer | 1000 | Changes the queue size for clearing datacache. If queue runs out notification is given on console. |
| AnalysisCache.RefreshAnalysisCacheOnEnable | 2.?.0 | boolean | true | Enables Analysis refresh 30 seconds after boot/reload |
| AnalysisCache.RefreshEveryXMinutes | 2.4.0 | Integer | -1 | Enables periodic Analysis refresh, -1 to disable |
| DataCache.SaveEveryXMinutes | 2.0.0 | Integer | 2 | Determines how often cache is saved to the Database. |
| DataCache.ClearCacheEveryXSaves | 2.0.0 | Integer | 5 | Determines how often cache clear attempt is made. This is done in case some data is left lingering even after the player has been gone for a long time. |
WebServer settings
| Config.Point | Version introduced | Type | Default | Description |
|---|---|---|---|---|
| Enabled | 2.1.0 | boolean | true | Enables the Webserver |
| Port | 2.0.0 | Integer | 8804 | Port of the Webserver |
| InternalIP | 3.0.0 | String | 0.0.0.0 | Internal InetAddress to start the WebSocketServer on. Code enabling the socket server |
| ShowAlternativeServerIP | 2.0.0 | boolean | false | Enables the use of the link below in the inspect and analyze commands. |
| AlternativeIP | 2.0.0 | String | your.ip.here:%port% | Address to use as link in inspect and analyze commands if setting above is enabled. %port% will be replaced with the Port automatically. If you have port-forwarded an alternate address to the webserver port, %port% is not required. |
| Security.DisplayIPsAndUUIDs | 2.5.0 | boolean | true |
WebServer.Security.DisplayIPsAndUUIDs (2.5.0)
If true, IPs and UUIDs will be visible on the player Inspect page. Otherwise "Hidden" takes their place.
WebServer.Security.AddressSecurityCode (2.5.0)
This string is added to the url so that outsiders can not access the /server and /player/ pages just by knowing your IP and that your server uses Plan. Example: bAkEd -> localhost:8804/bAkEd/server
Customization.Colors.Commands (2.1.0)
These color codes are used with all the /plan commands.
Customization.Colors.HTML (2.1.0)
These HTML Color codes are used when generating the graphs and piecharts. Use without the # (hashtag) Change requires plugin restart
Customization.DemographicsTriggers (2.1.0)
These lists of words are used when detecting the Age & gender of the player from the chatbox. Seperate words with a comma ( , ). Trigger: An attempt to gather info is only made if message contains one of these words. IgnoreWhen: If an attempt is made and message contains one of these words, the info is disregarded.
database.type (2.0.0)
This setting determines what type of database the plugin will use.
sqLite - sqLite database file will be created to the /plugins/Plan/ folder and used as the save location for all data.
MySQL - MySQL settings are used and the data is saved to the MySQL database you have installed.
mysql (2.0.0)
These settings are used to connect to the database when database.type is set to 'mysql'. In order to use MySQL the table in the mysql.database has to be created separately
mysql.host
IP of the MySQL database.
mysql.port
Port of the MySQL database
mysql.user
MySQL User
mysql.password
User's password
mysql.database (2.0.0)
Name of the database that has already been created. Please note, that you have to create this database in your mysql solution (eg. MariaDB)!
End
If you don't see explanation for a config point or need help setting up the plugin, don't hesitate to ask for help! :)