From ec77cd9eab05900e9dc7995eacbbb08ed882fb81 Mon Sep 17 00:00:00 2001 From: mnaumann Date: Mon, 3 Jan 2011 03:01:32 +0000 Subject: [PATCH] updates to readme files --- docs/readme.txt | 13 +-- docs/readme_linux.txt | 242 +++++++++++++++++++--------------------- docs/readme_windows.txt | 46 ++++---- 3 files changed, 147 insertions(+), 154 deletions(-) diff --git a/docs/readme.txt b/docs/readme.txt index 329c4c943..f9fb7c6ac 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -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). - -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. - -For compilation instructions or any other info please visit the developer board at http://www.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. Please refer to code_license.txt for the complete license. + +For compilation instructions or any other info please visit the development documentation at http://megaglest.org/. diff --git a/docs/readme_linux.txt b/docs/readme_linux.txt index 22b610bda..4941b7965 100644 --- a/docs/readme_linux.txt +++ b/docs/readme_linux.txt @@ -1,129 +1,115 @@ - Mega-Glest - by Titus Tscharntke and Mark Vejvoda + MegaGlest + by Titus Tscharntke and Mark Vejvoda - original Glest linux port - by Matthias Braun - -1. System requirements -Developed on Linux with glibc, little endian cpu. The game does currently not -work on big endian cpus like ppc. There are some unfinished patches floating -around the glest board, so this might improve (feel free to send me -updated/finished ppc patches). -Graphics card + OpenGL libraries that support OpenGL 1.3 and shader extensions -(=opengl 1.4 or glUseProgramObjectARB and co.) -The app has been reported to run fine on a 900Mhz Athlon box with nvidia geforce -3 graphics card. -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 -to work with the open source (ATI) DRI drivers. It has reported to run nicely -with ATIs proprietary drivers though. - - -2. Building and Installation - -2.1 Prerequesites -The game depends on some tools and libraries to be present, before you can -start compiling it. Here's a list of them: - -* normal gnu compiler and additional tools (g++ version 3.2 or later is - required at the moment) - -* perforce jam 2.5 or later (used as build tool) - ftp://ftp.perforce.com/pub/jam - -* X11 libraries +headers - http://www.x.org (or the older http://www.xfree86.org) - -* SDL 1.2.5 or later - http://www.libsdl.org - -* Xerces-C - http://xml.apache.org/xerces-c/index.html - -* OpenAL - http://www.openal.org - -* Ogg - http://www.xiph.org/ogg/vorbis - -* Vorbis - http://www.vorbis.com - -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. -At this point I'd like to thank all the authors of these helpful libraries -that made our development easy and straightforward. - -2.2 Building - -To build and install the game use the following commands - -./configure -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 - -Unfortunately there is no real installation mechanism present yet (jam install -does NOT work correctly). Please copy the executable file named "glest" and the -example linux config "glest.ini" into the directory where you extracted the -datafiles and start the game there. - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -3. Troubleshooting - -Some hints for troubleshooting. - -In General: -* Make sure you fullfill the system requirement above -* Sound is played through OpenAL you might take a look at your openal - configuration: http://supertux.lethargik.org/wiki/OpenAL_Configuration - -Compiling: -* 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 -* If the game doesn't start because of audio/sound errors: - Make sure no other application is using your soundcard. Typical problems - are the gnome/kde sound dameons esd and artsd. You can kill these 2 - daemons with - killall esd ; killall artsd -* 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 - 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 -* Fedora3 seems to have problems with the precompiled glest binaries -> compile - the application yourself -* There are some bugs related to the font code which I can't reproduce and am - unable to fix without further input. Someone can help me with this? -* The game does not work on ppc (big endian architectures) yet -* Check the forums at www.glest.org -* 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 - backtrace from a debugging enabled build (configure --enable-debug) - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -4. Contact - -Original Glest is from http://www.glest.org -Linux port by Matthias Braun with help from - Karl Robillard Mega-Glest by: - Titus Tscharntke (info@titusgames.de) - Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com ) + original Glest linux port + by Matthias Braun + +1. System requirements +Developed on Linux with glibc, little endian cpu. While MacIntel builds exist, +the game does not currently work on big endian CPUs like PPC. There are some +unfinished patches floating around the glest board, so this might improve (feel +free to send updated/finished PPC patches). +Graphics card + OpenGL libraries that support OpenGL 1.3 and shader extensions +(=OpenGL 1.4 or glUseProgramObjectARB etc.) +The app has been reported to run fine on a 900Mhz Athlon box with Nvidia GeForce +3 graphics card. +It seems that the game also runs on GeForce 2 and GeForce Mx class hardware when +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 +with ATIs proprietary drivers though. + + +2. Building and Installation + +2.1 Prerequesites +The game depends on some tools and libraries to be present, before you can +start compiling it. Here's a list of them: + +* normal GNU compiler and additional tools (g++ version 3.2 or later is + required at the moment) + +* Kitware CMake 2.8 or later (used as build tool) + +* X11 libraries +headers + http://x.org/ (or the older http://xfree86.org/) + +* SDL 1.2.5 or later + http://libsdl.org/ + +* Xerces-C + http://xerces.apache.org/xerces-c/ + +* OpenAL + http://openal.org/ + +* Ogg + http://xiph.org/ogg/vorbis/ + +* Vorbis + http://vorbis.com/ + +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. +At this point I'd like to thank all the authors of these helpful libraries +that made our development easy and straight forward. + +2.2 Building + +To build the game simply invoke the build script: + +./build-mg.sh + + +2.3 Installation + +We provide MojoSetup based installers for Linux. By default, they install to +your home directory. There are also community maintained packages available for +several distributions. Please see the forums and wiki for details. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +3. Troubleshooting + +Some hints for troubleshooting. + +In General: +* Make sure you fullfill the system requirements above +* Sound is played through OpenAL - you might need to take a look at your + configuration: http://supertux.lethargik.org/wiki/OpenAL_Configuration + +Compiling: +* If configure fails make sure you have read the Building section above + +Sound/Audio errors when starting: +* If the game doesn't start because of audio/sound errors: + Make sure no other application is using your soundcard. Typical problems are + the Gnome/KDE sound dameons esd and artsd. You can kill these daemons with + killall esd ; killall artsd +* If this doesn't solve your sound problems try to get an updated OpenAL from + http://openal.org or a newer repository provided by your distribution. + +The game complains about OpenGL1.3 not available, is missing OpenGL extensions +or works very slowly: +* Make sure your system provides for the system requirements +* Look at glxinfo and make sure the system is using the drivers you want to + use. Often the proprietary ATI or NVIDIA drivers work better, but for Intel, + mesa drivers ("glxinfo | grep -i mesa") can work, too (though slowly due to + limited abilities of these chipsets). + +The game crashes: +* 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 + +Original Glest is from http://glest.org/ +Linux port by: + Matthias Braun with help from + Karl Robillard +MegaGlest by: + Titus Tscharntke (info@titusgames.de) + Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com) diff --git a/docs/readme_windows.txt b/docs/readme_windows.txt index cf5aab390..4bc4f104e 100644 --- a/docs/readme_windows.txt +++ b/docs/readme_windows.txt @@ -6,12 +6,14 @@ 1. System requirements 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. -The app has been reported to run fine on a 900Mhz Athlon box with nvidia geforce -3 graphics card. 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 windows version should run on 32 and 64 bit versions of Windows and has been -reported to run successfully on Windows 2000 - Windows 7. +little endian CPU. Compiling using the mingw32 toolset is now possible, which +also allows for cross compiling. The game does not currently work on big endian +CPUs like PPC. There are, however, community contributed builds available for +MacIntel. The app has been reported to run fine on a 900Mhz Athlon box with +Nvidia GeForce 3 graphics card. It seems that the game also runs on GeForce 2 +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 @@ -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: * Microsoft Visual C++ Express 2008 or higher +OR +* mingw32 * 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 - http://xml.apache.org/xerces-c/index.html + http://xerces.apache.org/xerces-c/ * wxWidgets - http://www.wxwidgets.org/downloads/ + http:/wxwidgets.org/downloads/ 2.2 Building 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). -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. 2. Open the VC++ 2008 Solution file in trunk\mk\windoze called Glest.sln within @@ -48,20 +54,22 @@ in it. Rebuild All. 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 -You should now be to to just run glest_game.exe +Before running MegaGlest you must run the batchfile CopyWindowsRuntimeDlls.bat +You should now be able to just run glest_game.exe. 2.3 Installation -Unfortunately there is no real installation mechanism present yet, just run the -glest_game.exe from within the trunk\data\glest_game directory. +We provide NSIS based installation packages. By default, these will create a +system-wide installation below Program Files and setup Desktop icons for +simplified access. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 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) -Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com ) - +Mark Vejvoda (www.soft-haus.com - mark_vejvoda@hotmail.com)