mirror of
https://github.com/ioquake/ioq3.git
synced 2024-11-10 07:11:46 +00:00
some old URL and doc updates
The installer building docs should probably go somewhere else but they don't need to be in the README
This commit is contained in:
parent
c0f29642a4
commit
b7abe57d3b
3 changed files with 38 additions and 39 deletions
|
@ -119,3 +119,34 @@ ioquake3 can be developed locally. For instructions on how to do this, see [the
|
||||||
|
|
||||||
* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
|
* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
|
||||||
* Do not include issue numbers in the PR title.
|
* Do not include issue numbers in the PR title.
|
||||||
|
|
||||||
|
|
||||||
|
### Building Official Installers
|
||||||
|
|
||||||
|
This is a reminder for how official installers should be built:
|
||||||
|
|
||||||
|
* Please include the id patch pk3s in your installer, which are available
|
||||||
|
from http://ioquake3.org/patch-data/ subject to agreement to the id
|
||||||
|
EULA. Your installer shall also ask the user to agree to this EULA (which
|
||||||
|
is in the /web/include directory for your convenience) and subsequently
|
||||||
|
refuse to continue the installation of the patch pk3s and pak0.pk3 if they
|
||||||
|
do not.
|
||||||
|
|
||||||
|
* Please don't require pak0.pk3, since not everyone using the engine
|
||||||
|
plans on playing Quake 3 Arena on it. It's fine to (optionally) assist the
|
||||||
|
user in copying the file or tell them how.
|
||||||
|
|
||||||
|
* It is fine to just install the binaries without requiring id EULA agreement,
|
||||||
|
providing pak0.pk3 and the patch pk3s are not referred to or included in the
|
||||||
|
installer.
|
||||||
|
|
||||||
|
* Please include at least a libSDL2 so/dylib/dll on every platform.
|
||||||
|
|
||||||
|
* Please include an OpenAL so/dylib/dll, since every platform should be using
|
||||||
|
it by now.
|
||||||
|
|
||||||
|
* Please be prepared to alter your installer on the whim of the maintainers.
|
||||||
|
|
||||||
|
* Your installer will be mirrored to an "official" directory, thus making it
|
||||||
|
a done deal.
|
||||||
|
|
||||||
|
|
44
README.md
44
README.md
|
@ -40,12 +40,12 @@ The original id software readme that accompanied the Q3 source release has been
|
||||||
renamed to id-readme.txt so as to prevent confusion. Please refer to the
|
renamed to id-readme.txt so as to prevent confusion. Please refer to the
|
||||||
website for updated status.
|
website for updated status.
|
||||||
|
|
||||||
More documentation including a Player's Guide and Sysadmin Guide is on:
|
More documentation including a Player's Guide and Sysadmin Guide are on:
|
||||||
http://wiki.ioquake3.org/
|
https://ioquake3.org/help/
|
||||||
|
|
||||||
If you've got issues that you aren't sure are worth filing as bugs, or just
|
If you've got issues that you aren't sure are worth filing as bugs, or just
|
||||||
want to chat, please visit our forums:
|
want to chat, please visit our forums:
|
||||||
http://discourse.ioquake.org
|
https://discourse.ioquake.org
|
||||||
|
|
||||||
# Thank You:
|
# Thank You:
|
||||||
|
|
||||||
|
@ -76,9 +76,9 @@ For *nix
|
||||||
|
|
||||||
For Windows,
|
For Windows,
|
||||||
1. Please refer to the excellent instructions here:
|
1. Please refer to the excellent instructions here:
|
||||||
http://wiki.ioquake3.org/Building_ioquake3
|
https://ioquake3.org/help/building-ioquake3/
|
||||||
|
|
||||||
For Mac OS X, building a Universal Binary (x86_64, x86, ppc)
|
For macOS, building a Universal Binary (x86_64, x86, ppc)
|
||||||
1. Install MacOSX SDK packages from XCode. For maximum compatibility,
|
1. Install MacOSX SDK packages from XCode. For maximum compatibility,
|
||||||
install MacOSX10.5.sdk and MacOSX10.6.sdk.
|
install MacOSX10.5.sdk and MacOSX10.6.sdk.
|
||||||
2. Change to the directory containing this README file.
|
2. Change to the directory containing this README file.
|
||||||
|
@ -526,38 +526,6 @@ and provide players with the same Quake 3 experience they've had for years.
|
||||||
We do have graphical improvements with the new renderer, but they are off by default.
|
We do have graphical improvements with the new renderer, but they are off by default.
|
||||||
See opengl2-readme.md for more information.
|
See opengl2-readme.md for more information.
|
||||||
|
|
||||||
# Building Official Installers
|
|
||||||
|
|
||||||
We need help getting automated installers on all the platforms that ioquake3
|
|
||||||
supports. We don't necessarily care about all the installers being identical,
|
|
||||||
but we have some general guidelines:
|
|
||||||
|
|
||||||
* Please include the id patch pk3s in your installer, which are available
|
|
||||||
from http://ioquake3.org/patch-data/ subject to agreement to the id
|
|
||||||
EULA. Your installer shall also ask the user to agree to this EULA (which
|
|
||||||
is in the /web/include directory for your convenience) and subsequently
|
|
||||||
refuse to continue the installation of the patch pk3s and pak0.pk3 if they
|
|
||||||
do not.
|
|
||||||
|
|
||||||
* Please don't require pak0.pk3, since not everyone using the engine
|
|
||||||
plans on playing Quake 3 Arena on it. It's fine to (optionally) assist the
|
|
||||||
user in copying the file or tell them how.
|
|
||||||
|
|
||||||
* It is fine to just install the binaries without requiring id EULA agreement,
|
|
||||||
providing pak0.pk3 and the patch pk3s are not referred to or included in the
|
|
||||||
installer.
|
|
||||||
|
|
||||||
* Please include at least a libSDL2 so/dylib/dll on every platform.
|
|
||||||
|
|
||||||
* Please include an OpenAL so/dylib/dll, since every platform should be using
|
|
||||||
it by now.
|
|
||||||
|
|
||||||
* Please be prepared to alter your installer on the whim of the maintainers.
|
|
||||||
|
|
||||||
* Your installer will be mirrored to an "official" directory, thus making it
|
|
||||||
a done deal.
|
|
||||||
|
|
||||||
|
|
||||||
# Credits
|
# Credits
|
||||||
|
|
||||||
Maintainers
|
Maintainers
|
||||||
|
@ -567,7 +535,7 @@ Maintainers
|
||||||
* Thilo Schulz <arny@ats.s.bawue.de>
|
* Thilo Schulz <arny@ats.s.bawue.de>
|
||||||
* Tim Angus <tim@ngus.net>
|
* Tim Angus <tim@ngus.net>
|
||||||
* Tony J. White <tjw@tjw.org>
|
* Tony J. White <tjw@tjw.org>
|
||||||
* Zachary J. Slater <zachary@ioquake.org>
|
* Jack Slater <jack@ioquake.org>
|
||||||
* Zack Middleton <zturtleman@gmail.com>
|
* Zack Middleton <zturtleman@gmail.com>
|
||||||
|
|
||||||
Significant contributions from
|
Significant contributions from
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
!define RELEASE "1"
|
!define RELEASE "1"
|
||||||
!define MODDIR "q3ctc"
|
!define MODDIR "q3ctc"
|
||||||
!define PUBLISHER "The ioquake3 Team"
|
!define PUBLISHER "The ioquake3 Team"
|
||||||
!define URL "http://ioquake3.org/"
|
!define URL "https://ioquake3.org/"
|
||||||
; uncomment if the mod works without baseq3
|
; uncomment if the mod works without baseq3
|
||||||
;!define STANDALONE
|
;!define STANDALONE
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue