summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2015-09-06 18:08:14 +0200
committerHaru <haru@dotalux.com>2016-08-19 21:32:12 +0200
commitc84a4473cc0491edbf6ac3e7efd062d8c57e5a2c (patch)
tree335a146bf8eecd6cc1bacb4388efa1e64cd3e91e /doc
parent6be7aab17d958e0f5a4be0413b26c7dd81185af6 (diff)
downloadhercules-c84a4473cc0491edbf6ac3e7efd062d8c57e5a2c.tar.gz
hercules-c84a4473cc0491edbf6ac3e7efd062d8c57e5a2c.tar.bz2
hercules-c84a4473cc0491edbf6ac3e7efd062d8c57e5a2c.tar.xz
hercules-c84a4473cc0491edbf6ac3e7efd062d8c57e5a2c.zip
Ported char-server.conf to libconfig
Fixed issue: 8115, now start items can be equipped as well Ported to modern Hercules and cleaned up from Panikon's commits: c6482e9870645ffe59a6a059b819574d4ac79fd9, 832fb27d4f767e4bc8b68c432d0da00b7cb7a4f9, f81b579899e3a15bd472ca8c6a6e0116c43bec92, e23723725499b617def03d05661eca637edaeabd, 0b783a83d82e588efd760f7f4baec0c8074a6fd1, 1b7de91308a57ea07b158ed95a2515a3c8cc36bd, 677d3430cbda0962b320a60cf499e9dadf637d00 Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/global_configuration.txt69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/global_configuration.txt b/doc/global_configuration.txt
new file mode 100644
index 000000000..23be19031
--- /dev/null
+++ b/doc/global_configuration.txt
@@ -0,0 +1,69 @@
+//===== Hercules Documentation ===============================
+//= Global configuration reference
+//===== By: ==================================================
+//= Panikon (Hercules Dev. Team)
+//===== Current Version: =====================================
+//= 20140616
+//===== Description: =========================================
+//= Global configurations found in /conf/global/
+//============================================================
+
+- What are global configurations?
+
+Global configurations are configurations that can be shared between servers,
+but can also be set independently in each server.
+
+- How do they work?
+
+They work by using an include system that is available with libconfig:
+
+ "A configuration file may "include" the contents of another file using an
+ include directive. This directive has the effect of inlining the contents of
+ the named file at the point of inclusion.
+
+ An include directive must appear on its own line in the input. It has the
+ form:
+
+ @include "filename"
+
+ Any backslashes or double quotes in the filename must be escaped as '\\' and
+ '\"', respectively."
+ From libconfig's documentation
+
+So each file that is included is actually inside each one of the main
+configuration files and thus a change in the first will be a change in the
+latter.
+Note: the @include directive is read by the server executable, so any path
+should be from were it is and NOT from where the main configuration file is!
+
+- How do I stop using global configurations?
+
+To stop using global configurations is very simple, all you have to do is copy
+the contents that are inside the global configuration file and put them
+_exactly_ where the include directive were in the main configuration file.
+
+E.g.
+ Find in any file:
+ @include "conf/global/sql_connection.conf"
+ Replace it with:
+ sql_connection: {
+ // [INTER] You can specify the codepage to use in your mySQL tables here.
+ // (Note that this feature requires MySQL 4.1+)
+ //default_codepage: ""
+
+ // [LOGIN] Is `userid` in account_db case sensitive?
+ //case_sensitive: false
+
+ // For IPs, ideally under linux, you want to use localhost instead of 127.0.0.1
+ // Under windows, you want to use 127.0.0.1. If you see a message like
+ // "Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)"
+ // and you have localhost, switch it to 127.0.0.1
+ db_hostname: "127.0.0.1"
+ db_port: 3306
+ db_username: "ragnarok"
+ db_password: "ragnarok"
+ db_database: "ragnarok"
+ //codepage:""
+ }
+ If the main configuration file belongs to the map server, for instance, you
+ don't need to include default_codepage and case_sensitive.