summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/FAQ.txt36
-rw-r--r--docs/HACKING.txt6
-rw-r--r--docs/INSTALL/debian.txt52
-rw-r--r--docs/INSTALL/win32.txt42
-rw-r--r--docs/Makefile.am5
-rw-r--r--docs/SOURCE/Doxyfile (renamed from docs/SOURCE/aethyra.doxcfg)10
-rw-r--r--docs/SOURCE/aethyradox.sh1
-rw-r--r--docs/items.txt2
-rw-r--r--docs/packages.txt43
-rw-r--r--docs/progression.txt4
-rw-r--r--docs/sounddev.txt10
-rw-r--r--docs/tmw.6 (renamed from docs/aethyra.6)51
-rw-r--r--docs/win32-release.txt15
13 files changed, 112 insertions, 165 deletions
diff --git a/docs/FAQ.txt b/docs/FAQ.txt
index 5a3baace..b214672e 100644
--- a/docs/FAQ.txt
+++ b/docs/FAQ.txt
@@ -7,12 +7,12 @@ Q: How to get help?
A: The fastest way is to come on our IRC channel. There you can find a lot of
nice people that will help you until you solve your problem. Server:
- irc.freenode.net Channel: #aethyra.
+ irc.freenode.net Channel: #themanaworld.
If you don't like IRC just come to our forums:
- http://www.aethyra.org/ . Ok, do you think forums are evil?
- Don't worry, send me an e-mail at blame582@gmail.com and you're done.
+ http://forums.themanaworld.org. Ok, do you think forums are evil? Don't
+ worry, send me an e-mail at elvenprogrammer@gmail.com and you're done.
That's not enough? No, I won't give you my phone number! ;P
-
+
GAME
Q: I always get "Unregistered ID" error message, why?
@@ -21,7 +21,7 @@ A: First of all check that your username is at least 4 characters long. Is the
first time you login? Have you registered an account? If not use the
"Register" button in game. If you already succesfully connected before, but
now you're getting this message, please send an e-mail to
- blame582@gmail.com.
+ elvenprogrammer@gmail.com.
Q: I always get "Wrong password" but I'm sure I typed it right, why?
@@ -50,9 +50,7 @@ Q: What's SVN?
A: It's a system where is stored the latest development version. It's not
assured that it's stable, but surely it has the latest updates. (SVN version
is updated quite frequently). If you want to check it out, read this guide
- http://themanaworld.org/svn-tutorial.txt
-
-(We need our own svn tut -- kraant)
+ http://themanaworld.org/svn-tutorial.txt
DEVELOPMENT
@@ -60,20 +58,24 @@ DEVELOPMENT
Q: When will the next version be released?
A: We have scheduled releases. Usually a new release is available every month.
- Check http://www.aethyra.org/ for further info.
+ Check http://themanaworld.org/ for further info.
Q: How can I contribute?
A: There are a lot of ways:
-
+
- If you're a programmer, an artist or just willing to help in any way, you
can become part of the development team. Send an e-mail to
- irarice@gmail.com explaining what you want to do, or join our irc
- channel: #aethyra @ irc.freenode.net.
-
- - You can be a beta tester. Just play with Aethyra and report
- every error on the forum.
-
- - Play with Aethyra: more players, more fun! Simple as that! ;-)
+ elvenprogrammer@gmail.com explaining what you want to do, or join our irc
+ channel: #themanaworld @ irc.freenode.net.
+
+ - You can donate money. Follow the link on the project page:
+
+ http://sourceforge.net/projects/themanaworld/
+
+ - You can be a beta tester. Just play The Mana World and report every
+ error to the tracker or on the forum.
+
+ - Play with The Mana World: more players, more fun! Simple as that! ;-)
diff --git a/docs/HACKING.txt b/docs/HACKING.txt
index 85ad0d8c..f2ae8b2b 100644
--- a/docs/HACKING.txt
+++ b/docs/HACKING.txt
@@ -1,6 +1,6 @@
----------------------------------
-Aethyra Hacking Guide
----------------------------------
+----------------------------
+The Mana World Hacking Guide
+----------------------------
With multiple coders working on the same source files, there needs to be a
standard specifying how code is written down. Not doing so can cause quite some
diff --git a/docs/INSTALL/debian.txt b/docs/INSTALL/debian.txt
index 4e643a55..9a74d91b 100644
--- a/docs/INSTALL/debian.txt
+++ b/docs/INSTALL/debian.txt
@@ -1,43 +1,31 @@
-How to install Aethyra on my GNU/Debian Box
+How to install TMW on my GNU/Debian Box
==================================================
Author: FERREIRA Yohann (Bertram)
Email: Bertram@cegetel.net
-With slight edits by Daniel Thomas (kraant@gmail.com)
-to for Aethyra...
-
-WARNING! These instructions are probably outdated!
-
-Check the forums (http://www.aethyra.org/forums/) where better help can be found.
-
-Aethyra project
+The Mana World project
======================
-Homepage: http://www.aethyra.org/
-IRC: irc.freenode.net / #aethyra
+Homepage: http://themanaworld.org/
+IRC: irc.freenode.net / #themanaworld
-1) Installing Aethyra and dependencies
+1) Installing The Mana World and dependencies
2) Creating a Debian Package using DebHelper Tools
3) Notes
-1. Installing Aethyra and Dependencies
+1. Installing The Mana World and Dependencies
=============================================
-Aethyra Debian Package can be installed under the Debian Testing and
-Unstable (Sarge/Sid). In order to have Mana Experiment working, you'll need
+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
+ apt-get install libsdl-mixer1.2 libsdl-image1.2 libxml2 libphysfs-1.0-0 libguichan0
-(You'll need to compile libguichan from source since we've moved to 8.1
-and there is no package for this as of yet. This could create
-problems, any debian users trying this out and giving us fixes
-would be much appreciated -- kraant)
-
-Type aethyra as a normal user to play! (Enjoy!)
+Type tmw as a normal user to play! (Enjoy!)
2. Creating a Debian Package using DebHelper Tools
==================================================
@@ -53,9 +41,9 @@ And the debhelper tools:
Download tmw from Subversion using the command (You'll need Subversion
installed on your system):
- svn co svn://www.aethyra.org/client/trunk aethyra
+ svn https://svn.sourceforge.net/svnroot/themanaworld/tmw/trunk tmw
-Rename the aethyra folder into aethyra-XXX and open a console in it.
+Rename the tmw folder into tmw-XXX and open a console in it.
You can now type:
fakeroot dpkg-buildpackage
@@ -65,16 +53,16 @@ file.
Install it:
- dpkg -i aethyra_XXXXXX_i386.deb
+ 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 aethyra
+ apt-get remove tmw
(Don't worry, you configuration files are not removed...)
-And now the final step: type 'aethyra' as a normal user in a shell and you're in!
+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.
@@ -83,10 +71,6 @@ KDE/GNOME menu entries are created in Arcade Games upon installation.
A Debian Repository has been created.
-(This repository is for The Mana World not Aethyra, volunteers to make a
-package would be nice, basically if you follow these instructions
-you won't get aethyra as of now -- kraant)
-
Simply add in your /etc/apt/sources.list file:
deb http://bertram.ifrance.com ./
@@ -95,11 +79,9 @@ Simply add in your /etc/apt/sources.list file:
Then, as root, do:
apt-get update
- apt-get install aethyra
+ apt-get install tmw
and you're done!
-N.B.: The t_me-music, libguichan0, and libguichan0-dev packages are also
+N.B.: The tmw-music, libguichan0, and libguichan0-dev packages are also
provided in this repository.
-
-(Added '_' to avoid picking this file up in grep, fix this later -- kraant)
diff --git a/docs/INSTALL/win32.txt b/docs/INSTALL/win32.txt
index 34d26e3f..fb758c43 100644
--- a/docs/INSTALL/win32.txt
+++ b/docs/INSTALL/win32.txt
@@ -1,12 +1,10 @@
-How setup Dev-C++ to compile Aethyra on a Win32 Box
+How setup Dev-C++ to compile TMW on a Win32 Box
===============================================
-(I think Dev-C++ support is broken as of now -- kraant)
-
-Aethyra project
-===========================
-Homepage: http://www.aethyra.org
-IRC: irc.freenode.net / #aethyra
+The Mana World project
+======================
+Homepage: themanaworld.sourceforge.net
+IRC: irc.freenode.net / #themanaworld
0. Index
@@ -14,7 +12,7 @@ IRC: irc.freenode.net / #aethyra
1. Requirements
2. Installing Dev-C++
3. Installing the required libraries
-4. Compiling Aethyra
+4. Compiling The Mana World
1. Requirements
@@ -25,7 +23,7 @@ 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, Aethyra depends on the following libraries:
+Besides a C++ compiler, TMW depends on the following libraries:
1) SDL
2) SDL_mixer
@@ -97,36 +95,36 @@ Install them all through the Dev-C++ package manager.
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 aethyra directory.
+ 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 aethyra directory.
+ 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 aethyra
+ 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 Aethyra development
+You should now be fully equipped for compiling the latest TMW development
code!
-4. Compiling Aethyra
-================================
+4. Compiling The Mana World
+===========================
-Check out The Mana Experiment from Subversion using either the command line svn
+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:
- svn://www.aethyra.org/client/trunk
+ https://svn.sourceforge.net/svnroot/themanaworld/tmw/trunk
-Open "Aethyra.dev" in Dev-C++. From there on you should be able to
-start compilition with Excute -> Compile. A file called aethyra.exe should appear
+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 aethyra.exe (or
+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
@@ -145,7 +143,7 @@ And also make sure you have:
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 aethyra.exe (or to the
+the dll are usually updated too) to the folder containing tmw.exe (or to the
c:\windows\system\).
-Have fun hacking Aethyra!
+Have fun hacking The Mana World!
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 8b311f85..0f9e7d2c 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,11 +1,10 @@
-man6_MANS = aethyra.6
+man6_MANS = tmw.6
EXTRA_DIST = $(man6_MANS) \
packages.txt \
FAQ.txt \
HACKING.txt \
- SOURCE/aethyradox.sh \
- SOURCE/aethyra.doxcfg \
+ SOURCE/Doxyfile \
items.txt \
progression.txt \
INSTALL/debian.txt \
diff --git a/docs/SOURCE/aethyra.doxcfg b/docs/SOURCE/Doxyfile
index cbc22910..c9522aaf 100644
--- a/docs/SOURCE/aethyra.doxcfg
+++ 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 = Aethyra
+PROJECT_NAME = The Mana World
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -30,7 +30,7 @@ PROJECT_NUMBER =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = ../docs/SOURCE/
+OUTPUT_DIRECTORY =
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -406,7 +406,7 @@ WARN_FORMAT = "$file:$line: $text"
# and error messages should be written. If left blank the output is written
# to stderr.
-WARN_LOGFILE =
+WARN_LOGFILE = "warnings.log"
#---------------------------------------------------------------------------
# configuration options related to the input files
@@ -417,7 +417,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT =
+INPUT = "../../src"
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -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 = aethyra.chm
+CHM_FILE = tmw.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/SOURCE/aethyradox.sh b/docs/SOURCE/aethyradox.sh
deleted file mode 100644
index e0f299a8..00000000
--- a/docs/SOURCE/aethyradox.sh
+++ /dev/null
@@ -1 +0,0 @@
-cd ../../src/ && doxygen ../docs/SOURCE/aethyra.doxcfg
diff --git a/docs/items.txt b/docs/items.txt
index efba35ac..19c6b10c 100644
--- a/docs/items.txt
+++ b/docs/items.txt
@@ -1,5 +1,5 @@
-------------------------------
- AETHYRA INVENTORY SYSTEM
+THE MANA WORLD INVENTORY SYSTEM
-------------------------------
1. INTRODUCTION
diff --git a/docs/packages.txt b/docs/packages.txt
index e29112c0..3d794a1b 100644
--- a/docs/packages.txt
+++ b/docs/packages.txt
@@ -1,6 +1,6 @@
-----------------------------------
-AETHYRA PACKAGE SYSTEM
-----------------------------------
+-----------------------------
+THE MANA WORLD PACKAGE SYSTEM
+-----------------------------
1. INTRODUCTION
2. LOCATION OF DATA
@@ -10,46 +10,39 @@ AETHYRA PACKAGE SYSTEM
6. LOADING A REQUESTED RESOURCE
7. RESOURCE MANAGEMENT DETAILS
-(Note this file is a _little_ outdated in some ways -- kraant)
-
1. INTRODUCTION
-Aethyra (Was The Mana Experiment, originally part of The Mana World) 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 Aethyra client should be able to automatically obtain new data
-packages from the server.
+The Mana World 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 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 Aethyra data files. Ultimately
+ several locations that have volunteered to spread TMW 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.
-(This doesn't seem to have occurred we're still using http all the way
-up to now even into Aethyra)
-
2. LOCATION OF DATA
-There are two locations where Aethyra can look for game data. The install data
+There are two locations where TMW 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
data directory. So for UNIX the two locations are:
- /usr/local/share/aethyra/data/*
-
- ~/.aethyra/updates/*
+ /usr/local/share/manaworld/data/*
- ~/.aethyra/customdata
+ ~/.manaworld/data/*
While for Windows all the data will be located at:
- C:\Program Files\Aethyra\data\*
+ C:\Program Files\The Mana World\data\*
In the UNIX case it doesn't matter in which order the data directories are
examined.
@@ -90,7 +83,7 @@ package is irrelevant. An example of the contents is given by:
5. INITIALIZING PACKAGE MANAGEMENT
-When Aethyra starts it will scan its data directories for both packages (archives)
+When TMW 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.
@@ -132,9 +125,9 @@ the data while working on the next package to be released.
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 Aethyra.
+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.
For those unfamiliar with the practice of reference counting, it involves
every resource object having a variable containing the number of references to
diff --git a/docs/progression.txt b/docs/progression.txt
index cbec77e2..a25cf11f 100644
--- a/docs/progression.txt
+++ b/docs/progression.txt
@@ -1,5 +1,5 @@
-----------------------------------
- AETHYRA PLAYER'S PROGRESSION
+THE MANA WORLD PLAYER'S PROGRESSION
-----------------------------------
1. PLAYER'S STATS
@@ -126,4 +126,4 @@ Peon 17 Double Hit, Hard Hit(JL:5) Beginner Lvl:10
Every of these notes have to be discussed, if you have any feedback,
suggestions, updates, commit or tell them at:
-address: irc://irc.freenode.net channel: #aethyra
+address: irc://irc.freenode.net channel: #themanaworld
diff --git a/docs/sounddev.txt b/docs/sounddev.txt
index 1c83157a..149150ba 100644
--- a/docs/sounddev.txt
+++ b/docs/sounddev.txt
@@ -1,6 +1,6 @@
--------------------------------------
-AETHYRA SOUND DEVELOPMENT
--------------------------------------
+--------------------------------
+THE MANA WORLD SOUND DEVELOPMENT
+--------------------------------
1. INTRODUCTION
2. SPECS
@@ -9,7 +9,7 @@ AETHYRA SOUND DEVELOPMENT
1. INTRODUCTION
-In Aethyra we plan to have both background music and sound effects
+In The Mana World we plan to have both background music and sound effects
linked to beings actions.
2. SPECS
@@ -35,4 +35,4 @@ all.
4. SUGGESTIONS
-As placeholders we could use Wesnoth SFX/BGM to test the sound engine.
+As placeholders we could use Wesnoth SFX/BGM to test the sound engine. \ No newline at end of file
diff --git a/docs/aethyra.6 b/docs/tmw.6
index a130a3a5..0dee82c7 100644
--- a/docs/aethyra.6
+++ b/docs/tmw.6
@@ -1,13 +1,13 @@
-.TH "AETHYRA" "6"
+.TH "TMW" "6"
.SH "NAME"
-aethyra \- aethyra is Aethyra: A fantasy online game
+tmw \- tmw is The Mana World: A fantasy online game
.SH "SYNOPSIS"
-\fBaethyra\fR
+\fBtmw\fR
.SH "DESCRIPTION"
This manual page documents briefly the
-\fBaethyra\fR ingame
+\fBtmw\fR ingame
commands.
-\fBaethyra\fR is a great online game based upon the Seiken Densetsu Serie.
+\fBtmw\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"
@@ -49,49 +49,26 @@ Make your character attack.
.B Key A:
Target nearest monster.
.TP
-.B Key Z:
+.B Key G:
Get items on the ground or in a chest.
.TP
-.B Key S:
-Make your character sit.
-.TP
.B Alt + 1...9:
Shows an emoticon above your character.
.TP
-.B F1:
-Displays / Hides in game help.
-.TP
-.B F2:
-Displays / Hides status window.
-.TP
-.B F3:
-Displays / Hides inventory window.
-.TP
-.B F4:
-Displays / Hides equipment window.
-.TP
-.B F5:
-Displays / Hides skills window.
-.TP
-.B F6:
-Displays / Hides map.
-.TP
-.B F7
-Displays / Hides messages.
+.B Alt + I:
+Shows / Hide inventory window.
.TP
-.B F8
-Displays / Hides hot-keys.
+.B Alt + K:
+Shows / Hide skills window.
.TP
-.B F9:
-Displays / Hides configuration window.
+.B Alt + E:
+Shows / Hide equipment window.
.TP
-.B F10
-Displays / Hides debug window.
+.B Alt + C:
+Shows configuration window.
.SH "AUTHOR"
This manual page was written by Patrick Matth\[:a]i <patrick.matthaei@web.de>
for The Mana World project.
-With slight alterations by Daniel Thomas\[:a]i <kraant@gmail.com>,
-for Aethyra.
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/win32-release.txt b/docs/win32-release.txt
index 5bd837d0..a8696897 100644
--- a/docs/win32-release.txt
+++ b/docs/win32-release.txt
@@ -1,6 +1,6 @@
--------------------------------------------
-AETHYRA WIN32 RELEASE CHECKLIST
--------------------------------------------
+--------------------------------------
+THE MANA WORLD WIN32 RELEASE CHECKLIST
+--------------------------------------
Every Win32 releaser should follow this checklist when creating a new package.
@@ -11,10 +11,7 @@ Every Win32 releaser should follow this checklist when creating a new package.
* Eventually Legal Copyright
- Update README and ChangeLog if not already
- Compile OpenGL version (Using -DUSE_OPENGL option) and rename the executable
- from aethyra.exe to aethyra_opengl.exe
- (This isn't actually how it's happening because I'm cross compiling
- and therefore flying blind. As it is aethyra.exe is the OpenGL version
- and no sdl version is generated -- kraant)
+ from tmw.exe to tmw_opengl.exe
- Compile normal version (Do not use special flags as __DEBUG or USE_OPENGL)
- Check if the dlls were compressed (SDL.dll, SDL_Image.dll, SDL_Mixer.dll)
- Check config.xml for default values:
@@ -22,9 +19,9 @@ Every Win32 releaser should follow this checklist when creating a new package.
<configuration>
<option name="chatlog" value="chatlog.txt"/>
<option name="guialpha" value="0.8"/>
- <option name="host" value="www.aethyra.org"/>
+ <option name="host" value="server.themanaworld.org"/>
<option name="hwaccel" value="0"/>
- <option name="port" value="21001"/>
+ <option name="port" value="6901"/>
<option name="remember" value="0"/>
<option name="screen" value="0"/>
<option name="sfxVolume" value="100"/>
generated by cgit v1.2.3-60-g2f50 (git 2.42.0) at 2024-07-28 05:43:14 +0000