updates to readme files

This commit is contained in:
mnaumann
2011-01-03 03:01:32 +00:00
parent 944f6f0eee
commit ec77cd9eab
3 changed files with 147 additions and 154 deletions

View File

@@ -1,8 +1,7 @@
Mega-Glest source code v3.2.x - Copyright (C) 2009-2010 Titus Tscharntke (info@titusgames.de) and Mark Vejvoda (mark_vejvoda@hotmail.com. MegaGlest source code v3.2.x and higher - Copyright (C) 2009-2010 Titus Tscharntke (info@titusgames.de) and Mark Vejvoda (mark_vejvoda@hotmail.com).
Glest source code v3.2.x - Copyright (C) 2002-2009 Martiño Figueroa (www.glest.org - contact_game@glest.org). Glest source code v3.2.x - Copyright (C) 2002-2009 Martiño Figueroa (www.glest.org - contact_game@glest.org).
You can redistribute this code and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. You can redistribute this code and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the license, or (at your option) any later version. Please refer to code_license.txt for the complete license.
For compilation instructions or any other info please visit the developer board at http://www.glest.org
For compilation instructions or any other info please visit the development documentation at http://megaglest.org/.

View File

@@ -1,20 +1,20 @@
Mega-Glest MegaGlest
by Titus Tscharntke and Mark Vejvoda by Titus Tscharntke and Mark Vejvoda
original Glest linux port original Glest linux port
by Matthias Braun by Matthias Braun
1. System requirements 1. System requirements
Developed on Linux with glibc, little endian cpu. The game does currently not Developed on Linux with glibc, little endian cpu. While MacIntel builds exist,
work on big endian cpus like ppc. There are some unfinished patches floating the game does not currently work on big endian CPUs like PPC. There are some
around the glest board, so this might improve (feel free to send me unfinished patches floating around the glest board, so this might improve (feel
updated/finished ppc patches). free to send updated/finished PPC patches).
Graphics card + OpenGL libraries that support OpenGL 1.3 and shader extensions Graphics card + OpenGL libraries that support OpenGL 1.3 and shader extensions
(=opengl 1.4 or glUseProgramObjectARB and co.) (=OpenGL 1.4 or glUseProgramObjectARB etc.)
The app has been reported to run fine on a 900Mhz Athlon box with nvidia geforce The app has been reported to run fine on a 900Mhz Athlon box with Nvidia GeForce
3 graphics card. 3 graphics card.
It seems that the game also runs on geforce 2 and geforce mx class hardware when It seems that the game also runs on GeForce 2 and GeForce Mx class hardware when
you disable 3d textures and shadowmaps in the options menu. The game seems not you disable 3D textures and shadow maps in the options menu. The game seems not
to work with the open source (ATI) DRI drivers. It has reported to run nicely to work with the open source (ATI) DRI drivers. It has reported to run nicely
with ATIs proprietary drivers though. with ATIs proprietary drivers though.
@@ -25,29 +25,28 @@ with ATIs proprietary drivers though.
The game depends on some tools and libraries to be present, before you can The game depends on some tools and libraries to be present, before you can
start compiling it. Here's a list of them: start compiling it. Here's a list of them:
* normal gnu compiler and additional tools (g++ version 3.2 or later is * normal GNU compiler and additional tools (g++ version 3.2 or later is
required at the moment) required at the moment)
* perforce jam 2.5 or later (used as build tool) * Kitware CMake 2.8 or later (used as build tool)
ftp://ftp.perforce.com/pub/jam
* X11 libraries +headers * X11 libraries +headers
http://www.x.org (or the older http://www.xfree86.org) http://x.org/ (or the older http://xfree86.org/)
* SDL 1.2.5 or later * SDL 1.2.5 or later
http://www.libsdl.org http://libsdl.org/
* Xerces-C * Xerces-C
http://xml.apache.org/xerces-c/index.html http://xerces.apache.org/xerces-c/
* OpenAL * OpenAL
http://www.openal.org http://openal.org/
* Ogg * Ogg
http://www.xiph.org/ogg/vorbis http://xiph.org/ogg/vorbis/
* Vorbis * Vorbis
http://www.vorbis.com http://vorbis.com/
If the configure script can't find some of the libraries, make sure that you If the configure script can't find some of the libraries, make sure that you
also have the -dev packages installed that some distributions provide. also have the -dev packages installed that some distributions provide.
@@ -56,22 +55,16 @@ that made our development easy and straightforward.
2.2 Building 2.2 Building
To build and install the game use the following commands To build the game simply invoke the build script:
./configure ./build-mg.sh
jam
Note: if you got the game from the subversion repository then you have to
change to the mk/linux directory first and create a configure script:
cd mk/linux
./autogen.sh
2.3 Installation 2.3 Installation
Unfortunately there is no real installation mechanism present yet (jam install We provide MojoSetup based installers for Linux. By default, they install to
does NOT work correctly). Please copy the executable file named "glest" and the your home directory. There are also community maintained packages available for
example linux config "glest.ini" into the directory where you extracted the several distributions. Please see the forums and wiki for details.
datafiles and start the game there.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -80,50 +73,43 @@ datafiles and start the game there.
Some hints for troubleshooting. Some hints for troubleshooting.
In General: In General:
* Make sure you fullfill the system requirement above * Make sure you fullfill the system requirements above
* Sound is played through OpenAL you might take a look at your openal * Sound is played through OpenAL - you might need to take a look at your
configuration: http://supertux.lethargik.org/wiki/OpenAL_Configuration configuration: http://supertux.lethargik.org/wiki/OpenAL_Configuration
Compiling: Compiling:
* If configure fails make sure you have read the Building section above * If configure fails make sure you have read the Building section above
* If you don't manage to get it compiled, you can get a precompiled version for
x86 (32bit) at http://www.lifl.org Sound/Audio errors when starting:
Sound/Audio errors when starting
* If the game doesn't start because of audio/sound errors: * If the game doesn't start because of audio/sound errors:
Make sure no other application is using your soundcard. Typical problems Make sure no other application is using your soundcard. Typical problems are
are the gnome/kde sound dameons esd and artsd. You can kill these 2 the Gnome/KDE sound dameons esd and artsd. You can kill these daemons with
daemons with
killall esd ; killall artsd killall esd ; killall artsd
* If this doesn't solve your sound problems try to get an updated OpenAL from * If this doesn't solve your sound problems try to get an updated OpenAL from
somewhere, unfortunately there hasn't been an official OpenAL version up to http://openal.org or a newer repository provided by your distribution.
now so distributions are only packing some preliminary snapshots. Some
distributions seem to have bad versions that don't work (SuSE 9.2 is such a
distribution)
(The compiled binary from lifl.org has openal included and should not be
affected by this problem)
The game complains about opengl1.3 not available, is missing opengl extensions
or works very slowly
* Make sure you fullfill the system requirements
* look at glxinfo and make sure the system is using ATI or NVIDIA driver and NOT the
mesa drivers ("glxinfo | grep -i mesa" should return nothing)
The game crashs The game complains about OpenGL1.3 not available, is missing OpenGL extensions
* Fedora3 seems to have problems with the precompiled glest binaries -> compile or works very slowly:
the application yourself * Make sure your system provides for the system requirements
* There are some bugs related to the font code which I can't reproduce and am * Look at glxinfo and make sure the system is using the drivers you want to
unable to fix without further input. Someone can help me with this? use. Often the proprietary ATI or NVIDIA drivers work better, but for Intel,
* The game does not work on ppc (big endian architectures) yet mesa drivers ("glxinfo | grep -i mesa") can work, too (though slowly due to
* Check the forums at www.glest.org limited abilities of these chipsets).
* It would be nice if you could report any other crashs that are not described
here yet (or post them to the forum at www.glest.org) preferably with gdb The game crashes:
backtrace from a debugging enabled build (configure --enable-debug) * Check the forums at http://forums.megaglest.org/
* It would be nice if you could report any other crashes and freezes that are
not yet described on the forums, preferably with a gdb backtrace from a
debugging enabled build (cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4. Contact 4. Contact
Original Glest is from http://www.glest.org Original Glest is from http://glest.org/
Linux port by Matthias Braun <matze@braunis.de> with help from Linux port by:
Karl Robillard <krobbillard@san.rr.com> Matthias Braun <matze@braunis.de> with help from
Karl Robillard <krobbillard@san.rr.com>
MegaGlest by:
Titus Tscharntke (info@titusgames.de) Titus Tscharntke (info@titusgames.de)
Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com) Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com)

