shithub: qk1

ref: 02611e064eceed8d8cda8cc4d6e60f8f1833ea72
dir: /README/

View raw version
qk1 - (9) quake
===============
	- setup:
		. mk install
	- to install quake (shareware or registered):
		. mkdir $home/lib/quake/id1
		. cp /n/quakecd/id1/*.pak id1/
	- to install an expansion or compatible mod (zB rogue):
		. mkdir $home/lib/quake/rogue
		. cp /n/quakecd/rogue/*.pak $home/lib/quake/rogue
	- sound is glitchy with higher resolutions (see snd_9.c)
	- cdaudio, networking: PORTME
	- high resolutions work up to 4096x4096 (arbitrary limit in r_shared.h)
		. by default, quake uses a 8MB heap, which will be insufficient for higher
		resolutions → exit with "Hunk_Alloc: failed on ..."
			-> use -mem param, e.g.
			% qk1 -mem 24
		. resolutions under e.g. 320x240 don't work
	- don't use -winsize, -width, -height; just resize the window (bugsbugsbugs)
	- mouse is grabbed using m_windowed cvar
		. open console (~)
		. type m_windowed 1 (can autocomplete w/ tab)
		. setting saved on exit in id1/config.cfg
	- tested on 386 and amd64 only (works ok on a pentium 4)


some params useful for workarounds
----------------------------------
	-nosound
	-nostdout
	-mem %d
	(-noudp)
	(-winsize %d %d)
	(-width %d)
	(-height %d)


port notes
----------
	- based on linux/x11 code from original release
	- pr_strings: assumed 32bit pointer arithmetic: use PR_GetStr() instead of
	  dealing with it directly; may be ass
	- global cppdefotomy, removing code seen as useless for plan9
	- Sys_Warn added again for print(2) stuff in *_9.c that uses %r, kind of stupid
	since Con_Printf was often used there, and it outputs to both fd=1 and console,
	so needs fixing
	- vid_9.c: shitty, can probably improve performance a bit without screwing code
	- *printf -> *print was stupid


todo/issues
-----------
	- compile with PARANOID -> MSG_WriteByte complains about range error and
	  exits. no idea why.
	- new game while already ingame -> front falls off
		. most of the time: exits with R_RenderView: called without enough stack
		. sometimes: goes batshit on the console (->press y again and quit normally, etc.)
	- compile with BAN_TEST -> net_dgrm build fails
	- sprites/particles not scaled correctly on high resolutions
	- m_windowed 1: can still look around in frozen world when paused
	- m_windowed 1: mouse can still escape, causing glitchy mouse look
	- net_9p.c
	- cd_9.c,net_udp.c,net_dgrm.c: actuallyport
	- snd_9.c, vid_9.c: lousy
	- manpages
	- ungrab mouse when entering console or menus a la games/doom (IN_Grabm())
	- cleanse *_9.c from linux legacy
	- linking errors with -T cflag
	- fix potential fp exceptions in code rather than ignoring them?
	- sys_9.c: proper P9 use (style)
	- g '/\* FIXME'
	- port quakeworld and utilities +/- merge common code and mkmany
	- Sys_Error printing %r systematically is stupid


legal
-----
Quake, hence qk1, is licensed under the GPLv2. See COPYING for details.