--- deliantra/server/README 2006/02/03 07:11:13 1.1 +++ deliantra/server/README 2007/03/06 22:07:56 1.6 @@ -1,10 +1,12 @@ WHAT IS CROSSFIRE? - This is a multiplayer graphical arcade and adventure game made for - the X-Windows environment. It runs on a client/server model. - The client runs with X11, GTK, or SDL within a gtk window. + This is a multiplayer graphical arcade and adventure game, that runs on a + client/server model. There are clients for Microsoft(R) Windows(TM) and + POSIX systems such as Linux and *BSD. To get the most joyful experience, + the Crossfire+ client should be used. This client is written in Perl and + utilises SDL with OpenGL. - It has certain flavours from other games, especially Gauntlet (TM) + Crossfire has certain flavours from other games, especially Gauntlet (TM) and Nethack/Moria. Any number of players can move around in their own window, finding @@ -13,73 +15,71 @@ REQUIREMENTS - For UNIX, X-windows and an ANSI C compiler to compile this game. - A window system is not needed if you don't want to compile the - map editor. - - For Windows 9x, you need Visual C++ (or some other ANSI C - compiler that can read ".dsw"-files). - + For UNIX, a modern C++ compiler with some extensions is required to + compile this game. In addition, you will need the Perl development + libraries along with the following Perl modules (the server is tested + with perl 5.8.8 and 5.8-maint). + + - Crossfire >= v0.97 + - Coro >= v3.5 + - Coro::Event >= v2.1 + - Event >= v1.08 + - IO::AIO >= 2.32 + - BDB >= v0.1 + - Storable >= v2.0 + - Time::HiRes >= v1.0 + - YAML::Syck >= v0.71 + - Digest::MD5 >= v2.0 + - Compress::LZF >= v1.71 + - Safe::Hole >= v0.10 + - Pod::POM >= v0.17 + + Furthermore, you will need the following programs and libraries: + + - gperf, the GNU perfect hash generator + - glib-2.0 >= v2.10 + - libpng >= v1.2 + - ImageMagick >= 6.0 (convert must be in your PATH). + - optipng (http://optipng.sf.net) + + Your compiler must support the Library Technical Report 1 extensions and + the upcoming typeof extension. The GNU C++ compiler >= version 4.0 does + support all these. + COMPILING - Crossfire has been known to compile on a wide variety of - systems. It should compile and most all ANSI C and Posix - compliant systems. + Crossfire has been known to compile on a wide variety of systems. It should + compile and most all ISO C++ 200x and POSIX compliant systems. To get directions on compilation for UNIX/LINUX, read the INSTALL file. - For Win9x, read INSTALL_WIN32.txt. USAGE - Crossfire runs on a client/server model. You will also need the - client to play. You can either connect to a server someone else - has set up, or run your own server and connect to that. The - client package has information for connecting to servers. - - To run your own server, you need to make the crossfire binaries and install - them, and then run the crossfire program. This now creates a server which - you/other people can connect to. The map files will need to get downloaded - and installed for the server to run properly. If you plan to run a long - term server, you should use one of the scripts provided that will re-run - crossfire if it dies for some reason. - -MAILING LIST - - For the latest subscription for crossfire mailing lists, go to: - http://crossfire.real-time.com/Website_Index/Mailing_Lists/mailing_lists.jhtml - - From there you should be able to subscribe/unsubscribe any of the mailing - lists. The mailing lists based off the ifi.uio.no host are being - discontinued. - - An archive of old messages can be found at - http://www.real-time.com/maillists/rte/crossfire - - -FTP SITES + Crossfire runs on a client/server model. You will also need the client + to play. You can either connect to a server someone else has set up, + or run your own server and connect to that. The client package has + information for connecting to servers. + + To run your own server, you need to make the crossfire binaries + and install them, and then run the crossfire program. This now + creates a server which you/other people can connect to. The map + files will need to get downloaded and installed for the server to run + properly. The map pack is released together with the server and can be + downloaded form the same location. The maps should be copied into the + $(TARGET)/share/crossfire/maps directory - after unpacking, you should + have a $(TARGET)/share/crossfire/maps/scorn directory. - FTP-sites where you can look for the latest versions are: - - ftp://ftp.sourceforge.net/pub/sourceforge/crossfire - ftp://ftp.real-time.com/pub/games/crossfire - - Changes made since the latest release can be found at the CVS - repository. Information on anonymous CVS access as - the download CVS snapshots and browsing the repository can be - found at: - http://sourceforge.net/cvs/?group_id=13833 - - - If you are looking for a windows/NT client, look at: - http://mids.student.utwente.nl/%7Emichtoen/crossfire/ + If you plan to run a long term server, you should use one of the scripts + provided that will re-run crossfire if it dies for some reason. WEB SITES: The following web addresses have crossfire information that you may find useful: - http://crossfire.real-time.com/ - real-time is the main crossfire site. + http://crossfire.schmorp.de/ (The main site) + + http://crossfire.real-time.com/ (The website for the old Crossfire game) REPORTING BUGS @@ -87,49 +87,34 @@ First, check the INSTALL file for common problems, and see if yours is mentioned. - The mailing list is where present development work and bugs are typically - discussed. If you want to know what is happening with crossfire, join the - list and please ask there. - - I will likely delete mail messages of the following sort: - 1) Bug reports of failed installation when the installation instructions - were not followed. - 2) Bug reports that contain so little information that it tells me nothing - more than the fact that there is a bug. - 3) Bugs in which the solution has already been answered in the INSTALL - file. + Bugs should be filed using the following email address: + crossfire@schmorp.de When reporting bugs, make sure you include the following: o What version of crossfire did you use? - o What type of computer did you use? - o What release of the operating system did it have? - o What windowing system are you using (Ie, openwindows, X11R6, etc) - o What compiler (and its version) did you use (ie, gcc, acc, etc)? + o What type of computer did you use (CPU type) + o What is the version of the OS? + o What windowing system are you using (e.g. openwindows, X.org, XFree86) + o What compiler (and its version) did you use (e.g. gcc, acc)? o Which flags did you give it? - o If the bug happens when compiling crossfire, send an EXACT copy of - the compiler line, as well as the errors it puts out. Sending bugs - of the sort 'it failed with a line like ...' doesn't help any. + o If the bug happens when compiling crossfire, send an EXACT copy of the + compiler line, as well as the errors it puts out. Sending bugs of the + sort 'it failed with a line like ...' doesn't help any. o If the bug happened while running crossfire: - Include any output before to the bug. - Give a description of what you did before the bug occured. The better - detailed the description, the better chance I have of figuring - out where the bug happened, or how I can recreate the bug. - o If you managed to compile Crossfire, include the output of - "crossfire -o". - - Lack of any of this information in a bug report can make that bug report -useless. Also, if you have a bug, make sure you are using the latest -version. If you report a bug that has since been fixed, you are not likely -to get any help. - -Further debugging informatiion can be found at -http://crossfire.real-time.com/debugging_tips.html + detailed the description, the better chance I have of figuring + out where the bug happened, or how I can recreate the bug. + - If possible, a stack trace from gdb (or other debugger) is very + helpful. - Mail the bug report to crossfire-devel@listserv.real-time.com +The more information provided, the better chance of the bug being fixed in +a timely fashion. ------------------------------------------------------------------------------ -SUBMITTING PATCHES: See the doc/programming_guide file. - +SUBMITTING PATCHES: +Patches should be submitted to email address: + crossfire@schmorp.de PUBLIC SERVERS: @@ -140,10 +125,8 @@ COPYRIGHT - Don't get scared by the below, it's included just for "safety" reasons 8) - (Don't want anyone to start selling the game) - - Copyright (C) 2000 Mark Wedel + Copyright (C) 2007 Crossfire Development Team + Copyright (C) 2000, 2006 Mark Wedel Copyright (C) 1992 Frank Tore Johansen This program is free software; you can redistribute it and/or modify @@ -160,4 +143,4 @@ along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - The author can be reached via e-mail to mwedel@scruz.net + The authors can be reached via e-mail to crossfire@schmorp.de