Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joshuaskelly/quake-cli-tools

Command line tools for creating Quake content.
https://github.com/joshuaskelly/quake-cli-tools

command-line-tool quake video-game

Last synced: 3 months ago
JSON representation

Command line tools for creating Quake content.

Host: GitHub
URL: https://github.com/joshuaskelly/quake-cli-tools
Owner: joshuaskelly
License: mit
Created: 2019-09-10T20:17:45.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-01-15T19:53:57.000Z (10 months ago)
Last Synced: 2024-07-12T10:28:25.157Z (4 months ago)
Topics: command-line-tool, quake, video-game
Language: Python
Homepage:
Size: 43 KB
Stars: 69
Watchers: 6
Forks: 10
Open Issues: 20
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-quake - quake-cli-tools - A set of command line tools for creating Quake content. (Mapping / QuakeWorld)

README

# [![quake-cli-tools](https://raw.githubusercontent.com/joshuaskelly/quake-cli-tools/master/.media/logo.svg?sanitize=true)](https://github.com/JoshuaSkelly/quake-cli-tools)

# quake-cli-tools

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)]() [![PyPI version](https://badge.fury.io/py/quake-cli-tools.svg)](https://pypi.python.org/pypi/quake-cli-tools) [![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg)](https://discord.gg/KvwmdXA)

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

## Installation
```sh
$ 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
```sh
pip install -r requirements.txt
```

2. Install Development Dependencies
```sh
pip install -r requirements-dev.txt
```

3. Build All Binaries
```sh
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:
```sh
git checkout -b features/add-cool-new-tool
```
3. Commit your changes:
```sh
git commit -m 'Adding must have new tool!'
```
4. Push the branch:
```sh
git push origin features/add-cool-new-tool
```
5. Submit a pull request.
6. Create an [issue](https://github.com/joshuaskelly/wick/issues/new).

## License
MIT

See the [license](./LICENSE) document for the full text.