ericw-tools/README.md

57 lines
2.4 KiB
Markdown

## tyrutils-ericw (v0.15.4)
- Website: http://ericwa.github.io/tyrutils-ericw
- Maintainer: Eric Wasylishen (AKA ericw)
- Email: ewasylishen@gmail.com
### Original tyurtils:
- Website: http://disenchant.net
- Author: Kevin Shanahan (AKA Tyrann)
- Email: tyrann@disenchant.net
[![Build Status](https://travis-ci.org/ericwa/tyrutils-ericw.svg?branch=master)](https://travis-ci.org/ericwa/tyrutils-ericw)
[![Build status](https://ci.appveyor.com/api/projects/status/7lpdcy7l3e840u70?svg=true)](https://ci.appveyor.com/project/EricWasylishen/tyrutils-ericw)
tyrutils-ericw 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.txt for a brief overview of recent
changes or https://github.com/ericwa/tyrutils-ericw for the full changelog and
source code.
## 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