mirror-games/glest-source
1
0
Fork 0
mirror of https://github.com/glest/glest-source.git synced 2025-02-24 03:32:35 +01:00
Code Issues Projects Releases Wiki Activity

Some README updates

Browse Source
This commit is contained in:
Tom Reynolds 2013-12-26 18:37:35 +01:00
parent 533b1f0bfe
commit 7d562e0bd4
3 changed files with 44 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/README.compiling-linux.txt
View File

@ -12,7 +12,7 @@
Developed on Linux with glibc, little endian CPU. While MacIntel builds exist
(for some versions of the game), MegaGlest does not currently work on big
endian CPUs like PPC (though some unfinished patches for vanilla Glest float
around on the forums, e.g. https://forum.megaglest.org/index.php?topic=1426#).
around on the forums, e.g. http://forum.megaglest.org/?topic=1426#).
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -81,8 +81,11 @@ start compiling it:
* libdl
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.
NOTE: We have produced a script that tries to install build dependencies on many
Linux distros. The script is located in mk/linux/setupBuildDeps.sh
If CMake reports that it cannot find some of the libraries, make sure that you
also have the ...-dev(el) packages installed that some distributions provide.
At this point we would like to thank all the authors of these helpful libraries
who made our development easy and straight forward.
@ -94,8 +97,6 @@ To build the game simply invoke the build script:
./build-mg.sh
*NOTE: We have produced a script that tries to install build dependencies
on many Linux distros. The script is located in mk/linux/setupBuildDeps.sh
2.3 Installation
@ -119,7 +120,7 @@ In General:
configuration: http://supertux.lethargik.org/wiki/OpenAL_Configuration
Compiling:
* If configure fails make sure you have read the Building section above
* If CMake fails make sure you have read all of section 2.1 above.
Sound/Audio errors when starting:
* If the game doesn't start because of audio/sound errors:
@ -132,15 +133,19 @@ Sound/Audio errors when starting:
The game complains about OpenGL 1.3 not available, is missing OpenGL extensions
or works very slowly:
* 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 (but slowly since these
GPUs are lacking on hardware acceleration support).
use. If you have a NVIDIA or AMD/ATI graphics card then consider using the
proprietary drivers (where available), which usually provide much better
performance than the open source drivers most distributions use by default.
Most Intel graphics chips use an open source driver on Linux, based on Mesa
("glxinfo | grep -i mesa"). This hardware is much slower than any dedicated
graphics cards produced during the past few years. The same holds true for
AMD APUs, the graphics chips embedded into AMD processors.
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)
* It would be nice if you could report any 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)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -154,7 +159,7 @@ The game crashes:
http://wiki.megaglest.org/
* Forums
http://forums.megaglest.org/
http://forum.megaglest.org/
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -181,5 +186,5 @@ Linux port by:
Please also refer to the copyright file.
On Debian systems please find license information in:
On Debian GNU/Linux systems please find license information in:
/usr/share/common-licenses

27
docs/README.compiling-windows.txt
View File

