joshuaskelly / quake-cli-tools

Command line tools for creating Quake content.

quake-cli-tools

quake-cli-tools is a set of command line tools for creating Quake content.

Installation

$ pip install quake-cli-tools

Tools

• pak: Add files to a PAK file.
• unpak: Extract files from a PAK file.
• wad: Add file to a WAD file.
• unwad: Extract files from a WAD file.
• bsp2wad: Create a WAD file from a BSP file.
• qmount: Mount a PAK file as a drive.
• image2spr: Create an SPR from image files.
• spr2image: Extract frames from an SPR.
• bsp2svg: Create an SVG file from a BSP file.

Building

Below is an example of how to build binaries for all tools. The out put will be placed in the dist directory.

1. Install Project Dependencies

pip install -r requirements.txt

2. Install Development Dependencies

pip install -r requirements-dev.txt

3. Build All Binaries

make build

Contributing

Have a bug fix or a new feature you'd like to see in quake-cli-tools? Send it our way! Please make sure you create an issue that addresses your fix/feature so we can discuss the contribution.

1. Fork this repo!
2. Create your feature branch:

git checkout -b features/add-cool-new-tool

3. Commit your changes:

git commit -m 'Adding must have new tool!'

4. Push the branch:

git push origin features/add-cool-new-tool

5. Submit a pull request.
6. Create an issue.

License

MIT

See the license document for the full text.