summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKraant <kraant@gmail.com>2008-08-07 21:36:18 +0000
committerKraant <kraant@gmail.com>2008-08-07 21:36:18 +0000
commitd63aff470f914d711b92af12ceb7944e8a6e24f4 (patch)
tree837585ea16854831dd6cd9ffc0592649076cc64a /docs
parent128afe364bf797d02424b6e7191bb4bd4c1df21d (diff)
downloadmana-client-d63aff470f914d711b92af12ceb7944e8a6e24f4.tar.gz
mana-client-d63aff470f914d711b92af12ceb7944e8a6e24f4.tar.bz2
mana-client-d63aff470f914d711b92af12ceb7944e8a6e24f4.tar.xz
mana-client-d63aff470f914d711b92af12ceb7944e8a6e24f4.zip
Rebranding TME to Aethyra
Diffstat (limited to 'docs')
-rw-r--r--docs/FAQ.txt20
-rw-r--r--docs/HACKING.txt2
-rw-r--r--docs/INSTALL/debian.txt50
-rw-r--r--docs/INSTALL/win32.txt34
-rw-r--r--docs/Makefile.am6
-rw-r--r--docs/SOURCE/aethyra.doxcfg (renamed from docs/SOURCE/tme.doxcfg)4
-rw-r--r--docs/SOURCE/aethyradox.sh1
-rw-r--r--docs/SOURCE/tmedox.sh1
-rw-r--r--docs/aethyra.6 (renamed from docs/tme.6)12
-rw-r--r--docs/packages.txt27
-rw-r--r--docs/sounddev.txt4
-rw-r--r--docs/win32-release.txt9
12 files changed, 100 insertions, 70 deletions
diff --git a/docs/FAQ.txt b/docs/FAQ.txt
index db3eb491..b52c0f17 100644
--- a/docs/FAQ.txt
+++ b/docs/FAQ.txt
@@ -7,10 +7,10 @@ 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: #themanaexperiment.
+ irc.freenode.net Channel: #aethyra.
If you don't like IRC just come to our forums:
- http://tme.onlinegamecore.com/forums. Ok, do you think forums are evil?
- Don't worry, send me an e-mail at elvenprogrammer@gmail.com and you're done.
+ http://forums.aethyra.com/ . Ok, do you think forums are evil?
+ Don't worry, send me an e-mail at blame582@gmail.com and you're done.
That's not enough? No, I won't give you my phone number! ;P
GAME
@@ -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
- elvenprogrammer@gmail.com.
+ blame582@gmail.com.
Q: I always get "Wrong password" but I'm sure I typed it right, why?
@@ -52,13 +52,15 @@ A: It's a system where is stored the latest development version. It's not
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)
+
DEVELOPMENT
Q: When will the next version be released?
A: We have scheduled releases. Usually a new release is available every month.
- Check http://wiki.themanaworld.org/index.php/Roadmap for further infos.
+ Check http://www.aethyra.com/ for further info.
Q: How can I contribute?
@@ -67,11 +69,11 @@ 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
- elvenprogrammer@gmail.com explaining what you want to do, or join our irc
- channel: #themanaexperiment @ irc.freenode.net.
+ blame582@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 The Mana Experiment and report
+ - You can be a beta tester. Just play with Aethyra and report
every error on the forum.
- - Play with The Mana Experiment: more players, more fun! Simple as that! ;-)
+ - Play with Aethyra: more players, more fun! Simple as that! ;-)
diff --git a/docs/HACKING.txt b/docs/HACKING.txt
index fdec32a6..85ad0d8c 100644
--- a/docs/HACKING.txt
+++ b/docs/HACKING.txt
@@ -1,5 +1,5 @@
---------------------------------
-The Mana Experiment Hacking Guide
+Aethyra Hacking Guide
---------------------------------
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
index 59e2376e..e9cf3183 100644
--- a/docs/INSTALL/debian.txt
+++ b/docs/INSTALL/debian.txt
@@ -1,31 +1,43 @@
-How to install TME on my GNU/Debian Box
+How to install Aethyra on my GNU/Debian Box
==================================================
Author: FERREIRA Yohann (Bertram)
Email: Bertram@cegetel.net
-The Mana Experiment project
+With slight edits by Daniel Thomas (kraant@gmail.com)
+to for Aethyra...
+
+WARNING! These instructions are probably outdated!
+
+Check the forums (http://forums.aethyra.com/) where better help can be found.
+
+Aethyra project
======================
-Homepage: http://209.168.213.109/
-IRC: irc.freenode.net / #themanaexperiment
+Homepage: http://www.aethyra.com/
+IRC: irc.freenode.net / #aethyra
-1) Installing The Mana Experiment and dependencies
+1) Installing Aethyra and dependencies
2) Creating a Debian Package using DebHelper Tools
3) Notes
-1. Installing The Mana Experiment and Dependencies
+1. Installing Aethyra and Dependencies
=============================================
-The Mana Experiment Debian Package can be installed under the Debian Testing and
+Aethyra Debian Package can be installed under the Debian Testing and
Unstable (Sarge/Sid). In order to have Mana Experiment 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
+ apt-get install libsdl-mixer1.2 libsdl-image1.2 libxml2 libphysfs-1.0-0
-Type tmw as a normal user to play! (Enjoy!)
+(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!)
2. Creating a Debian Package using DebHelper Tools
==================================================
@@ -41,9 +53,9 @@ And the debhelper tools:
Download tmw from Subversion using the command (You'll need Subversion
installed on your system):
- svn svn://209.168.213.109 tme
+ svn co svn://209.168.213.109/client/trunk aethyra
-Rename the tme folder into tme-XXX and open a console in it.
+Rename the aethyra folder into aethyra-XXX and open a console in it.
You can now type:
fakeroot dpkg-buildpackage
@@ -53,16 +65,16 @@ file.
Install it:
- dpkg -i tme_XXXXXX_i386.deb
+ dpkg -i aethyra_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 tme
+ apt-get remove aethyra
(Don't worry, you configuration files are not removed...)
-And now the final step: type 'tme' as a normal user in a shell and you're in!
+And now the final step: type 'aethyra' as a normal user in a shell and you're in!
KDE/GNOME menu entries are created in Arcade Games upon installation.
@@ -71,6 +83,10 @@ 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 ./
@@ -79,9 +95,11 @@ Simply add in your /etc/apt/sources.list file:
Then, as root, do:
apt-get update
- apt-get install tme
+ apt-get install aethyra
and you're done!
-N.B.: The tme-music, libguichan0, and libguichan0-dev packages are also
+N.B.: The t_me-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 88f47034..3ffd506e 100644
--- a/docs/INSTALL/win32.txt
+++ b/docs/INSTALL/win32.txt
@@ -1,10 +1,12 @@
-How setup Dev-C++ to compile TME on a Win32 Box
+How setup Dev-C++ to compile Aethyra on a Win32 Box
===============================================
-The Mana Experiment project
+(I think Dev-C++ support is broken as of now -- kraant)
+
+Aethyra project
===========================
-Homepage: http://209.168.213.109
-IRC: irc.freenode.net / #themanaexperiment
+Homepage: http://www.aethyra.com
+IRC: irc.freenode.net / #aethyra
0. Index
@@ -12,7 +14,7 @@ IRC: irc.freenode.net / #themanaexperiment
1. Requirements
2. Installing Dev-C++
3. Installing the required libraries
-4. Compiling The Mana Experiment
+4. Compiling Aethyra
1. Requirements
@@ -23,7 +25,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, TME depends on the following libraries:
+Besides a C++ compiler, Aethyra depends on the following libraries:
1) SDL
2) SDL_mixer
@@ -95,22 +97,22 @@ 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 tme directory.
+ the lib direcotry and the dlls (in bin direcotry) to your aethyra directory.
**) For PhysFS copy the headers to your include directory, the libs to
- the lib directory and the dlls (in bin direcotry) to your tme directory.
+ the lib directory and the dlls (in bin direcotry) to your aethyra 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 tme
+ directories of Dev-Cpp. Download binaries and place the dll inside aethyra
folder.
****) Get latest win32 - mingw package and install as usual.
-You should now be fully equipped for compiling the latest TME development
+You should now be fully equipped for compiling the latest Aethyra development
code!
-4. Compiling The Mana Experiment
+4. Compiling Aethyra
================================
Check out The Mana Experiment from Subversion using either the command line svn
@@ -119,12 +121,12 @@ check out the following directory from our repository:
svn://209.168.213.109/client/trunk
-Open "The Mana Experiment.dev" in Dev-C++. From there on you should be able to
-start compilition with Excute -> Compile. A file called tme.exe should appear
+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
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 tme.exe (or
+DLLs from your Dev-Cpp/dll directory to the directory containing aethyra.exe (or
alternatively into your c:\windows\system\ for a more universal solution):
SDL.dll
@@ -143,7 +145,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 tme.exe (or to the
+the dll are usually updated too) to the folder containing aethyra.exe (or to the
c:\windows\system\).
-Have fun hacking The Mana Experiment!
+Have fun hacking Aethyra!
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 4ea96959..8b311f85 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,11 +1,11 @@
-man6_MANS = tme.6
+man6_MANS = aethyra.6
EXTRA_DIST = $(man6_MANS) \
packages.txt \
FAQ.txt \
HACKING.txt \
- SOURCE/tmedox.sh \
- SOURCE/tme.doxcfg \
+ SOURCE/aethyradox.sh \
+ SOURCE/aethyra.doxcfg \
items.txt \
progression.txt \
INSTALL/debian.txt \
diff --git a/docs/SOURCE/tme.doxcfg b/docs/SOURCE/aethyra.doxcfg
index f3f90af9..cbc22910 100644
--- a/docs/SOURCE/tme.doxcfg
+++ b/docs/SOURCE/aethyra.doxcfg
@@ -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 Experiment
+PROJECT_NAME = Aethyra
# 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 = tme.chm
+CHM_FILE = aethyra.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
new file mode 100644
index 00000000..e0f299a8
--- /dev/null
+++ b/docs/SOURCE/aethyradox.sh
@@ -0,0 +1 @@
+cd ../../src/ && doxygen ../docs/SOURCE/aethyra.doxcfg
diff --git a/docs/SOURCE/tmedox.sh b/docs/SOURCE/tmedox.sh
deleted file mode 100644
index 7ab9ea74..00000000
--- a/docs/SOURCE/tmedox.sh
+++ /dev/null
@@ -1 +0,0 @@
-cd ../../src/ && doxygen ../docs/SOURCE/tme.doxcfg
diff --git a/docs/tme.6 b/docs/aethyra.6
index f4fe85cf..a130a3a5 100644
--- a/docs/tme.6
+++ b/docs/aethyra.6
@@ -1,13 +1,13 @@
-.TH "TME" "6"
+.TH "AETHYRA" "6"
.SH "NAME"
-tme \- tme is The Mana Experiment: A fantasy online game
+aethyra \- aethyra is Aethyra: A fantasy online game
.SH "SYNOPSIS"
-\fBtme\fR
+\fBaethyra\fR
.SH "DESCRIPTION"
This manual page documents briefly the
-\fBtme\fR ingame
+\fBaethyra\fR ingame
commands.
-\fBtme\fR is a great online game based upon the Seiken Densetsu Serie.
+\fBaethyra\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"
@@ -91,7 +91,7 @@ Displays / Hides debug window.
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 The Mana Experiment.
+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/packages.txt b/docs/packages.txt
index 46c35f51..d5735e28 100644
--- a/docs/packages.txt
+++ b/docs/packages.txt
@@ -1,5 +1,5 @@
----------------------------------
-THE MANA EXPERIMENT PACKAGE SYSTEM
+AETHYRA PACKAGE SYSTEM
----------------------------------
1. INTRODUCTION
@@ -10,41 +10,46 @@ THE MANA EXPERIMENT PACKAGE SYSTEM
6. LOADING A REQUESTED RESOURCE
7. RESOURCE MANAGEMENT DETAILS
+(Note this file is a _little_ outdated in some ways -- kraant)
+
1. INTRODUCTION
-The Mana Experiment is expected to grow continuously with updates to the game
+Aethyra (Was The Mana Experiment, original;y 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 TME client should be able to automatically obtain new data
+website, the Aethyra 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 TME data files. Ultimately
+ several locations that have volunteered to spread Aethyra 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 TME can look for game data. The install data
+There are two locations where Aethyra 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/tme/data/*
+ /usr/local/share/aethyra/data/*
- ~/.tme/updates/*
+ ~/.aethyra/updates/*
- ~/.tme/customdata
+ ~/.aethyra/customdata
While for Windows all the data will be located at:
- C:\Program Files\The Mana Experiment\data\*
+ C:\Program Files\Aethyra\data\*
In the UNIX case it doesn't matter in which order the data directories are
examined.
@@ -85,7 +90,7 @@ package is irrelevant. An example of the contents is given by:
5. INITIALIZING PACKAGE MANAGEMENT
-When TME starts it will scan its data directories for both packages (archives)
+When Aethyra 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.
@@ -129,7 +134,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 TME.
+technique for managing loaded resources in Aethyra.
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/sounddev.txt b/docs/sounddev.txt
index ed2ae71e..1c83157a 100644
--- a/docs/sounddev.txt
+++ b/docs/sounddev.txt
@@ -1,5 +1,5 @@
-------------------------------------
-THE MANA EXPERIMENT SOUND DEVELOPMENT
+AETHYRA SOUND DEVELOPMENT
-------------------------------------
1. INTRODUCTION
@@ -9,7 +9,7 @@ THE MANA EXPERIMENT SOUND DEVELOPMENT
1. INTRODUCTION
-In The Mana Experiment we plan to have both background music and sound effects
+In Aethyra we plan to have both background music and sound effects
linked to beings actions.
2. SPECS
diff --git a/docs/win32-release.txt b/docs/win32-release.txt
index 1c0577df..64590139 100644
--- a/docs/win32-release.txt
+++ b/docs/win32-release.txt
@@ -1,5 +1,5 @@
-------------------------------------------
-THE MANA EXPERIMENT WIN32 RELEASE CHECKLIST
+AETHYRA WIN32 RELEASE CHECKLIST
-------------------------------------------
Every Win32 releaser should follow this checklist when creating a new package.
@@ -11,7 +11,10 @@ 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 tme.exe to tme_opengl.exe
+ 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)
- 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:
@@ -19,7 +22,7 @@ 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="server.themanaworld.org"/>
+ <option name="host" value="209.168.213.109"/>
<option name="hwaccel" value="0"/>
<option name="port" value="6901"/>
<option name="remember" value="0"/>