diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/HACKING.txt | 4 | ||||
| -rw-r--r-- | docs/INSTALL/debian.txt | 87 | ||||
| -rw-r--r-- | docs/INSTALL/ubuntu.txt | 43 | ||||
| -rw-r--r-- | docs/INSTALL/win32.txt | 149 | ||||
| -rw-r--r-- | docs/Makefile.am | 2 | ||||
| -rw-r--r-- | docs/SOURCE/Doxyfile | 4 | ||||
| -rw-r--r-- | docs/mana.6 (renamed from docs/tmw.6) | 12 | ||||
| -rw-r--r-- | docs/packages.txt | 16 |
8 files changed, 19 insertions, 298 deletions
diff --git a/docs/HACKING.txt b/docs/HACKING.txt index 88d22e7e..ad2f341b 100644 --- a/docs/HACKING.txt +++ b/docs/HACKING.txt @@ -1,8 +1,8 @@ ---------------------------- -The Mana World Hacking Guide +Mana Hacking Guide ---------------------------- -This guide is also available at http://wiki.themanaworld.org/index.php/Hacking +This guide is also available at http://gitorious.org/mana/pages/Hacking including more tips about C++ programming in general. With multiple coders working on the same source files, there needs to be a diff --git a/docs/INSTALL/debian.txt b/docs/INSTALL/debian.txt deleted file mode 100644 index 9a74d91b..00000000 --- a/docs/INSTALL/debian.txt +++ /dev/null @@ -1,87 +0,0 @@ -How to install TMW on my GNU/Debian Box -================================================== - -Author: FERREIRA Yohann (Bertram) -Email: Bertram@cegetel.net - -The Mana World project -====================== -Homepage: http://themanaworld.org/ -IRC: irc.freenode.net / #themanaworld - -1) Installing The Mana World and dependencies -2) Creating a Debian Package using DebHelper Tools -3) Notes - - -1. Installing The Mana World and Dependencies -============================================= - -The Mana World Debian Package can be installed under the Debian Testing and -Unstable (Sarge/Sid). In order to have Mana World working, you'll need -packages for SDL, SDL_mixer, SDL_image, libxml2, libphysfs and libguichan0. - -To install the dependencies, you can do type (as root): - - apt-get install libsdl-mixer1.2 libsdl-image1.2 libxml2 libphysfs-1.0-0 libguichan0 - -Type tmw as a normal user to play! (Enjoy!) - -2. Creating a Debian Package using DebHelper Tools -================================================== - -You'll need the gcc, g++ and dev packages of dependencies: - - apt-get install gcc g++ libsdl1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev - -And the debhelper tools: - - apt-get install dh-make fakeroot dpkg-dev build-essentials - -Download tmw from Subversion using the command (You'll need Subversion -installed on your system): - - svn https://svn.sourceforge.net/svnroot/themanaworld/tmw/trunk tmw - -Rename the tmw folder into tmw-XXX and open a console in it. -You can now type: - - fakeroot dpkg-buildpackage - -The package will create itself, including sources and diffs. You only need deb -file. - -Install it: - - dpkg -i tmw_XXXXXX_i386.deb - -(If you've got a previous one already installed with the same version number, -don't forget to remove it with :) - - apt-get remove tmw - -(Don't worry, you configuration files are not removed...) - -And now the final step: type 'tmw' as a normal user in a shell and you're in! - -KDE/GNOME menu entries are created in Arcade Games upon installation. - -3. Notes -======== - -A Debian Repository has been created. - -Simply add in your /etc/apt/sources.list file: - - deb http://bertram.ifrance.com ./ - deb-src http://bertram.ifrance.com ./ - -Then, as root, do: - - apt-get update - apt-get install tmw - -and you're done! - -N.B.: The tmw-music, libguichan0, and libguichan0-dev packages are also -provided in this repository. diff --git a/docs/INSTALL/ubuntu.txt b/docs/INSTALL/ubuntu.txt deleted file mode 100644 index cf830ccc..00000000 --- a/docs/INSTALL/ubuntu.txt +++ /dev/null @@ -1,43 +0,0 @@ -How to build a .deb for TMW on Ubuntu -===================================== - -This documentation is for those who are interested in building the .deb files -of The Mana World. Most people do not need to do this, but can instead use the -repository. You can find information about how to use the repository on our -downloads page. - - -1. Installing the dependencies -============================== - -First of all you need a working compiler and package building environment. If -you don't have this yet, install the following packages: - - apt-get install gcc g++ dh-make fakeroot dpkg-dev build-essentials - -In order to compile The Mana World, you'll need the developer packages for -SDL, SDL_mixer, SDL_image, SDL_net, libxml2, libphysfs and libguichan0. - - apt-get install libsdl1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev ... - -(todo: add missing entries) -(todo: include information about installing Guichan development package) - - -2. Creating the .debs using DebHelper Tools -=========================================== - -Either download the source release of TMW that you want to build a package for, -or check out the appropriate version from Subversion, for example by using the -tag. - -Make sure the files in the debian directory are up to date. You can do this by -checking out the appropriate directory from Subversion (will be either -tmw/branches/0.0/debian or tmw/trunk/debian for the latest release). - -Now we can build the packages using the following command. - - fakeroot dpkg-buildpackage - -The packages will be created in the parent folder. - diff --git a/docs/INSTALL/win32.txt b/docs/INSTALL/win32.txt deleted file mode 100644 index fb758c43..00000000 --- a/docs/INSTALL/win32.txt +++ /dev/null @@ -1,149 +0,0 @@ -How setup Dev-C++ to compile TMW on a Win32 Box -=============================================== - -The Mana World project -====================== -Homepage: themanaworld.sourceforge.net -IRC: irc.freenode.net / #themanaworld - - -0. Index -======== -1. Requirements -2. Installing Dev-C++ -3. Installing the required libraries -4. Compiling The Mana World - - -1. Requirements -=============== - -In this tutorial we will use Dev-C++ because of the fact that it's a very good -free IDE for Win32 built around GCC. Remember, Win32 was not meant for GCC and -stuff so you will probably run into trouble unless you really know what you're -doing, so best stick with Dev-C++. - -Besides a C++ compiler, TMW depends on the following libraries: - -1) SDL -2) SDL_mixer -3) SDL_image -4) Guichan 0.6.1 -5) libiconv -5) libxml2 -6) PhysFS -7) zlib -8) libcurl - - -2. Installing Dev-C++ -===================== - -This tutorial is written and tested with the latest beta version, which is -4.9.9.2 at the time of writing. You'll probably run into problems when you try -the old stable version, so don't do that. Get Dev-C++ here: - - http://www.bloodshed.net/ - -After you have fetched it, simply run and install as prompted. - - -3. Installing the required libraries -==================================== - -The easy way is to get our development package which should work with the latest -development code (I'll try to update it as much as I can). -You can find it at: - - http://themanaworld.sourceforge.net/files/tmw-svn.DevPak - - -Just install this one and you should be ready to go. (Although please remember -to remove anything the devpak might overlap before installing, for example the -previous devpak.) Remember to copy the required dlls from your dll folder in -the Dev-Cpp root directory, to the folder where you have your copy of The Mana -World. You also have to add the SDL include folder in your C++ include paths. -If you're using Dev-C++, this means: Tools -> Compiler options -> --> Directories -> C++ includes -> Browse... (browse to MinGW/include/SDL) -> --> Add -> Ok. -If you can't get the package or you are experiencing problems with it, just -send me an email at elvenprogrammer@gmail.com or continue reading. (Coming to -bug us on the IRC channel is a valid alternative too.) - -If you installed the tmw-svn.DevPak, you already have all you need so you can -skip ahead to compiling. - -Most of the libs have DevPaks that are very easy drop-ins for Dev-C++, without -any complex actions on your side. - -Get the following DevPaks and archives: - -- SDL (http://devpaks.org/details.php?devpak=12) -- SDL_mixer (http://old.devpaks.org/show.php?devpak=8) -- SDL_image (http://old.devpaks.org/show.php?devpak=142) -- Guichan (http://guichan.sourceforge.net/downloads.shtml) -- libxml2 * (ftp://ftp.zlatkovic.com/pub/libxml/) -- PhysFS ** (http://icculus.org/physfs/downloads/unsupported/) -- zlib *** (http://gnuwin32.sourceforge.net/packages/zlib.htm) -- libcurl **** (http://curl.haxx.se/download.html) - -Install them all through the Dev-C++ package manager. - -*) For libxml2, download the following files (these or newer versions): - - libxml2-2.6.19+.win32.zip - iconv-1.9.1.win32.zip - - From each file, copy the headers to your include directory, the libs to - the lib direcotry and the dlls (in bin direcotry) to your tmw directory. - -**) For PhysFS copy the headers to your include directory, the libs to - the lib directory and the dlls (in bin direcotry) to your tmw directory. - -***) Download developer files and put headers and libs in to include and lib - directories of Dev-Cpp. Download binaries and place the dll inside tmw - folder. - -****) Get latest win32 - mingw package and install as usual. - -You should now be fully equipped for compiling the latest TMW development -code! - - -4. Compiling The Mana World -=========================== - -Check out The Mana World from Subversion using either the command line svn -tool or TortoiseSVN, pick what you like to use most and install that. Next, -check out the following directory from our repository: - - https://svn.sourceforge.net/svnroot/themanaworld/tmw/trunk - -Open "The Mana World.dev" in Dev-C++. From there on you should be able to -start compilition with Excute -> Compile. A file called tmw.exe should appear -in the same directory as where you opened the .dev from. - -Before you can actually run the executable be sure to copy over the following -DLLs from your Dev-Cpp/dll directory to the directory containing tmw.exe (or -alternatively into your c:\windows\system\ for a more universal solution): - - SDL.dll - SDL_image.dll - SDL_mixer.dll - guichan.dll - guichan_opengl.dll - guichan_sdl.dll - -And also make sure you have: - - libxml2.dll - libcurl-3.dll - libiconv-2.dll - physfs.dll - zlib1.dll - -Additionally don't forget to copy any updated .dll (when libs are updated, -the dll are usually updated too) to the folder containing tmw.exe (or to the -c:\windows\system\). - -Have fun hacking The Mana World! diff --git a/docs/Makefile.am b/docs/Makefile.am index 0f9e7d2c..13a57e4e 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -man6_MANS = tmw.6 +man6_MANS = mana.6 EXTRA_DIST = $(man6_MANS) \ packages.txt \ diff --git a/docs/SOURCE/Doxyfile b/docs/SOURCE/Doxyfile index 96541dc8..5b5f30f9 100644 --- a/docs/SOURCE/Doxyfile +++ b/docs/SOURCE/Doxyfile @@ -17,7 +17,7 @@ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "The Mana World" +PROJECT_NAME = "Mana" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -625,7 +625,7 @@ GENERATE_HTMLHELP = NO # can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = tmw.chm +CHM_FILE = mana.chm # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of diff --git a/docs/tmw.6 b/docs/mana.6 index 0dee82c7..afdc2118 100644 --- a/docs/tmw.6 +++ b/docs/mana.6 @@ -1,13 +1,13 @@ -.TH "TMW" "6" +.TH "Mana" "6" .SH "NAME" -tmw \- tmw is The Mana World: A fantasy online game +tmw \- Mana: A 2D MMORPG client .SH "SYNOPSIS" -\fBtmw\fR +\fBmana\fR .SH "DESCRIPTION" This manual page documents briefly the -\fBtmw\fR ingame +\fBmana\fR ingame commands. -\fBtmw\fR is a great online game based upon the Seiken Densetsu Serie. +\fBmana\fR is a great online game based upon the Seiken Densetsu Serie. It has its own universe, and and its own character management system, which will give you the opportunity to play in a 2D heroic-fantasy world forever. .SH "BINARY PARAMETERS" @@ -68,7 +68,7 @@ Shows / Hide equipment window. Shows configuration window. .SH "AUTHOR" This manual page was written by Patrick Matth\[:a]i <patrick.matthaei@web.de> -for The Mana World project. +for the Mana project. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation. diff --git a/docs/packages.txt b/docs/packages.txt index 3d794a1b..b4650241 100644 --- a/docs/packages.txt +++ b/docs/packages.txt @@ -1,5 +1,5 @@ ----------------------------- -THE MANA WORLD PACKAGE SYSTEM +MANA PACKAGE SYSTEM ----------------------------- 1. INTRODUCTION @@ -13,24 +13,24 @@ THE MANA WORLD PACKAGE SYSTEM 1. INTRODUCTION -The Mana World is expected to grow continuously with updates to the game world +Mana is expected to grow continuously with updates to the game world occurring relatively frequently. More often so than for example new releases of the game client. To make sure players don't have to update their data manually all the time, by for example downloading the latest from the website, -the TMW client should be able to automatically obtain new data packages from +the Mana client should be able to automatically obtain new data packages from the server. Note: To reduce the load on the server (which isn't expected to have huge free uploading resources), the idea is that the server will only send a torrent file to the client and that the file is subsequently downloaded from - several locations that have volunteered to spread TMW data files. Ultimately + several locations that have volunteered to spread Mana data files. Ultimately a simple option on the client will even allow players to contribute their excess bandwidth to help other players get the updates faster. 2. LOCATION OF DATA -There are two locations where TMW can look for game data. The install data +There are two locations where Mana can look for game data. The install data directory and the data directory in the user's home directory. The latter one doesn't have to be used for Windows users, but is required for dynamic updates for UNIX users, who generally won't have write permissions to the install @@ -42,7 +42,7 @@ data directory. So for UNIX the two locations are: While for Windows all the data will be located at: - C:\Program Files\The Mana World\data\* + C:\Program Files\Mana\data\* In the UNIX case it doesn't matter in which order the data directories are examined. @@ -83,7 +83,7 @@ package is irrelevant. An example of the contents is given by: 5. INITIALIZING PACKAGE MANAGEMENT -When TMW starts it will scan its data directories for both packages (archives) +When Mana starts it will scan its data directories for both packages (archives) and directories. When a directory is found with the same name as a package, the directory is the preferred location to load data from as it is assumed to be more up to date. @@ -127,7 +127,7 @@ The resource management technique is critical to the overall success of the package management system as a whole. Resources are loaded at runtime as they are needed, and unloaded as they become unused. In order to ensure the autonomous functioning of this process reference counting is the agreed upon -technique for managing loaded resources in TMW. +technique for managing loaded resources in Mana. For those unfamiliar with the practice of reference counting, it involves every resource object having a variable containing the number of references to |