Updated docs and hopefully made them more user-friendly
This commit is contained in:
zicodxx
parent
8ca0637f99
commit
1b41f70e36
|
|
@ -6,6 +6,7 @@ SConstruct: Removing svnmicro as micro numbering option since SVN-revisions will
|
|||
SConstruct, main/multi.h, main/net_udp.c, main/net_udp.h, main/vers_id.h: Make Version-check for UDP also cover Micro-versions; Making sure versioning will act same way as conf.h for MacOS
|
||||
main/game.c: Add to help how to send a message to a specific player in Multiplayer
|
||||
main/songs.c: Adding a Failsafe to Songs-reading so it will not accidentially read over current Array-boundaries
|
||||
INSTALL.TXT, README.TXT: Updated docs and hopefully made them more user-friendly
|
||||
|
||||
20100221
|
||||
--------
|
||||
|
|
|
|||
225
INSTALL.txt
225
INSTALL.txt
|
|
@ -3,155 +3,136 @@ Compiling D1X-Rebirth Sourcecode
|
|||
This file describes how to compile D1X-Rebirth from Source.
|
||||
|
||||
|
||||
Requirements
|
||||
Requirements:
|
||||
=============
|
||||
|
||||
1.
|
||||
C/C++ compiler (gcc/g++)
|
||||
2.
|
||||
SCons
|
||||
3.
|
||||
SDL(-devel)
|
||||
4.
|
||||
PhysFS(-devel)
|
||||
5.
|
||||
GLU/GL
|
||||
6.
|
||||
NASM (optional for Assembler-based Texture-mapper in non-OpenGL Build)
|
||||
1. C/C++ compiler (gcc/g++)
|
||||
2. SCons (to compile in *NIX/Win32) / XCode (to compile on MacOS)
|
||||
3. SDL(-devel)
|
||||
4. PhysFS(-devel)
|
||||
5. GLU/GL
|
||||
6. NASM (optional for Assembler-based Texture-mapper in non-OpenGL Build)
|
||||
7. SDL_mixer(-devel) (+ dependencies) for external music support
|
||||
|
||||
|
||||
Compiling
|
||||
Compiling:
|
||||
==========
|
||||
|
||||
For Mac OS X, an Xcode project is available (requires Xcode 2.1 or later). Xcode includes the compiler and OpenGL.
|
||||
*NIX:
|
||||
-----
|
||||
Type 'scons' to compile the source.
|
||||
You can also give additional options like 'scons sdl_only=1 asm=1'. See 'scons -h' for available options.
|
||||
To install, use 'scons install' but remember to use all your options as well or SCons will re-compile and
|
||||
install without any options given to prior compiling. However it's STRONGLY recommended NOT to use the
|
||||
'install' argument but to create a package for your Linux distribution or operating system. 'install' will
|
||||
compile the resulting binary (d1x-rebirth-gl/sdl) to /usr/local/bin/ by default so to uninstall, just
|
||||
delete the binary.
|
||||
|
||||
The SConstruct file provides various options to compile this program.
|
||||
To get a full list of all available commands, type scons -h within the Source directory.
|
||||
MacOS:
|
||||
------
|
||||
For Mac OS X, an Xcode project is available (requires Xcode 2.1 or later). Xcode includes the compiler
|
||||
and OpenGL. For Mac OS 9, an MPW Makefile is available. MPW includes the compiler. For the sources to
|
||||
compile, they will need to be made into text files using a typecode changing program, if they were
|
||||
downloaded outside of Mac OS 9 (including Mac OS X). This will also need to be done after any Terminal
|
||||
command (diff, svn update etc) edits the source files.
|
||||
SCons also works on MacOS, but it's recommended to use XCode instead.
|
||||
Note that there are ready-to-go packages on http://www.dxx-rebirth.com
|
||||
|
||||
To compile the source, type:
|
||||
|
||||
scons
|
||||
Win32:
|
||||
------
|
||||
Use the SCons way like described in the *NIX-instructions from an MSYS/MinGW environment. However you will
|
||||
not need to use 'install' but just drag the resulting binary to your Descent-folder.
|
||||
Note that there are ready-to-go packages on http://www.dxx-rebirth.com
|
||||
|
||||
|
||||
If you wish to add additional commands, just add them to the scons command.
|
||||
Example:
|
||||
Needed files:
|
||||
=============
|
||||
|
||||
scons sdl_only=1 asm=1
|
||||
Since D1X-Rebirth is a Sourceport of the Descent-Engine you will need the Game-Content data files to run
|
||||
the game. You don't own the full game, yet?
|
||||
Just visit GOOD OLD GAMES via:
|
||||
http://www.gog.com/en/gamecard/descent_1_descent_2/pp/fc074d501302eb2b93e2554793fcaf50b3bf7291
|
||||
and download it for a very low price! DRM-FREE!
|
||||
|
||||
Following files are needed to run the game:
|
||||
descent.hog
|
||||
descent.pig
|
||||
|
||||
For the Mac CD-ROM, the data files will need to be installed from the CD using a Mac system earler than
|
||||
OS X. Classic will work. If you know of any other way, please tell me at chris at icculus.org.
|
||||
|
||||
Note that the above files must be lowercase if you use an operating system with case-sensitive file management.
|
||||
|
||||
|
||||
To install the compiled binary to your system (/usr/local/bin/), type (as root):
|
||||
Where to put these files:
|
||||
=========================
|
||||
|
||||
scons install
|
||||
*NIX
|
||||
----
|
||||
The Sharepath (/usr/local/share/games/d1x-rebirth/ by default - if not reconfigured via SCons) or
|
||||
~/.d1x-rebirth or
|
||||
another directory specified by -hogdir via d1x.ini
|
||||
|
||||
You can also add the ‘install’ command while compile-time. SCons will compile and install the binary right after that.
|
||||
MacOS
|
||||
-----
|
||||
Same directory as where the binary is located or
|
||||
another directory specified by -hogdir via d1x.ini
|
||||
|
||||
For Windows and Mac however, it is instead recommended to manually drag the program to the folder containing the Descent data or use the -hogdir option when running.
|
||||
Win32
|
||||
-----
|
||||
Same directory as where the binary is located
|
||||
|
||||
|
||||
To clean up the source directory after installation, type:
|
||||
Optional files:
|
||||
===============
|
||||
|
||||
scons -c
|
||||
D1X-Rebirth is expandable. You can add additional content to the game.
|
||||
|
||||
HiRes Briefing Images and Fonts:
|
||||
--------------------------------
|
||||
Available at http://www.dxx-rebirth.com/download/dxx/res/d1xrdata.zip
|
||||
To add those, copy the ZIP file to the D1X-Rebirth directory or - on *NIX systems -
|
||||
into Sharepath or ~/.d1x-rebirth.
|
||||
The Mac data files are already hires.
|
||||
|
||||
Needed files
|
||||
Custom/AddOn missions:
|
||||
----------------------
|
||||
Those can be found on several websites. Add them to the game by copying them to subdirectory
|
||||
‘missions/’. They can also go in subdirectories of 'missions/', unlike with the original version.
|
||||
|
||||
Since D1X-Rebirth is a Sourceport of the Descent1-Engine you will need the Game-Content data files to run the game.
|
||||
Language Packs:
|
||||
---------------
|
||||
German translation: http://www.dxx-rebirth.com/download/dxx/res/D1XBDE01.zip
|
||||
Copy the txb-files to the Sharepath (non-Mac OS *NIX)/program directory (otherwise).
|
||||
|
||||
You don't own the full game, yet?
|
||||
Just visit GOOD OLD GAMES via:
|
||||
http://www.gog.com/en/gamecard/descent_1_descent_2/pp/fc074d501302eb2b93e2554793fcaf50b3bf7291
|
||||
and download it for a very low price! DRM-FREE!
|
||||
|
||||
For non-Mac OS *NIX all files need to be copied to the Sharepath, which is (if not specified with the SCons ‘sharepath’-variable) /usr/local/share/games/d1x-rebirth/. For all other systems the files go in the folder containing the application, as with the original version. For *NIX systems (including Mac OS X) there is also the option of placing them in a folder you specify using d1x.ini (see end).
|
||||
|
||||
Following files are needed to run the game:
|
||||
|
||||
descent.hog
|
||||
descent.pig
|
||||
|
||||
These files should be located on the Descent1 CD-Rom.
|
||||
On non-Mac OS *NIX, those files must be lowercase. The PC version data files need to be patched to version 1.4a (which is not necessary for the GOG.com-version).
|
||||
|
||||
The above files may go in a subdirectory called 'Data'.
|
||||
|
||||
There is a patch suitable for *NIX systems (diff-files) available at:
|
||||
http://www.dxx-rebirth.com/download/dxx/res/descent1_patch14a-linux.tar.gz
|
||||
|
||||
Patching can also be done from Windows/DOS using the DOS 1.4a-patch of Parallax, that will patch a common Descent1 installation.
|
||||
DOS 1.4a patch: http://www.dxx-rebirth.com/download/dxx/res/descent1_patch14a.exe
|
||||
|
||||
For the Mac CD-ROM, the data files will need to be installed from the CD using a Mac system earler than OS X. Classic will work. If you know of any other way, please tell me at chris at icculus.org. No patch is needed for these data files.
|
||||
|
||||
To play the Multiplayer levelset “Total Chaos”, also copy the files
|
||||
|
||||
chaos.hog
|
||||
chaos.msn
|
||||
|
||||
to the subdirectory ‘missions/’. These files should also be located on the Descent1 CD.
|
||||
|
||||
|
||||
Optional files
|
||||
|
||||
D1X-Rebirth is expandable. You can add additional content to the game.
|
||||
|
||||
Supported content:
|
||||
|
||||
*
|
||||
HiRes Briefing Images and Fonts
|
||||
Available at:
|
||||
http://www.dxx-rebirth.com/download/dxx/res/d1xrdata.zip
|
||||
To add those, copy the ZIP file to the D1X-Rebirth directory or - on *NIX systems - into Sharepath or ~/.d1x-rebirth.
|
||||
HiRes Briefings and fonts will be used automatically.
|
||||
The Mac data files are already hires.
|
||||
|
||||
*
|
||||
Custom/AddOn missions
|
||||
Those can be found on several websites. Add them to the game by copying them to subdirectory ‘missions/’. They can also go in subdirectories of 'missions/', unlike with the original version.
|
||||
|
||||
*
|
||||
Language Packs
|
||||
German translation: http://www.dxx-rebirth.com/download/dxx/res/D1XBDE01.zip
|
||||
Copy the txb-files to the Sharepath (non-Mac OS *NIX)/program directory (otherwise). Will be activated automatically
|
||||
|
||||
*
|
||||
Custom Music (like MP3 or OGG)
|
||||
Custom Music can be played either used via the Jukebox by specifying the path to your music in the Sound Options menu.
|
||||
Please note that all custom music has to be in 44Khz format.
|
||||
Custom Music (like MP3 or OGG):
|
||||
-------------------------------
|
||||
Custom Music can be played via the Jukebox by specifying the path to your music in the Sound Options menu.
|
||||
Please note that all custom music has to be in 44Khz format.
|
||||
|
||||
|
||||
Launching the program
|
||||
=====================
|
||||
|
||||
On Windows and Mac OS, simply double-click the program.
|
||||
MacOS
|
||||
-----
|
||||
Simply double-click "D1X-Rebirth".
|
||||
|
||||
After compiling and installing, the program can be launched on *NIX systems with the command
|
||||
Win32
|
||||
-----
|
||||
Doubleclick d1x-rebirth-gl.exe
|
||||
|
||||
d1x-rebirth-gl
|
||||
*NIX
|
||||
----
|
||||
After compiling and installing, the program can be launched with the command:
|
||||
d1x-rebirth-gl
|
||||
or - if it has been compiled with SCons parameter ‘sdl_only=1’:
|
||||
d1x-rebirth-sdl
|
||||
|
||||
or - if it has been compiled with SCons parameter ‘sdl_only=1’ -
|
||||
|
||||
d1x-rebirth-sdl
|
||||
|
||||
To see a full list of available command-line options append ‘-h’, ‘-?’ to the command or refer file
|
||||
|
||||
d1x.ini
|
||||
|
||||
|
||||
On *NIX systems, the game will create a config-directory. On non-Mac *NIX systems this will be called ‘.d1x-rebirth’ and reside in the Home directory of the user.
|
||||
On Mac OS X this directory will be called ‘D1X Rebirth’, in the Preferences folder in the user’s Library.
|
||||
On all other systems (Windows and Mac OS 9) the application directory is used.
|
||||
It is used to read/save
|
||||
|
||||
*
|
||||
Configuration files
|
||||
*
|
||||
Pilot profiles and Savegames
|
||||
*
|
||||
Demos
|
||||
*
|
||||
Screenshots
|
||||
*
|
||||
d1x.ini for parsing command-line arguments (the config directory is searched first, then the directory containing the program)
|
||||
|
||||
Thanks to PhysFS, on *NIX systems data files can also go in here. In addition, demos could be moved from the config directory to the Sharepath/program directory to make them viewable by other users.
|
||||
To see a full list of available command-line options append ‘-h’, ‘-?’ to the command or refer file
|
||||
d1x.ini
|
||||
|
||||
|
||||
Appendix
|
||||
|
||||
http://DXX-Rebirth.com
|
||||
========
|
||||
http://DXX-Rebirth.com
|
||||
|
|
|
|||
92
README.txt
92
README.txt
|
|
@ -5,68 +5,64 @@ __________/ D1X-Rebirth /
|
|||
http://www.dxx-rebirth.com
|
||||
|
||||
|
||||
0. Introduction
|
||||
0. Introduction:
|
||||
================
|
||||
|
||||
This version of D1X is based on livna’s release of d1x-1.43.
|
||||
|
||||
I spend much time to improve the Sourcecode, tried to fix bugs in there and added some improvements. It is the goal of DXX-Rebirth to keep these games alive and the result is a very stable version of the Descent I port - called D1X-Rebrith.
|
||||
|
||||
I hope you enjoy the game as you did when you played it the first time.
|
||||
|
||||
If you have something to say about my release, feel free to contact me at zicodxx [at] yahoo [dot] de
|
||||
|
||||
- zico 20070407
|
||||
This version of D1X is based on livna’s release of d1x-1.43.
|
||||
I spend much time to improve the Sourcecode, tried to fix bugs in there and added some improvements.
|
||||
It is the goal of DXX-Rebirth to keep these games alive and the result is a very stable version of
|
||||
the Descent I port - called D1X-Rebrith.
|
||||
I hope you enjoy the game as you did when you played it the first time.
|
||||
If you have something to say about my release, feel free to contact me at zicodxx [at] yahoo [dot] de
|
||||
|
||||
|
||||
1. Features
|
||||
1. Features:
|
||||
============
|
||||
|
||||
D1X-Rebirth has every little feature you already may know from the DOS Version 1.4a of Descent and much more.
|
||||
D1X-Rebirth has every little feature you already may know from the DOS Version 1.4a of Descent and much more.
|
||||
|
||||
For example:
|
||||
|
||||
*
|
||||
High resoution Fonts and briefing screens
|
||||
*
|
||||
High resolutions with full Cockpit support
|
||||
*
|
||||
Widescreen options
|
||||
*
|
||||
Joystick and Mouse support
|
||||
*
|
||||
Possibility to run AddOn levels
|
||||
*
|
||||
Network support
|
||||
*
|
||||
Record and play demos
|
||||
*
|
||||
OpenGL functions and Eyecandy like Trilinear filtering, Transparency effects etc.
|
||||
*
|
||||
MP3/OGG/AIF/WAV Jukebox Support
|
||||
*
|
||||
everything else you know from DESCENT
|
||||
*
|
||||
... and much more!
|
||||
For example:
|
||||
* High resoution Fonts and briefing screens
|
||||
* High resolutions with full Cockpit support
|
||||
* Support for ALL resolutions - including Widescreen formats
|
||||
* Joystick and Mouse support
|
||||
* Possibility to run AddOn levels
|
||||
* LAN- and Online-gaming support
|
||||
* Record and play demos
|
||||
* OpenGL functions and Eyecandy like Trilinear filtering, Transparency effects etc.
|
||||
* MP3/OGG/AIF/WAV Jukebox Support
|
||||
* everything else you know from DESCENT
|
||||
* ... and much more!
|
||||
|
||||
|
||||
2. Installation
|
||||
2. Installation:
|
||||
================
|
||||
|
||||
See INSTALL.txt.
|
||||
See INSTALL.txt.
|
||||
|
||||
|
||||
3. Multiplayer
|
||||
3. Multiplayer:
|
||||
===============
|
||||
|
||||
D1X-Rebirth supports Multiplayer over (obsoleted) IPX and UDP/IP.
|
||||
Please note that UDP/IP generally supports more features of D1X-Rebirth and uses Packet Loss Prevention while IPX is mainly meant to play together with non-D1X-Rebirth games.
|
||||
Using UDP/IP works over LAN and Internet. By default, each game communicates over UDP-Port 42424. This can be changed via the menus while creating a game and manually join a game, command-line argument or D1X.INI. To successfully host a game online, make sure UDP-Port 42424 (or otherwise if specified correctly) is opened on your Router/Firewall. Clients do not need to open any ports.
|
||||
The game also supports IPv6 if built in while compiling and should be backwards compatible to IPv4 builds as good as possible.
|
||||
D1X-Rebirth supports Multiplayer over (obsoleted) IPX and UDP/IP.
|
||||
Please note that UDP/IP generally supports more features of D1X-Rebirth and uses Packet Loss Prevention while
|
||||
IPX is mainly meant to play together with non-D1X-Rebirth games.
|
||||
Using UDP/IP works over LAN and Internet. By default, each game communicates over UDP-Port 42424. This can be
|
||||
changed via the menus while creating a game and manually join a game, command-line argument or D1X.INI. To
|
||||
successfully host a game online, make sure UDP-Port 42424 (or otherwise if specified correctly) is opened on
|
||||
your Router/Firewall. Clients do not need to open any ports.
|
||||
The game also supports IPv6 if built in while compiling and should be backwards compatible to IPv4 builds
|
||||
as good as possible.
|
||||
|
||||
|
||||
4. Legal stuff
|
||||
4. Legal stuff:
|
||||
===============
|
||||
|
||||
See COPYING.txt
|
||||
See COPYING.txt
|
||||
|
||||
|
||||
5. Contact
|
||||
5. Contact:
|
||||
===========
|
||||
|
||||
http://www.dxx-rebirth.com/
|
||||
zicodxx [at] yahoo [dot] de
|
||||
http://www.dxx-rebirth.com/
|
||||
zicodxx [at] yahoo [dot] de
|
||||
|
|
|
|||
Loading…
Reference in a new issue