nzp-team
/
quakec
mirror of https://github.com/nzp-team/quakec.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The QuakeC repository for NZ:P, all platforms.
838 Commits 11 Branches 1 Tag 3.7 MiB
Python 78.6%
Shell 12.6%
Batchfile 8.8%
Go to file
cypress 244f21bf79
Misc. QuakeC workflow improvements (#73) 
* REPO: Update progs.src standards, consolidate both ssqc to one src file

* FTEQCC: Optimize SSQC with -O3

* PROGS: Globally disable useless fastarrays on standard

* TOOLS: Consolidate Linux and macOS build scripts into one

* Remove some debug stuff

* ACTIONS: Change build script reference name
 		2024-06-16 08:41:13 -07:00
.github/workflows Misc. QuakeC workflow improvements (#73) 2024-06-16 08:41:13 -07:00
bin SERVER: Use generated hash table for model path conversion 2024-01-06 17:33:52 -05:00
progs Misc. QuakeC workflow improvements (#73) 2024-06-16 08:41:13 -07:00
source Misc. QuakeC workflow improvements (#73) 2024-06-16 08:41:13 -07:00
tools Misc. QuakeC workflow improvements (#73) 2024-06-16 08:41:13 -07:00
.DS_Store CLIENT: Change "+sprint" bind to "impulse 23" 2024-05-24 19:10:13 -07:00
.gitignore SERVER: Use generated hash table for model path conversion 2024-01-06 17:33:52 -05:00
LICENSE Initial commit 2022-02-08 13:42:28 -05:00
README.md SERVER: Use generated hash table for model path conversion 2024-01-06 17:33:52 -05:00

README.md

Nazi Zombies: Portable QuakeC

About

This is the QuakeC portion of the NZ:P source code. QuakeC is responsible for most game-related code such as weapon logic, ai, and Perks. You can read more about QuakeC on the Wikipedia page. NZ:P makes use of CSQC for PC/FTE.

Project Structure

Here is a brief explanation for each of the (sub)directories in this repository:

  • bin: Command line binaries for FTEQCC + the ini configuration file.
  • progs: *.src files, a list of QuakeC source files each platform is dependent on.
  • source:
    • client: FTE-exclusive CSQC, used for the HUD, achievements, and other server->client requests.
    • server: Game code relevant to all platforms, contains most expected logic.
    • shared: Definitions for weapon stats and some utility functions shared by both the client and server.
  • tools: Build scripts to compile the QuakeC into .dat and .lno files.

Updating

While it's usually recommended to stay on the QuakeC version provided with your build of NZ:P, you may want to update it to the current development builds to test new features and changes. To do this, navigate to the Releases page and follow the instructions there for downloading and installing.

Building (Beginner Friendly)

There are no prerequisites or dependancies needed to build QuakeC other than a working Windows, macOS, or Linux-based machine.

Before you can build the NZ:P QuakeC, you must either download this repository (easy) or clone it (for developers).

Python 3.7 or above is required to execute additional required components for hash table generation. You can install the required modules with pip -r requirements.txt pointing to the provided file.

To build, simply navigate to the tools directory and run the qc-compiler-* script for your platform. If unfamiliar with executing shell (.sh) scripts on Linux systems, give this itsFOSS article a read.

After having done this, a build directory will have been created, and inside of it will be more directories named after every platform. Copy the contents of the platform directories into your nzp game directory. (Example: For PSP, copy progs.dat and progs.lno from standard/handheld to PSP/GAME/nzportable/nzp).