@ -13,15 +13,16 @@ Developed on Windows with Microsoft Visual C++ 2010 Express (free version),
little endian CPU. Compiling using the mingw32 toolset is experimental, which
also allows for cross compiling.
On debian systems please find license information in: /usr/share/common-licenses
On Debian GNU/Linux systems please find license information in:
/usr/share/common-licenses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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:
To build the game, the following tools and libraries must be present:
* Microsoft Visual C++ Express 2010
OR
@ -46,9 +47,9 @@ And many more.
2.2 Building
To build and install the game use the following steps:
To build and install the game proceed as follows:
Option A) (recommended) Automatic Building through commandline:
Option A) (recommended) Automated build on the command line:
1. Open a command prompt and navigate to the root folder where you have acquired the source code.
@ -64,28 +65,28 @@ Option A) (recommended) Automatic Building through commandline:
7. megaglest.exe
Option B) USing VC++ IDE:
Option B) Using VC++ IDE:
1. Download the dependencies archive listed above and decompress its contents
into the 'source' directory (where you see glest_game, g3d_viewer, etc).
This should create a subdirectory called "win32_deps" with many files and
subdirectories in it.
2. Open the VC++ 2010 Solution file in trunk\mk\windoze called Glest-2010.sln within
the Visual C++ IDE.
2. Start the Visual C++ 2010 IDE and open the solution file:
\mk\windoze\Glest-2010.sln
3. Right Click on the top level Glest node in Solution Explorer and select
3. Right Click on the top level 'Glest' node in Solution Explorer and select
'Rebuild All'.
If you had no errors all binaries will be created in trunk\data\glest_game.
Before running MegaGlest you must run the CopyWindowsRuntimeDlls_2010.bat batch.
You should now be able to just run glest_game.exe.
If you had no errors all binaries will be created in \data\glest_game.
Before running MegaGlest you must run CopyWindowsRuntimeDlls_2010.bat.
You should now be able to just run megaglest.exe.
2.3 Installation
We provide NSIS based installation packages. By default, these will create a
system-wide installation below Program Files and setup Desktop icons for
system-wide installation below %ProgramFiles% and setup Desktop icons for
simplified access. User specific configuration will be stored within the
directory tree the %AppData% environment variable points to.

20
docs/README.txt
View File

@ -24,7 +24,7 @@
1. System requirements
Hardware requirements:
* 6th generation x86 CPU with 1.5 GHz or better
* >= 6th generation x86 CPU with 1.5 GHz or better
(modern CPU series with at least two cores of at least 1.5 Ghz recommended)
* 1.0 GB RAM
(2.0 GB recommended)
@ -42,16 +42,17 @@ Software requirements:
* A file archiving utility which provides a command line interface and can
decompress 7-zip archives
The MegaGlest Team currently provides builds and Installers for Linux and
The MegaGlest Team currently provides builds and installers for Linux and
Windows. The Linux version is available in 32 and 64 bit variants which have
been reported to run on Ubuntu 8.04 to 13.10, various versions of Debian,
OpenSuSE 11.1 to 11.3, and many other distributions. The Windows version runs
OpenSuSE 11.1 to 13.1, and many other distributions. The Windows version runs
on 32 and 64 bit variants of Windows and has been reported to run on Windows
versions up to and including Windows 7.
versions up to and including Windows 8.1.
There are also packages available for several Linux and BSD distributions and
OS X, maintained by these distributions or the wider MegaGlest community.
Please see the website, forums and wiki for details.
Please see the MegaGlest website, forums and wiki, as well as the package
directories these distributions provide for details.
Graphics hardware and drivers:
Current dedicated Nvidia and ATI hardware with up to date vendor-supplied
@ -63,8 +64,8 @@ many current and legacy GPUs, and may help with the proprietary drivers'
shortcomings.
Next to standard dedicated gaming video cards, MegaGlest also runs fine on most
integrated Intel GMA, Nvidia and ATI GPUs, but you will feel an urge to reduce
visual effects.
integrated Intel GMA, Nvidia and AMD/ATI APUs, but you will feel an urge to
reduce visual effects. See http://faq.megaglest.org for more hints.
To run MegaGlest in headless mode, neither video nor audio hardware and driver
support are neccessary. For a good user experience, please ensure your system
@ -242,6 +243,7 @@ megaglest --headless-server-mode => start a headless server, the first
connecting user will manage it
megaglest --client ServerIp => start game connecting to a server
For a complete list, run: megaglest --help
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -269,14 +271,14 @@ their own by reading up on available documentation before getting in touch.
- Post to the forums:
If you are reporting a bug, please be sure to read the bug reporting guide.
http://forums.megaglest.org
http://forum.megaglest.org
- Contact us on IRC:
Network: irc.freenode.net
Channel: #megaglest
Or use the webchat at http://chat.megaglest.org/
On debian systems please find license information in:
On Debian GNU/Linux systems please find license information in:
/usr/share/common-licenses/GPL
/usr/share/common-licenses/GPL-2
/usr/share/common-licenses/GPL-2+