mirror of
https://github.com/yquake2/xatrix.git
synced 2024-11-10 06:42:22 +00:00
Modernize the README.
Convert to markdown and follow the same style as the yquake2 main repository. Use it's resources were appropriate.
This commit is contained in:
Yamagi
parent
31b1c2d92b
commit
69faeb6777
2 changed files with 67 additions and 50 deletions
50
README
50
README
|
|
@ -1,50 +0,0 @@
|
|||
This is a bugfixed version of id Software's Quake II missionpack
|
||||
"The Reckoning", developed by Xatrix Software. Hundred bugs were
|
||||
fixed, this version should run much more stable than the the old
|
||||
SDK version. It should be used with the "Yamagi Quake II Client",
|
||||
but may work with other clients too. For more information visit
|
||||
http://www.yamagi.org/quake2.
|
||||
|
||||
Installation for FreeBSD, Linux and OpenBSD:
|
||||
--------------------------------------------
|
||||
1. Type "make" or "gmake" to compile the game.so.
|
||||
2. Create a subdirectory xatrix/ in your quake2 directory.
|
||||
3. Copy pak0.pak and videos/ from the the Reckoning CD to
|
||||
the newly created directory xatrix/.
|
||||
4. Copy release/game.so to xatrix/.
|
||||
5. Start the game with "./quake2 +set game xatrix"
|
||||
|
||||
Installation for OS X:
|
||||
----------------------
|
||||
1. Create a subdirectory xatrix/ in your quake2 directory.
|
||||
2. Copy pak0.pak and videos/ from the the Reckoning CD to
|
||||
the newly created directory xatrix/.
|
||||
3. Copy game.so from the zip-archive to xatrix/.
|
||||
4. Start the game with "quake2 +set game xatrix"
|
||||
|
||||
If you want to compile 'xatrix' for OS X from source, please take a
|
||||
look at the "Installation" section of the README of the Yamagi Quake II
|
||||
client. In the same file the integration into an app-bundle is
|
||||
explained.
|
||||
|
||||
Installation for Windows:
|
||||
-------------------------
|
||||
1. Create a subdirectory xatrix\ in your quake2 directory.
|
||||
2. Copy pak0.pak and videos\ from the the Reckoning CD to
|
||||
the newly created directory xatrix\.
|
||||
3. Copy game.dll from the zip-archive to xatrix/.
|
||||
4. Start the game with "quake2.exe +set game xatrix"
|
||||
|
||||
If you want to compile 'xatrix' for Windows from source, please take a
|
||||
look at the "Installation" section of the README of the Yamagi Quake II
|
||||
client. There's descripted how to setup the build environment.
|
||||
|
||||
=======================================================================
|
||||
|
||||
FAQ
|
||||
---
|
||||
|
||||
The sounds after starting "xship" aka "Stroggos Freightener" are
|
||||
distorted and hurting my ears.
|
||||
- Yeah, the quality of the sound samples is very low. Not much
|
||||
we can do about it...
|
||||
67
README.md
Normal file
67
README.md
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
# The Reckoning for Yamagi Quake II
|
||||
|
||||
The Reckoning for Yamagi Quake II is a bugfixed version of the first
|
||||
official missionpack released for Quake II. It's based upon the Quake
|
||||
II SDK source code and licensed under GPL version 2:
|
||||
|
||||
* [LICENSE](https://github.com/yquake2/xatrix/blob/master/LICENSE)
|
||||
|
||||
Hundreds of bugs were fixed and some convenience features added. The
|
||||
missionpack is intended to be used with Yamagi Quake II, but it's also
|
||||
fully backward compatible with the last Quake II pointrelease 3.20 and
|
||||
may work with other source ports.
|
||||
|
||||
Officially supported operating systems are:
|
||||
|
||||
* FreeBSD
|
||||
* Linux
|
||||
* Windows
|
||||
|
||||
Beside theses The Reckoning for Yamagi Quake II has community support
|
||||
for MacOS and most other unixoid operating systems, including NetBSD,
|
||||
OpenBSD and Solaris.
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
The Reckoning for Yamagi Quake II is a community driven project and
|
||||
lives from community involvement. Please report bugs in our issue
|
||||
tracker:
|
||||
|
||||
* [Issue Tracker](https://github.com/yquake2/xatrix/issues)
|
||||
|
||||
We are always open to code contributions, no matter if they are small
|
||||
bugfixes or bigger features. However, Yamagi Quake II is a conservative
|
||||
project with big focus on stability and backward compatibility. We don't
|
||||
accept breaking changes. When in doubt please open an issue and ask if a
|
||||
contribution in welcome before putting too much work into it. Open a
|
||||
pull request to submit code:
|
||||
|
||||
* [Pull Requests](https://github.com/yquake2/xatrix/pulls)
|
||||
|
||||
Also have a look at our contributors guide:
|
||||
|
||||
* [Contributors Guide](https://github.com/yquake2/yquake2/blob/master/doc/080_contributing.md).
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
Yamagi Quake II has rather extensive documentation covering all relevant
|
||||
areas from installation and configuration to package building. Have a
|
||||
look at the documentation index:
|
||||
|
||||
* [Documentation Index](https://github.com/yquake2/yquake2/blob/master/doc/010_index.md)
|
||||
|
||||
|
||||
## Releases
|
||||
|
||||
The Reckoning for Yamagi Quake II releases at an irregular schedule. The
|
||||
official releases with source code tarballs and prebuild Windows
|
||||
binaries can be found at the homepage:
|
||||
|
||||
* [Homepage](https://www.yamagi.org/quake2/)
|
||||
|
||||
Our CI builds **unsupported** Linux, MacOS and Windows binaries at every
|
||||
commit. The artifacts can be found here:
|
||||
|
||||
* [Github Actions](https://github.com/yquake2/xatrix/actions)
|
||||
Loading…
Reference in a new issue