docs: move spike's additions to man pages
This commit is contained in:
Eric Wasylishen
parent
1a96a90dab
commit
3daea6f33a
35
README.md
35
README.md
|
|
@ -1,35 +1,3 @@
|
|||
# tyrutils-ericw-spike
|
||||
|
||||
[](https://travis-ci.org/ericwa/tyrutils-ericw)
|
||||
[](https://ci.appveyor.com/project/EricWasylishen/tyrutils-ericw)
|
||||
|
||||
##Added features:
|
||||
###qbsp:
|
||||
- parser: string escape verification.
|
||||
- arg: `-wrbrushes`: (bspx) Includes a list of brushes for brush-based collision
|
||||
- arg: `-wrbrushesonly`: `-wrbrushes` combined with `-noclip` argument
|
||||
- arg: `-notex`: Write only placeholder textures, to depend upon replacements
|
||||
- field: `_phong`: 1 enables phong shading with a default `_phong_angle` of 89 (softens columns etc).
|
||||
- field: `_phong_angle`: enables phong shading with a custom angle. Adjacent faces with normals this many degrees apart (or less) will be smoothed
|
||||
- field: `_lmscale`: Generates an LMSHIFT bspx lump for use by a light util. Note that both scaled and unscaled lighting will normally be used.
|
||||
|
||||
###light:
|
||||
- worldfield: `_lightmap_scale`: Forces all surfaces+submodels to use this specific lightmap scale. Removes `LMSHIFT` field.
|
||||
- arg: `-lmscale`: Equivelent to `_lightmap_scale` worldspawn key.
|
||||
- arg: `-bspxlit`: Writes rgb data into the bsp itself.
|
||||
- arg: `-bspx`: Writes both rgb and directions data into the bsp itself.
|
||||
- arg: `-novanilla`: Fallback scaled lighting will be omitted. Standard grey lighting will be ommitted if there are coloured lights. Implies `-bspxlit`. `-lit` will no longer be implied by the presence of coloured lights.
|
||||
|
||||
### bspinfo:
|
||||
- displays bspx lumps.
|
||||
|
||||
### vis:
|
||||
- no changes
|
||||
|
||||
|
||||
Updated 2015-07-13
|
||||
|
||||
|
||||
## tyrutils-ericw (v0.15.4)
|
||||
- Website: http://ericwa.github.io/tyrutils-ericw
|
||||
- Maintainer: Eric Wasylishen (AKA ericw)
|
||||
|
|
@ -41,6 +9,9 @@ Updated 2015-07-13
|
|||
- Author: Kevin Shanahan (AKA Tyrann)
|
||||
- Email: tyrann@disenchant.net
|
||||
|
||||
[](https://travis-ci.org/ericwa/tyrutils-ericw)
|
||||
[](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:
|
||||
|
|
|
|||
12
man/light.1
12
man/light.1
|
|
@ -84,6 +84,14 @@ Set the number of samples to use for "_sunlight_penumbra" and "_sunlight2" (sunl
|
|||
The "\\b" escape sequence toggles red text on/off, you can use this in any strings in the map file. e.g. "message" "Here is \\bsome red text\\b..."
|
||||
.IP "\fB\-surflight_dump\fP"
|
||||
Saves the lights generated by surfacelights to a "mapname-surflights.map" file.
|
||||
.IP "\fB\-lmscale n\fP"
|
||||
Equivelent to "_lightmap_scale" worldspawn key.
|
||||
.IP "\fB\-bspxlit\fP"
|
||||
Writes rgb data into the bsp itself.
|
||||
.IP "\fB\-bspx\fP"
|
||||
Writes both rgb and directions data into the bsp itself.
|
||||
.IP "\fB\-novanilla\fP
|
||||
Fallback scaled lighting will be omitted. Standard grey lighting will be ommitted if there are coloured lights. Implies "-bspxlit". "-lit" will no longer be implied by the presence of coloured lights.
|
||||
|
||||
.SH "MODEL ENTITY KEYS"
|
||||
|
||||
|
|
@ -188,6 +196,8 @@ Lower values can avoid unwanted dirt on arches, pipe interiors, etc.
|
|||
.IP "\fB""_gamma"" ""n""\fP"
|
||||
Adjust brightness of final lightmap. Default 1, >1 is brighter, <1 is darker.
|
||||
|
||||
.IP "\fB""_lightmap_scale"" ""n""\fP"
|
||||
Forces all surfaces+submodels to use this specific lightmap scale. Removes "LMSHIFT" field.
|
||||
|
||||
.SS "Model Entity Keys"
|
||||
|
||||
|
|
@ -229,7 +239,7 @@ Enables phong shading on faces of this model with a custom angle. Adjacent faces
|
|||
Consider setting "_anglescale" to "1" on lights or worldspawn to make the effect of phong shading more visible.
|
||||
Use the "-phongdebug" command-line flag to save the interpolated normals to the lightmap for previewing (use "r_lightmap 1" or "gl_lightmaps 1" in your engine to preview.)
|
||||
|
||||
|
||||
|
||||
.SH "LIGHT ENTITY KEYS"
|
||||
|
||||
.PP
|
||||
|
|
|
|||
11
man/qbsp.1
11
man/qbsp.1
|
|
@ -74,6 +74,12 @@ times on large maps and should generate better bsp trees as well.
|
|||
From txqbsp-xt, thanks rebb. (default 1024, 0 to disable)
|
||||
.IP "\fB\-hexen2\fP"
|
||||
Generate a hexen2 bsp.
|
||||
.IP "\fB\-wrbrushes\fP"
|
||||
(bspx) Includes a list of brushes for brush-based collision.
|
||||
.IP "\fB\-wrbrushesonly\fP"
|
||||
"-wrbrushes" combined with "-noclip" argument.
|
||||
.IP "\fB\-notex\fP"
|
||||
Write only placeholder textures, to depend upon replacements.
|
||||
|
||||
.SH "SPECIAL TEXTURE NAMES"
|
||||
.PP
|
||||
|
|
@ -176,6 +182,11 @@ information needed by vis to compute the potentially visible set (PVS) for the
|
|||
map/bsp. So you will also need a vis util capable of processing the PRT2 file
|
||||
format.
|
||||
|
||||
.SH "Model Entity Keys"
|
||||
|
||||
.IP "\fB""_lmscale"" ""n""\fP"
|
||||
Generates an LMSHIFT bspx lump for use by a light util. Note that both scaled and unscaled lighting will normally be used.
|
||||
|
||||
.SH MAP COMPATIBILITY
|
||||
In addition to standard Quake 1 .map files, TyrUtils QBSP is compatible with:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue