ngunix/README

 _   _ ____  _   _ _   _ _____  __
| | / |___ \| | | | | / |_ _\ \/ /
| |/  |_  | | | | | |/  || | \  / 
|  /| | |_| | |_| |  /| || | /  \ 
|_/ |_|____/ \___/|_/ |_|___/_/\_\
                                                                               
This is a novelty engine rendering in software mode, aka on your CPU.
It uses standard X11 functions, so aside from that no dependencies are necessary.
For sound, please get the Open Sound System running.

It can run Q1 with all its fancy waterwarping, too.

************
  Features
************

- Full software-rendered 3D-Engine
- Colored lighting, 8-bit, 16-bit and 24-bit dithered lightmaps
- Particle and (non-clipped) decal system
- Coronas with support for light styles
- Model blob shadows
- Sound pitch variation
- Server side QCVM gamecode with enhanced extensions (such as file i/o, traceboxes...)
- Texture filtering on level textures
- Water translucency and refractions
- Low detail modes
- Distance fog
- Music playback via DUMB, X Multimedia System and FModEx if desired

*************
  Compiling
*************

For a debug build (larger and slower) issue 'make'.
For a release build (smaller and faster) issue 'make build_release'.

*********
  Notes
*********

- Carried over soundfixes from reQuiem
- Main sound is done via OSS, not ALSA - aoss will most likely not work
- The input is 'not good' right now
- Originally based on engoo by leileilol
- If you want to run Q1 with it, launch it with -data id1.
  You can get a particles.spr file for Q1 here: http://euksy.oldtimes-software.com/files/NGUNIX/particle.spr

*********
  Plans
*********

- Menu system done primarily using CSQC
- HUD system done primarily using CSQC
- Make the bots less Q1 specific, controllable via SSQC
- Ship with a game directory that can be used as a base and torn apart for any use
- Ship with a scratch QC base and the new engine extensions