trunk/dist/doc/L2J_Server_README.txt

@@ -0,0 +1,297 @@
+NOTE: This short guide is for a L2J Server. http://l2jserver.com
+
+If you received this file as a part of a packaged or bundled build:
+ 
+L2J only supports L2J software obtained directly from L2J sources.
+
+What this means is, if you obtained L2J from a source other than our SVN or nightly distribution,
+you need to get support from where you got the files.
+We are unable to provide any technical assistance for unsupported software packages. 
+The software may have viruses, cause security problems, 
+or even send your personal information to remote servers without your express consent. 
+We cannot recommend the use of any of these packages on a server.
+
+WARNING: L2J Server is not a plug and play type of server. 
+To setup the server and to run it successfully you need to do a lot of reading.
+If reading and learning are not something you like to do,
+Stop now.
+
+====================
+L2J Server 
+====================
+
+TOC:
+I.    OVERVIEW
+II.   LEGAL 
+III.  REQUIREMENTS
+IV.   FIRST STARTUP
+V.    ADMIN/GM's GUIDE
+VI.   PLAYER's GUIDE
+VII.  UPDATING
+VIII. TROUBLESHOOTING
+IX.   CONTACT
+X.    CONTRIBUTING
+XI.   BUG REPORTING
+XII.  CREDITS
+
+  
+
+====================
+I. OVERVIEW
+====================
+
+L2J is an Alternative Lineage 2 Game Server written in pure Java for
+best compatibility. L2J gives you the possibility to legally host a game
+server for this popular Korean MMO created by NCSoft. It is still
+unfinished and many features are missing, but L2J Dev team is working
+hard on implementing them. L2J Server is distributed under the terms
+of GNU/GPL in a hope that open source model is the best for
+developing quality software giving everyone a possibility to
+participate on development by submitting the code.
+
+
+====================
+II. LEGAL
+====================
+
+Copyright (C) 2004-2014 L2J Server
+
+This file is part of L2J Server.
+
+L2J Server is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+L2J Server is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Full GNU/GPL License is included in L2J_Server_LICENSE.txt file.
+
+Whereas L2J is distributed under the terms of GNU/GPL, we require you to:
+a) Preserve login notice. This gives us, L2J Developers, appropriate
+credit for our hard work done during our free time without any
+revenues.
+ 
+b) Do not distribute any extended data files with the server files in
+the same archive. NO world content should be incorporated in L2J
+distribution.
+Server and Datapack may not be not be bundled or packaged.
+
+====================
+III. REQUIREMENTS
+====================
+
+OS:
+Any OS having Java JDK 1.7 installed and properly configured!
+    We recommend using SUN JDK available at java.sun.com
+
+Hardware: 
+Decent CPU & RAM
+
+Software:
+Java JDK 1.7
+MySql
+Datapack
+
+We recommend:
+That you do not play and host the server from the same computer. 
+Have a good Internet connection - dial up just won't cut it.
+Many low cost hosting options are available.
+
+====================
+IV. FIRST STARTUP
+====================
+
+Before you can start up the server it is extremely important to read 
+and get to know the wiki sites.
+They contain all the info you need to setup and run a L2J Server.
+
+L2J Server wiki: Server Guides, How-to's, bugtracker:
+https://www.l2jserver.com/trac/wiki
+
+L2J-Datapack wiki: Datapack Guides, How-to's, bugtracker:
+http://www.l2jdp.com/trac/wiki
+
+This Server distribution does not contain any spawn/drop data or any world
+content. (Datapack)
+
+L2J Server has also a possibility to change exp/sp/drop rates relative
+to data in spawnlist/droplist files. To do that, just change the rates 
+you need in server.properties file found in config folder.
+
+You should also configure your IP address in server.properties. 
+
+Server uses ports 2106 (LoginServer) and 7777 (GameServer) by
+default. If your server runs behind NAT or firewall you will need to
+open and/or forward these ports. 
+
+
+====================
+V. ADMIN/GM's GUIDE
+====================
+
+To make someone an admin you need to edit the l2j database.
+
+For accounts take a look into the 'accounts' table(loginserver database).
+Change the value of the 'accessLevel' column to one of the following:
+- < 0: banned account
+- 0: user account
+- > 0: admin/gm account (bypass max player limit)
+
+For characters take a look into the 'characters' table(gameserver database).
+Change the value of the 'accessLevel' column to one of the access levels
+described in the 'game/config/accessLevels.xml' table.
+
+To adjust the allowed admin commands for an access level take a look into
+'game/config/adminCommands.xml'.  
+ 
+More info can be found in the community wiki.
+ 
+Admin commands implemented:
+(Please see https://l2jserver.com/trac/wiki/GmCommands for more complete list.)
+//admin = main GM interface
+//gmchat = will send a message to all online GMs
+//invul = makes your character untouchable
+
+====================
+VI. PLAYER's GUIDE
+====================
+
+CLIENT COMPATIBILITY
+Our server is dependent on the official release of the North American lineage2 live client.
+http://www.lineage2.com
+All help and support will only be for the official client. 
+Any clients obtained elsewhere, must obtain support from where it was obtained.
+
+====================
+VI. UPDATING
+====================
+It may arrive that you want to update your server to new version while
+keeping old accounts. There are few steps you HAVE TO do in order to
+keep the data accurate.
+
+- You should ALWAYS look at timelines before updating, sometimes a file
+  format may change, so you will need to edit data manually to fit with
+  new format.
+- You should ALWAYS Backup all MySql data.
+- You should ALWAYS Backup all Server and Datapack files.
+- back up all .properties files (don't forget to check if new server use same 
+  format for those files)
+- download & unzip new server code to the Server directory
+- download & unzip new datapack code to the Server directory
+- edit and run update in the tools folder
+- run newly installed server & enjoy ;)
+
+
+====================
+VIII. TROUBLESHOOTING
+====================
+
+PROBLEM
+- Client outputs bunch of messages about missing templates.
+SOLUTION
+- Check that the datapack has been properly installed.
+
+PROBLEM
+- Message similar to "java is not recognized as internal command",
+"java not found" or "unknown command: java" appears.
+SOLUTION
+- Install java, or, if java is already installed just add your java
+binary directory to system PATH setting. If you don't know how to do
+that, than DO NOT bother running your own server please.
+
+PROBLEM
+- I can log in but ping is 9999s and I can't get past Server Select.
+SOLUTION
+- Set up your IP's properly, forward/open good ports if accessing from
+outside. (or find server with admin that knows how to do it)
+
+PROBLEM
+- Skills/quests/whatever don't work.
+SOLUTION
+- Patience brings it's fruits :p
+
+PROBLEM
+- I found a bug.
+SOLUTION
+- Please refer to BUG REPORTING section of this read-me.
+
+Further help available at the wiki sites and the forums.
+
+
+====================
+IX. CONTACT
+====================
+
+Website: http://www.l2jserver.com
+Forum: http://www.l2jserver.com/forum
+IRC: #l2j @ Freenode (irc.freenode.net)
+
+Please note that L2J Devs can't help players with connecting issues or
+anything related to playing on private servers. If you can't connect,
+you should contact your server GM's. We can solve only L2J server
+~software~ related issues. We don't have any backdoors or anything
+that would enable us GM accounts on every server using L2J, so there's
+no point in coming to our channel if you need items/adena/whatever
+ingame.
+
+
+====================
+X. CONTRIBUTING
+====================
+
+Anyone who wants to contribute to the project is encouraged to do so. Java
+programming skills are not always required as L2J needs much more than
+java code.
+
+If you created any source code that may be helpful please use the User Contributions
+section on our forums. If you contributed good stuff that will be
+accepted, you might be invited to join L2J Dev Team.
+
+People willing to hang on chat and respond to user questions are also
+ALWAYS welcome ;)
+
+
+====================
+XI. BUG REPORTING
+====================
+
+Bugs can be reported on our wiki site.
+http://l2jserver.com/trac/newticket
+Basic rules for reporting are:
+    Please report only one bug/issue per ticket!!
+    You must include the revision (changeset) number when reporting a bug!
+    "The latest" does not mean anything when 5 more updates have been done since you set up the server.
+If you are not sure if it should be reported here, make a post about it in the L2J forum.
+
+Players should ALWAYS consult bugs with their Admin/GM's and have them report it
+on our wiki site. Some bugs may be caused by bad datapack, server
+installation or modifications server owner has made. We can't help you
+in that case.
+
+Please use the datapacks bugtracker for reporting datapack bugs.
+Please do NOT report bugs related to unofficial add-ons to L2J. L2J
+bugtracker is NOT a place to fix that. Contact the person who made
+modification instead.
+
+
+====================
+XII. CREDITS
+====================
+
+Dev team: 
+http://www.l2jserver.com/forum/memberlist.php?mode=leaders
+
+Have fun playing L2J ;)
+Dev Team
+
+    L2J Server, Copyright (C) 2004-2012 
+    L2J Server comes with ABSOLUTELY NO WARRANTY.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions.