Difference between revisions of "LoginServer.ini"

m (updates per alfa)
 
Line 1: Line 1:
== LoginServer.ini ==
+
{{PageHeaderChild|Admins:Server_Setup_Guide|LoginServer.ini}}
 +
The LoginServer.ini file contains valuable information that is used by the world server to communicate with the Login server. All the basic fields in the file should be completed respectively to allow stability and compatibility with every client.
  
  
==What is it?==
+
{{Header|Syntax|BackgroundColor=3d78b4|FontColor=ffffff}}
 
 
The LoginServer.ini file contains valuable information that is used by the world server to communicate with the Login server. All the basic fields in the file should be completed respectively to allow stability and compatibility with every client.
 
 
 
=== Syntax ===
 
 
All comments are prefixed with the # character. For example
 
All comments are prefixed with the # character. For example
 
  #READ Readme.txt
 
  #READ Readme.txt
Line 20: Line 17:
 
Okay, let's understand what all these variables mean!
 
Okay, let's understand what all these variables mean!
  
== Understanding the variables ==
 
  
 +
{{Header|Understanding the variables|BackgroundColor=3d78b4|FontColor=ffffff}}
 
  [LoginServer] -  
 
  [LoginServer] -  
 
The login server category as mentioned above
 
The login server category as mentioned above
Line 65: Line 62:
 
The port with which to connect to the login server with.
 
The port with which to connect to the login server with.
  
== Allowed Values ==
+
 
 +
{{Header|Allowed Values|BackgroundColor=3d78b4|FontColor=ffffff}}
 
  loginserver = ANY IP ADDRESS OR DNS NAME
 
  loginserver = ANY IP ADDRESS OR DNS NAME
 
  loginport = ANY numerical port 0-65000
 
  loginport = ANY numerical port 0-65000
Line 85: Line 83:
 
  ServerPort = ANY numerical port 0-65000
 
  ServerPort = ANY numerical port 0-65000
  
==The DEFAULT LoginServer.ini file==
 
  
 +
{{Header|The DEFAULT LoginServer.ini file|BackgroundColor=3d78b4|FontColor=ffffff}}
 
In case you do not have this file and/or need the default values...
 
In case you do not have this file and/or need the default values...
  

Latest revision as of 16:15, 1 August 2015

Admins:Server_Setup_Guide - LoginServer.ini

Return to: Admins:Server_Setup_Guide | Tutorials | Portal | Forum | Project Manager | Bug Tracker

The LoginServer.ini file contains valuable information that is used by the world server to communicate with the Login server. All the basic fields in the file should be completed respectively to allow stability and compatibility with every client.


Syntax

All comments are prefixed with the # character. For example

#READ Readme.txt

is a comment and would be totally disregarded by the world server, only visible to those actually viewing the file in Unicode format.

Everything between [ ] are considered to be sections within the file. These sections are usually predefined and cannot be altered to allow any other kind of functionality. For example

[LoginServer]

is the section used to hold the data that has to do with the login server (IP, Port, World Name, etc...)

The basic way of editing this file is by replacing all the values after the = (equals) character. The structure is like this:

variable_name = variable_value

Okay, let's understand what all these variables mean!


Understanding the variables
[LoginServer] - 

The login server category as mentioned above

loginserver - 

The DNS address or IP address of the login server. This is used to tell the world server what login server to connect to.

worldname - 

The name of the world server, that is to be shown after the character creation screen (Not yet fully implemented)

worldaddress - 

The external IP address of the world server you are hosting (www.whatismyip.com)

internalworldaddress - 

The internal IP address of the world server you are hosting, mainly used for LAN functionality (192.168.x.x)

worldport - 

The port that the world server is going to be listening on. Make sure this port is properly forwarded on your firewall or router (www.portforward.com)

locked - 

Used to decide whether the world server is locked to normal clients. When it is locked, maintenance is usually performed on the server. (Only admins are allowed entry)

account - 

The account used to connect to the login server with your world server. (Register an account at http://eq2emulator.net/accountregistration.php , the second choice for WORLD servers)

password - 

The password you registered above with

autotableupdates - 

Determines whether to retrieve the latest updates and update your tables in your database

autoupdateverbose - 

Determines whether to show a lot of debug information while updating the MySQL tables

autotabledata - 

Determines whether to get the latest table updates such as the OP_Code tables (Very important)

[WorldServer] - 

The world server category used to understand all data the world server uses

DefaultStatus -

The default status of the zones

Unavailzone - 

The zone to show when the world server is unavailable

[UpdateServer] -

The category used to direct all the server/table updates

updateserveraddress - 

The IP address or DNS name of the update server

updateserverport

The port the update server listens on (must be 9103)

[LoginConfig] -

The category used to understand all the login configuration data

ServerMode -

The mode the server works with. It is usually StandAlone as a login server will always be provided for you

ServerPort -

The port with which to connect to the login server with.


Allowed Values
loginserver = ANY IP ADDRESS OR DNS NAME
loginport = ANY numerical port 0-65000
worldname = ANY ASCII-Unicode compatible  name
worldaddress = ANY IP-compatible address (xxx.xxx.xxx.xxx)
internalworldaddress = ANY Internal IP-compatible address (192.168.xxx.xxx)
worldport = ANY numerical port 0-65000
locked = true or false
account = ANY characters
password = ANY characters
autotableupdates = always, ask or never
autotableverbose = true or false
autotabledata = true or false
DefaultStatus = ?
Unavailzone = ANY zone name from your SQL zones table
updateserveraddress = updates.eq2emulator.net
updateserverport = 9103
ServerMode = StandAlone or MiniLogin (Not yet Implemented)
ServerPort = ANY numerical port 0-65000


The DEFAULT LoginServer.ini file

In case you do not have this file and/or need the default values...

### --- This file tells world.exe what loginserver to connect to.
### --- Leave the account and password field BLANK.
 
### --- NOTE: the word "Server" is added to each server automaticly.

# READ README.TXT

[LoginServer]
loginserver=eq2emulator.net
loginport=9100
worldname=WORLD_NAME_HERE
worldaddress=EXTERNAL_IP_HERE
#internalworldaddress=INTERNAL_IP_HERE (If used, otherwise blank)
worldport=9000
locked=false
account=
password=
#autotableupdates retrieves the latest table updates and applies them to your database
#autotableupdates valid options=always, ask, and never
autotableupdates=always
#autotableverbose displays detailed information about the updates; options=true or false
autotableverbose=false
#autotabledata retrieves the latest data for tables like the opcodes table; options=true or false
autotabledata=true 
 
[WorldServer]
Defaultstatus=
Unavailzone= 

[UpdateServer]
updateserveraddress=updates.eq2emulator.net
updateserverport=9103

[LoginConfig]
ServerMode=StandAlone
ServerPort=9100