Difference between revisions of "XChat"

From SupaHam
Jump to: navigation, search
(initial creation.)
 
(Added configuration section with config.yml.)
Line 1: Line 1:
 
XChat is a 1337 plugin for cross server communication, backend and front end.
 
XChat is a 1337 plugin for cross server communication, backend and front end.
 +
==config.yml==
 +
{{tip|text=Before starting to mess around with a configuration file, please head over [[Configurations|here]] and familiarise yourself.}}
 +
 +
=== config.yml ===
 +
{| class="wiki-table"
 +
! Configuration
 +
! width="100"| Value
 +
! Description
 +
|-
 +
| server-id || [[Configurations#String|String]] || This is used to identify the server in various ways. <br />If this is null (or unset) XChat will fallback to server.properties' server-name. <br />If the server-name in ''server_properties'' is null, this server-id will be set to 'XChat'. <br />If a server-id already actively exists, the id is appended with an integer that keeps incrementing until the server-id becomes unique.
 +
|-
 +
| databases || [[Configurations#Section|Section]] || This configuration section contains a list of databases that the instance of XChat should connect to and retrieve information from. <br />Only '''MySQL''' and '''Redis''' are supported.
 +
|-
 +
| databases.mysql || [[Configurations#Section|Section]] || This configuration section contains the MySQL connection info.
 +
|-
 +
| databases.mysql.ip || [[Configurations#String|String]] || This is the ip address of the MySQL database to connect to.
 +
|-
 +
| databases.mysql.port || [[Configurations#Integer|Integer]] || This is the port of the MySQL database to connect to.
 +
|-
 +
| databases.mysql.user || [[Configurations#String|String]] || This is the username to use when connecting to the MySQL database.
 +
|-
 +
| databases.mysql.password || [[Configurations#String|String]] || This is the password to use when connecting to the MySQL database.
 +
|-
 +
| databases.redis || [[Configurations#Section|Section]] || This configuration section contains the Redis connection info.
 +
|-
 +
| databases.redis.ip || [[Configurations#String|String]] || This is the ip address of the Redis database to connect to.
 +
|-
 +
| databases.redis.port || [[Configurations#Integer|Integer]] || This is the port of the Redis database to connect to.
 +
|}

Revision as of 00:07, 16 January 2015

XChat is a 1337 plugin for cross server communication, backend and front end.

config.yml

Tip: Before starting to mess around with a configuration file, please head over here and familiarise yourself.

config.yml

Configuration Value Description
server-id String This is used to identify the server in various ways.
If this is null (or unset) XChat will fallback to server.properties' server-name.
If the server-name in server_properties is null, this server-id will be set to 'XChat'.
If a server-id already actively exists, the id is appended with an integer that keeps incrementing until the server-id becomes unique.
databases Section This configuration section contains a list of databases that the instance of XChat should connect to and retrieve information from.
Only MySQL and Redis are supported.
databases.mysql Section This configuration section contains the MySQL connection info.
databases.mysql.ip String This is the ip address of the MySQL database to connect to.
databases.mysql.port Integer This is the port of the MySQL database to connect to.
databases.mysql.user String This is the username to use when connecting to the MySQL database.
databases.mysql.password String This is the password to use when connecting to the MySQL database.
databases.redis Section This configuration section contains the Redis connection info.
databases.redis.ip String This is the ip address of the Redis database to connect to.
databases.redis.port Integer This is the port of the Redis database to connect to.