View File

@@ -6,12 +6,14 @@
1. System requirements 1. System requirements
Developed on Windows with Microsoft Visual C++ 2008 Express (free version), Developed on Windows with Microsoft Visual C++ 2008 Express (free version),
little endian cpu. The game does currently not work on big endian cpus like ppc. little endian CPU. Compiling using the mingw32 toolset is now possible, which
The app has been reported to run fine on a 900Mhz Athlon box with nvidia geforce also allows for cross compiling. The game does not currently work on big endian
3 graphics card. It seems that the game also runs on geforce 2 and geforce mx CPUs like PPC. There are, however, community contributed builds available for
class hardware when you disable 3d textures and shadowmaps in the options menu. MacIntel. The app has been reported to run fine on a 900Mhz Athlon box with
The windows version should run on 32 and 64 bit versions of Windows and has been Nvidia GeForce 3 graphics card. It seems that the game also runs on GeForce 2
reported to run successfully on Windows 2000 - Windows 7. and GeForce Mx class hardware when you disable 3D textures and shadow maps in
the options menu. The windows version runs on 32 and 64 bit versions of Windows
and has been reported to run successfully on Windows 2000 - Windows 7.
2. Building and Installation 2. Building and Installation
@@ -20,25 +22,29 @@ The game depends on some tools and libraries to be present, before you can
start compiling it. Here's a list of them: start compiling it. Here's a list of them:
* Microsoft Visual C++ Express 2008 or higher * Microsoft Visual C++ Express 2008 or higher
OR
* mingw32
* Glest Windows 32 bit Dependencies * Glest Windows 32 bit Dependencies
https://sourceforge.net/projects/megaglest/files/win32_deps.7z/download http://sourceforge.net/projects/megaglest/files/win32_deps.7z/download
to build with VC++ or, to build with mingw:
http://sourceforge.net/projects/megaglest/files/win32_deps_mingw.7z/download
which includes: which include:
* Xerces-C * Xerces-C
http://xml.apache.org/xerces-c/index.html http://xerces.apache.org/xerces-c/
* wxWidgets * wxWidgets
http://www.wxwidgets.org/downloads/ http:/wxwidgets.org/downloads/
2.2 Building 2.2 Building
To build and install the game use the following steps: To build and install the game use the following steps:
1. Download the win32_deps.7z mentioned above and decompress its contents 1. Download the dependencies archive mentioned above and decompress its contents
into the 'source' folder (where you see glest_game, g3d_viewer, etc). into the 'source' folder (where you see glest_game, g3d_viewer, etc).
This should create a folder called win32_deps with many sub files/folders This should create a folder called "win32_deps" with many sub files/folders
in it. in it.
2. Open the VC++ 2008 Solution file in trunk\mk\windoze called Glest.sln within 2. Open the VC++ 2008 Solution file in trunk\mk\windoze called Glest.sln within
@@ -48,20 +54,22 @@ in it.
Rebuild All. Rebuild All.
If you had no errors all binaries will be created in trunk\data\glest_game. If you had no errors all binaries will be created in trunk\data\glest_game.
Before running mega-glest you must run the batchfile: CopyWindowsRuntimeDlls.bat Before running MegaGlest you must run the batchfile CopyWindowsRuntimeDlls.bat
You should now be to to just run glest_game.exe You should now be able to just run glest_game.exe.
2.3 Installation 2.3 Installation
Unfortunately there is no real installation mechanism present yet, just run the We provide NSIS based installation packages. By default, these will create a
glest_game.exe from within the trunk\data\glest_game directory. system-wide installation below Program Files and setup Desktop icons for
simplified access.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4. Contact 4. Contact
Main Glest website from http://www.glest.org The main MegaGlest website is http://megaglest.org/
Development information is available at http://wiki.megaglest.org/
Forums are at http://forums.megaglest.org/
Titus Tscharntke (info@titusgames.de) Titus Tscharntke (info@titusgames.de)
Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com) Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com)