mirror of
https://github.com/id-Software/DOOM-3-BFG.git
synced 2024-12-11 05:01:25 +00:00
Updated README.txt with compile instructions for Linux
This commit is contained in:
parent
f57d92a1ab
commit
bf7f892d5d
1 changed files with 204 additions and 34 deletions
238
README.txt
238
README.txt
|
@ -1,18 +1,86 @@
|
|||
Doom 3 BFG Edition GPL Source Code
|
||||
==================================
|
||||
|
||||
____________________________ _____________________________________
|
||||
\______ \______ \______ \ ____ ____ _____ \_____ \______ \_ _____/ _____/
|
||||
| _/| | _/| | \ / _ \ / _ \ / \ _(__ <| | _/| __)/ \ ___
|
||||
| | \| | \| ` ( <_> | <_> ) Y Y \/ \ | \| \ \ \_\ \
|
||||
|____|_ /|______ /_______ /\____/ \____/|__|_| /______ /______ /\___ / \______ /
|
||||
\/ \/ \/ \/ \/ \/ \/
|
||||
_________________________________________
|
||||
|
||||
|
||||
RBDoom3BFG Readme - https://github.com/RobertBeckebans/RBDOOM-3-BFG
|
||||
|
||||
Thank you for downloading RBDoom3BFG.
|
||||
|
||||
|
||||
|
||||
_______________________________________
|
||||
|
||||
CONTENTS
|
||||
_______________________________
|
||||
|
||||
|
||||
|
||||
This file contains the following sections:
|
||||
|
||||
GENERAL NOTES
|
||||
LICENSE
|
||||
1) SYSTEM REQUIREMENT
|
||||
|
||||
GENERAL NOTES
|
||||
=============
|
||||
2) GENERAL NOTES
|
||||
|
||||
Game data and patching:
|
||||
-----------------------
|
||||
3) LICENSE
|
||||
|
||||
This source release does not contain any game data, the game data is still
|
||||
4) GETTING THE SOURCE CODE
|
||||
|
||||
5) COMPILING ON WIN32 WITH VISUAL C++ 2010 EXPRESS EDITION
|
||||
|
||||
6) COMPILING ON GNU/LINUX
|
||||
|
||||
7) CHANGES
|
||||
|
||||
8) FEATURES
|
||||
|
||||
9) CONSOLE VARIABLES
|
||||
|
||||
10) KNOWN ISSUES
|
||||
|
||||
11) BUG REPORTS
|
||||
|
||||
12) FUTURE PLAN
|
||||
|
||||
13) CONTRIBUTIONS
|
||||
|
||||
14) DONATIONS
|
||||
|
||||
|
||||
|
||||
___________________________________
|
||||
|
||||
1) SYSTEM REQUIREMENTS
|
||||
__________________________
|
||||
|
||||
|
||||
|
||||
Minimum system requirements:
|
||||
|
||||
CPU: 2 GHz Intel compatible
|
||||
System Memory: 512MB
|
||||
Graphics card: Any graphics card that supports Direct3D 10 and OpenGL >= 3.2
|
||||
|
||||
Recommended system requirements:
|
||||
|
||||
CPU: 3 GHz + Intel compatible
|
||||
System Memory: 1024MB+
|
||||
Graphics card: Geforce 9600 GT, ATI HD 5650 or higher.
|
||||
|
||||
|
||||
|
||||
|
||||
_______________________________
|
||||
|
||||
2) GENERAL NOTES
|
||||
______________________
|
||||
|
||||
This release does not contain any game data, the game data is still
|
||||
covered by the original EULA and must be obeyed as usual.
|
||||
|
||||
You must patch the game to the latest version.
|
||||
|
@ -21,17 +89,6 @@ Note that Doom 3 BFG Edition is available from the Steam store at
|
|||
http://store.steampowered.com/app/208200/
|
||||
|
||||
|
||||
Compiling on win32:
|
||||
-------------------
|
||||
|
||||
A project file for Microsoft Visual Studio 2010 is provided in neo\doom3.sln
|
||||
We expect the solution file is compatible with the Express releases
|
||||
|
||||
You will need the Microsoft DirectX SDK installed as well.
|
||||
If it does not reside in "C:\Program Files (x86)\Microsoft DirectX SDK (June 2010)"
|
||||
you will need to update the project files accordingly.
|
||||
|
||||
|
||||
Steam:
|
||||
------
|
||||
The Doom 3 BFG Edition GPL Source Code release does not include functionality for integrating with
|
||||
|
@ -41,7 +98,6 @@ any other Steam features.
|
|||
|
||||
Bink:
|
||||
-----
|
||||
|
||||
The Doom 3 BFG Edition GPL Source Code release does not include functionality for rendering Bink Videos.
|
||||
|
||||
|
||||
|
@ -52,28 +108,140 @@ The Doom 3 BFG Edition GPL Source Code release does not include functionality en
|
|||
of stencil shadows via the "depth fail" method, a functionality commonly known as "Carmack's Reverse".
|
||||
|
||||
|
||||
Other platforms, updated source code, security issues:
|
||||
------------------------------------------------------
|
||||
|
||||
If you have obtained this source code several weeks after the time of release,
|
||||
it is likely that you can find modified and improved versions of the engine in
|
||||
various open source projects across the internet.
|
||||
_______________________________
|
||||
|
||||
Depending what is your interest with the source code, those may be a better starting point.
|
||||
3) LICENSE
|
||||
______________________
|
||||
|
||||
|
||||
LICENSE
|
||||
=======
|
||||
|
||||
See COPYING.txt for the GNU GENERAL PUBLIC LICENSE
|
||||
|
||||
ADDITIONAL TERMS: The Doom 3 BFG Edition GPL Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU GPL which accompanied the Doom 3 BFG Edition GPL Source Code. If not, please request a copy in writing from id Software at id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
|
||||
|
||||
EXCLUDED CODE: The code described below and contained in the Doom 3 BFG Edition GPL Source Code release is not part of the Program covered by the GPL and is expressly excluded from its terms. You are solely responsible for obtaining from the copyright holder a license for such code and complying with the applicable license terms.
|
||||
|
||||
____________________________________________
|
||||
|
||||
4) GETTING THE SOURCE CODE
|
||||
___________________________________
|
||||
|
||||
This project's GitHub.net Git repository can be checked out through Git with the following instruction set:
|
||||
|
||||
> git clone https://github.com/RobertBeckebans/RBDOOM-3-BFG.git
|
||||
|
||||
|
||||
|
||||
___________________________________________________________________
|
||||
|
||||
5) COMPILING ON WIN32 WITH VISUAL C++ 2010 EXPRESS EDITION
|
||||
__________________________________________________________
|
||||
|
||||
1. Download and install the Visual C++ 2010 Express Edition.
|
||||
|
||||
2. Generate the VC10 projects using CMake by doubleclicking a matching configuration .bat file in the neo/ folder.
|
||||
|
||||
3. Use the VC10 solution to compile what you need:
|
||||
RBDOOM-3-BFG/build/RBDoom3BFG.sln
|
||||
|
||||
|
||||
__________________________________
|
||||
|
||||
6) COMPILING ON GNU/LINUX
|
||||
_________________________
|
||||
|
||||
|
||||
1. You need the following dependencies in order to compile RBDoom3BFG with all features:
|
||||
|
||||
On Debian or Ubuntu:
|
||||
|
||||
> apt-get install libsdl1.2-dev cmake
|
||||
|
||||
On Fedora
|
||||
|
||||
> yum install SDL-devel cmake
|
||||
|
||||
|
||||
3. Generate the Makefiles using Premake:
|
||||
|
||||
> cd neo/
|
||||
> ./cmake-eclipse-linux-profile.sh
|
||||
|
||||
4. Compile RBDoom3BFG targets with
|
||||
|
||||
> cd ../build
|
||||
> make
|
||||
|
||||
|
||||
___________________________________________________
|
||||
|
||||
7) CHANGES
|
||||
__________________________________________
|
||||
|
||||
// TODO
|
||||
See CHANGELOG.txt for full list of all changes.
|
||||
|
||||
|
||||
___________________________________________________
|
||||
|
||||
9) CONSOLE VARIABLES
|
||||
__________________________________________
|
||||
|
||||
// TODO
|
||||
|
||||
|
||||
___________________________________________________
|
||||
|
||||
10) KNOWN ISSUES
|
||||
__________________________________________
|
||||
|
||||
* Sound engine does not work on Linux
|
||||
* There are some issues with the binary format loaders/writers on 64 bit platforms
|
||||
|
||||
|
||||
___________________________________________________
|
||||
|
||||
11) BUG REPORTS
|
||||
__________________________________________
|
||||
|
||||
RBDoom3BFG is not perfect, it is not bug free as every other software.
|
||||
For fixing as much problems as possible we need as much bug reports as possible.
|
||||
We cannot fix anything if we do not know about the problems.
|
||||
|
||||
The best way for telling us about a bug is by submitting a bug report at our GitHub bug tracker page:
|
||||
|
||||
https://github.com/RobertBeckebans/RBDOOM-3-BFG/issues?state=open
|
||||
|
||||
The most important fact about this tracker is that we cannot simply forget to fix the bugs which are posted there.
|
||||
It is also a great way to keep track of fixed stuff.
|
||||
|
||||
If you want to report an issue with the game, you should make sure that your report includes all information useful to characterize and reproduce the bug.
|
||||
|
||||
* Search on Google
|
||||
* Include the computer's hardware and software description ( CPU, RAM, 3D Card, distribution, kernel etc. )
|
||||
* If appropriate, send a console log, a screenshot, an strace ..
|
||||
* If you are sending a console log, make sure to enable developer output:
|
||||
|
||||
RBDoom3BFG.exe +set developer 1 +set logfile 2
|
||||
|
||||
NOTE: We cannot help you with OS-specific issues like configuring OpenGL correctly, configuring ALSA or configuring the network.
|
||||
|
||||
|
||||
|
||||
|
||||
____________________________________________________________________________________
|
||||
|
||||
12) Code License Exceptions - The parts that are not covered by the GPL:
|
||||
_______________________________________________________________________
|
||||
|
||||
|
||||
EXCLUDED CODE: The code described below and contained in the Doom 3 BFG Edition GPL Source Code release
|
||||
is not part of the Program covered by the GPL and is expressly excluded from its terms.
|
||||
You are solely responsible for obtaining from the copyright holder a license for such code and complying with the applicable license terms.
|
||||
|
||||
|
||||
JPEG library
|
||||
-----------------------------------------------------------------------------
|
||||
neo/renderer/jpeg-6/*
|
||||
neo/libs/jpeg-6/*
|
||||
|
||||
Copyright (C) 1991-1995, Thomas G. Lane
|
||||
|
||||
|
@ -103,7 +271,7 @@ better release of the library.
|
|||
|
||||
zlib library
|
||||
---------------------------------------------------------------------------
|
||||
neo/framework/zlib/*
|
||||
neo/libs/zlib/*
|
||||
|
||||
Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler
|
||||
|
||||
|
@ -245,7 +413,7 @@ MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
|
|||
|
||||
Timidity
|
||||
---------------------------------------------------------------------------
|
||||
doomclassic/timidity/*
|
||||
neo/libs/timidity/*
|
||||
|
||||
Copyright (c) 1995 Tuukka Toivonen
|
||||
|
||||
|
@ -255,3 +423,5 @@ If you'd like to continue hacking on TiMidity, feel free. I'm
|
|||
hereby extending the TiMidity license agreement: you can now
|
||||
select the most convenient license for your needs from (1) the
|
||||
GNU GPL, (2) the GNU LGPL, or (3) the Perl Artistic License.
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue