100 lines
3.5 KiB
Markdown
100 lines
3.5 KiB
Markdown
## ericw-tools
|
|
- Website: http://ericwa.github.io/ericw-tools
|
|
- Maintainer: Eric Wasylishen (AKA ericw)
|
|
- Email: ewasylishen@gmail.com
|
|
|
|
### Original tyurtils:
|
|
|
|
- Website: http://disenchant.net
|
|
- Author: Kevin Shanahan (AKA Tyrann)
|
|
- Email: tyrann@disenchant.net
|
|
|
|
[](https://ci.appveyor.com/project/EricWasylishen/ericw-tools)
|
|
|
|
## About
|
|
|
|
ericw-tools is a branch of Tyrann's quake 1 tools, focused on
|
|
adding lighting features, mostly borrowed from q3map2. There are a few
|
|
bugfixes for qbsp as well. Original readme follows:
|
|
|
|
A collection of command line utilities for building Quake levels and working
|
|
with various Quake file formats. I need to work on the documentation a bit
|
|
more, but below are some brief descriptions of the tools.
|
|
|
|
Included utilities:
|
|
|
|
- qbsp - Used for turning a .map file into a playable .bsp file.
|
|
|
|
- light - Used for lighting a level after the bsp stage. This util was previously known as TyrLite
|
|
|
|
- vis - Creates the potentially visible set (PVS) for a bsp.
|
|
|
|
- bspinfo - Print stats about the data contained in a bsp file.
|
|
|
|
- bsputil - Simple tool for manipulation of bsp file data
|
|
|
|
See the doc/ directory for more detailed descriptions of the various
|
|
tools capabilities. See changelog.md for a brief overview of recent
|
|
changes or https://github.com/ericwa/ericw-tools for the full changelog and
|
|
source code.
|
|
|
|
## Compiling
|
|
|
|
Dependencies: Embree 3.0+, TBB (TODO: version?), groff (for building manuals)
|
|
|
|
### Ubuntu
|
|
|
|
```
|
|
sudo apt install libembree-dev libtbb-dev groff cmake build-essential g++
|
|
git clone --recursive https://github.com/ericwa/ericw-tools
|
|
cd ericw-tools
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
```
|
|
|
|
### Windows
|
|
|
|
TODO: updated instructions
|
|
|
|
### macOS 10.15
|
|
|
|
```
|
|
brew install embree tbb
|
|
git clone --recursive https://github.com/ericwa/ericw-tools
|
|
cd ericw-tools
|
|
mkdir build
|
|
cd build
|
|
cmake .. -GXcode -DCMAKE_PREFIX_PATH="$(brew --prefix embree);$(brew --prefix tbb)"
|
|
```
|
|
|
|
## Credits
|
|
|
|
- Kevin Shanahan (AKA Tyrann) for the original [tyrutils](http://disenchant.net/utils)
|
|
- id Software (original release of these tools is at https://github.com/id-Software/quake-tools)
|
|
- rebb (ambient occlusion, qbsp improvements)
|
|
- q3map2 authors (AO, sunlight2, penumbra, deviance are from [q3map2](https://github.com/TTimo/GtkRadiant/tree/master/tools/quake3/q3map2))
|
|
- Spike (hexen 2 support, phong shading, various features)
|
|
- MH (surface lights based on MHColour)
|
|
- mfx, sock, Lunaran (testing)
|
|
- Thanks to users at [func_msgboard](http://www.celephais.net/board/forum.php) for feedback and testing
|
|
|
|
## License
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
Builds using Embree are licensed under GPLv3+ for compatibility with the
|
|
Apache license.
|