Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.47 KB

BUILD.md

File metadata and controls

29 lines (16 loc) · 1.47 KB

Building AudioQuake

Please ensure you've read and followed the steps in the main BUILD.md file first.

If you want to build AudioQuake separately, and have the development environment set up already, it's as simple as running:

  • Mac: ./build-audioquake.py

  • Windows: python build-audioquake.py

What does build-audioquake.py do?

  1. Converts the user manual, sound legend appendix (so it can be referred to separately), development manuals, README and LICENCE files from Markdown to HTML.

  2. Uses the Quake map tools to compile the AGRIP maps (which were originally made with QuArK for all three different variants of play: Quake, Open Quartz and the "high-contrast" textures from Prototype.wad.

    In Quake, textures are compiled into the ".bsp" files directly from the texture ".wad" files. If this is the first time you're building AudioQuake

  3. Runs PyInstaller to "freeze" the Python code (so that it runs like a normal executable, without requiring Python on the player's computer) and combine it with...

    • The engine, gamecode and map compilation tools (built using the "build-giants.py" script in the root directory).

    • The Level Description Language tools (from the "ldl" subdirectory).

    • The AudioQuake game assets (sounds etc.) from this directory.

    • The Remote console client written in Python, also from this directory.