Usage Configuration Guide

Proxy Config--

The default proxy config, the proxy.yml, is shown below. At first glance this can look a little overwhelming, but it is actually extremely easy. You can have your network up and running in no time!

Code (text):

connect:
  address: 127.0.0.1:5091
  credentials:
    username: example
    password: example
proxy:
  bind: :25565
  routes:
  - domain: ""
    server: example
  - domain: example.com
    servers:
    - hub1
    - hub2
    motd: Example Custom MOTD
  - domain: hub.example.com
    server: hub
    motds:
    - Example MOTD 1
    - Example MOTD 2
  - domain: icon.example.com
    server: hub
    icon: icon.png
    icons:
    - icon1.png
    - icon2.png
    - icons/icon3.png
  locale:
    full: The server seems to be currently full. Try again later!
    offline: The requested server is currently offline. Try again later!
    loggedIn: You seem to be logged in already. Try again later!
    lostConn: Lost connection... Please try to reconnect
    shutdown: The server is being restarted. Please try to reconnect
  motd: A LilyPad Server
  maxPlayers: 1
  authenticate: true
 

The first section of config we are going to look at is the first five lines, the information of the Connect Server. In these lines you will state the IP of the connect server, and the username and password that you specified in the connect's config. Below you can see the lines and a description of each line.

Code (text):

connect:                         <- Informing you that the next line is where you will put connect information
  address: 127.0.0.1:5091        <- The address of the connect server, the default port of this is 5091
  credentials:                   <- Informing you that the next line is where you will put the credentials of the connect
    username: example            <- The username that you specified in the connect.yml
    password: example            <- The password you specified in the connect.yml

The next section of the config are lines 9-22, the proxy's information. In these lines the config is showing you the four possible ways you can having your server set up through domain pointing, or just general log in information. The lines are shown below.

Code (text):

  - domain: ""
    server: example
  - domain: example.com
    servers:
    - hub1
    - hub2
    motd: Example Custom MOTD
  - domain: hub.example.com
    server: hub
    motds:
    - Example MOTD 1
    - Example MOTD 2
  - domain: icon.example.com
    server: hub

The first two lines of this section are a generic way to have your setup, you would use this if you wanted to connect to your server through the IP, or just want your server to have one domain/sub-domain going to the server. An example of this, and the first two lines of the selected portion, are below.

Code (text):

  - domain: ""
    server: example

Going more in depth, we are going to look at all the possibilities that you can have your server setup. First looking at the domain. All the possible ways you can have your domain are listed below, and followed by an explanation.

Code (text):

  - domain: ""                      <- Would send anyone using the default IP to the server specified later.
  - domain: example.com             <- Point your domain to your server, and anyone connecting using the domain will be sent to the server specified later.
  - domain: hub.example.com         <- Point your sub domain to your server, and anyone connecting using the sub domain will be sent to the server specified later.
 

Remember, if you only want your domains/sub domains going into one server, you don't have to deal with the domain settings int the config, just point them all to the IP and use the first two lines of the section.

Next we are going to look at the next lines after the domain, the server you want your players to join when connecting. There is two possible ways you can have this, going to one server, or going to multiple servers. And example of both is bellow:

Code (text):

  - domain:
    servers:
    - hub1
    - hub2

  - domain:
    servers: hub

The next thing we are going to look at is the MOTD. Once again, similar to the servers specified, there are two different possible ways you can do this. One MOTD, or multiple MOTD. Both possible ways are specified below:

Code (text):

  - domain:
    server:
    motds:
    - Example MOTD 1
    - Example MOTD 2

  - domain:
    server:
    motd: Example MOTD

Remember, if you want to use color codes, use the & symbol!

Next up we are going to take a look at the icon. Similar to both the MOTD and the server specified, there is only two ways you can have the server icon set up. One server icon, or multiple server icons. And example of both can be found below:

Code (text):

  - domain:
    server:
    icon: icon.png

  - domain:
    server:
    icons:
    - icon1.png
    - icon2.png
    - icons/icon3.png

Next to look at the sample feature. You can read more about the Sample Feature and what it does here, http://www.lilypadmc.org/threads/the-new-sample-feature.486/ . Just set the file name of your sample in the config similar to below, if you do not want to use this feature, just delete the line.

Code (text):

  - domain: hub.exmaple.com
    server: hub
    motds:
    - Example MOTD 1
    - Example MOTD 2
    sample: hubSample.txt

Remember! When doing this sections the possibilities are endless for custom configuration! You can have different subdomains direct players to different servers, each having their own icon and motd!

The next section of the proxy config are the locale(parameters or messages) and general input, the messages are self explanatory, and more information about the general input can be found below:

Code (text):

  motd: A LilyPad Server    <- MOTD of the server.
  maxPlayers: 1             <- Maximum players the proxy can handle.
  authenticate: true        <- Would you lake to authenticate with the Mojang servers?

Connect Config--

The connect config file, the connect.yml is shown below:

Code (text):

bind: :5091
logins:
- username: example
  password: example
- regexp: ^example-.*$
  password: example

In this config you will specify all of your bukkit servers. And, a quick note, if you are not familiar with regexp and how to use it, don't use it. Change it regexp to username.

The first line of the config is what port you want to run your server on, the default port is 5091.

The next two lines of the config are the username and password for your proxy, which needs to be identical to the credentials in your proxy's config.

Following the first user name and password are the user name and password to all of your bukkit servers, you can find more about the bukkit-conect config in the following section. The username and password need to be identical in both.

An example of a connect config with explanations can be seen below:

Code (text):

bind: :5091     <- Port for the server to run on
logins:
- username: Proxy      <- Username for the Proxy Server
  password: ProxyPassword     <- Password for the Proxy Server
- username: Hub     <- Username for one of the servers
  password: HubPassword     <- Password for one of the servers
- username: Server1     < - Username for one of the servers
  password: Server1Password     <- Password for one of the servers

Bukkit-Connect Config--

The Bukkit-Connect config is from the bukkit-connect plugin that you place in your plugins folder of your bukkit server. It is shown below:

Code (text):

settings:
  address: 127.0.0.1
  port: 5091
  credentials:
    username: example
    password: example

This config is as simple as just giving information that we have already imputed before, the explanation of each line is below:

Code (text):

settings:
  address: 127.0.0.1     <- IP of your Connect server
  port: 5091        <- Port of your Connect Server
  credentials:
    username: server <- Username for the individual server
    password: serverpassword <- Password for the individual server

Nice!
Will certainly be helpful for people who're unfamiliar with how LilyPad works!

Don't forget that you can use IPv6 addresses if you wrap them in square brackets