aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 19 insertions, 12 deletions
diff --git a/README b/README
index ab96322..0d50d1a 100644
--- a/README
+++ b/README
@@ -6,7 +6,7 @@
| |_| |
| |
`---------- http://ioquake3.org --------'
-
+
The intent of this project is to provide a baseline Quake 3 which may be used
for further development. Some of the major features currently implemented are:
@@ -27,6 +27,7 @@ for further development. Some of the major features currently implemented are:
* HTTP/FTP download redirection (using cURL)
* Multiuser support on Windows systems (user specific game data
is stored in "%APPDATA%\Quake3")
+ * PNG support
* Many, many bug fixes
The map editor and associated compiling tools are not included. We suggest you
@@ -62,7 +63,7 @@ For Mac OS X, building a Universal Binary
XCode 2.2 and newer.
2. Change to the directory containing this README file.
3. Run './make-macosx-ub.sh'
- 4. Copy the resulting ioquake3.app in /build/release-darwin-ub to your
+ 4. Copy the resulting ioquake3.app in /build/release-darwin-ub to your
/Applications/ioquake3 folder.
Installation, for *nix
@@ -154,7 +155,7 @@ New cvars
cl_guidServerUniq - makes cl_guid unique for each server
cl_cURLLib - filename of cURL library to load
sv_dlURL - the base of the HTTP or FTP site that
- holds custom pk3 files for your server
+ holds custom pk3 files for your server
New commands
video [filename] - start video capture (use with demo command)
@@ -215,7 +216,7 @@ cl_guid Support
If cl_guidServerUniq is non-zero (the default), then this value is also
pseudo-unique for each server a client connects to (based on IP:PORT of
- the server).
+ the server).
The purpose of cl_guid is to add an identifier for each player on
a server. This value can be reset by the client at any time so it's not
@@ -223,7 +224,7 @@ cl_guid Support
your mod's game code:
1) improve logging to allow statistical tools to index players by more
than just name
- 2) granting some weak admin rights to players without requiring passwords
+ 2) granting some weak admin rights to players without requiring passwords
Using HTTP/FTP Download Support (Server)
You can enable redirected downloads on your server even if it's not
@@ -248,7 +249,7 @@ Using HTTP/FTP Download Support (Server)
Server operators who are concerned about potential "leeching" from their
HTTP servers from other ioquake3 servers can make use of the HTTP_REFERER
that ioquake3 sets which is "ioQ3://{SERVER_IP}:{SERVER_PORT}". For,
- example, Apache's mod_rewrite can restrict access based on HTTP_REFERER.
+ example, Apache's mod_rewrite can restrict access based on HTTP_REFERER.
Using HTTP/FTP Download Support (Client)
Simply setting cl_allowDownload to 1 will enable HTTP/FTP downloads
@@ -261,7 +262,7 @@ Using HTTP/FTP Download Support (Client)
When ioquake3 is built with USE_CURL_DLOPEN=1 (default on some platforms),
it will use the value of the cvar cl_cURLLib as the filename of the cURL
- library to dynamically load.
+ library to dynamically load.
Multiuser Support on Windows systems
On Windows, all user specific files such as autogenerated configuration,
@@ -271,19 +272,19 @@ Multiuser Support on Windows systems
On NT-based such as Windows XP, this is usually a directory named:
"C:\Documents and Settings\%USERNAME%\Application Data\Quake3\"
- Windows 95, Windows 98, and Windows ME will use a directory like:
+ Windows 95, Windows 98, and Windows ME will use a directory like:
"C:\Windows\Application Data\Quake3"
in single-user mode, or:
"C:\Windows\Profiles\%USERNAME%\Application Data\Quake3"
- if multiple logins have been enabled.
+ if multiple logins have been enabled.
In order to access this directory more easily, the installer may create a
Shortcut which has its target set to:
"%APPDATA%\Quake3\"
This Shortcut would work for all users on the system regardless of the
- locale settings. Unfortunately, this environment variable is only
+ locale settings. Unfortunately, this environment variable is only
present on Windows NT based systems.
-
+
You can revert to the old single-user behaviour by setting the fs_homepath
cvar to the directory where ioquake3 is installed. For example:
ioquake3.exe +set fs_homepath "c:\ioquake3"
@@ -294,7 +295,7 @@ SDL Keyboard Differences
keyboard behaviour than the original Quake3 clients.
* "Caps Lock" and "Num Lock" can not be used as normal binds since they
- do not send a KEYUP event until the key is pressed again.
+ do not send a KEYUP event until the key is pressed again.
* SDL > 1.2.9 does not support disabling "Dead Key" recognition.
In order to send "Dead Key" characters (e.g. ~, ', `, and ^), you
@@ -311,6 +312,12 @@ SDL Keyboard Differences
annoying to use on many non-US keyboards. In response, an additional
toggleConsole bind has been added on the key combination Shift-Esc.
+PNG support
+ ioquake3 supports the use of PNG (Portable Network Graphic) images as
+ textures. It should be noted that the use of such images in a maps will
+ result in missing placeholder textures where the map is used with the id
+ Quake 3 client or earlier versions of ioquake3.
+
------------------------------------------------------------- Contributing -----
Please send all patches to bugzilla (https://bugzilla.icculus.org), or join the