vmap/README.md

64 lines
2.2 KiB
Markdown
Raw Normal View History

2023-10-09 03:21:07 +00:00
# vmap
A fork of q3map2, now available as a stand-alone compiler targetting [FTEQW](https://www.fteqw.org/)
## Compiler Changes
- Improved High-Dynamic-Range lightmaps
- Support for our patchDef2WS and patchDef3WS curved surfaces in the BSP compiler, allowing for 4-way texture blended patches.
- Reads individual material scripts (.mat) instead of large .shader files
- Surfaces are aware which env_cubemap ents they belong to
- light_surface entity support, so you don't have to write map specific materials to override texture light properties
- Handles Half-Life styled point lights, including zhlt_lightflags
- Handles Half-Life styled light_environment entities
- New material keys: vmap_lightLinear, vmap_lightLinearFade
- Support for target-less spotlights
- Explicit support for func_detail, func_detail_illusionary
- Support for misc_prefab (including other .map files)
- vmap_remapMaterial/q3map_remapShader can carry over surface flags now
- Support for entity key: _entsurfaceflags, so surfaces can override their surfaceflags
- Support for entity key: _entcontentflags, so brushes can override their contentflags
2020-12-05 11:23:45 +00:00
## Compiling
2021-06-02 12:54:27 +00:00
To compile on a standard GNU/Linux system:
2023-10-09 03:21:07 +00:00
`make`
2021-06-02 12:54:27 +00:00
2023-10-09 03:21:07 +00:00
On BSD you should probably use GNU make right now.
Clang should also be supported, pass `CC=clang` if you want to use it.
2021-06-02 12:54:27 +00:00
2022-06-19 15:51:01 +00:00
On NT you'll have to jump through a lot more hoops, here's the gist:
1. MSYS2: https://www.msys2.org/
2023-10-09 03:21:07 +00:00
2. in the msys2 shell, enter `pacman -S --needed base-devel git unzip mingw-w64-$(uname -m)-{toolchain,make,minizip-git}`
2022-06-19 15:51:01 +00:00
3. boot into the Mingw64 shell, don't use the stock MSYS2 shell
4. run make and it should build everything, in theory
**Please don't contact us about helping you build it on Windows. This is a development tool. This is provided AS-IS.**
2020-12-05 11:23:45 +00:00
## Dependencies
2021-06-07 06:45:47 +00:00
* GNU make
* gcc-core
2021-08-05 04:19:54 +00:00
* gcc-c++
2023-10-09 03:21:07 +00:00
* glib2-devel
* libxml2-devel
* libjpeg8-devel
2023-10-09 03:21:07 +00:00
* libpng-devel
* minizip-devel
2020-12-05 11:23:45 +00:00
## Support
2022-06-19 15:51:01 +00:00
**As mentioned before, if you need help with this: you're on your own.**
2021-08-04 14:55:07 +00:00
2023-10-09 03:21:07 +00:00
## Special Thanks
The original q3map/2 developers:
- id Software
- Splash Damage
- ydnar
- GtkRadiant team and contributors
- NetRadiant team and contributors
vmap developers:
- Vera Visions, L.L.C.
- Spike
- Joshua Ashton
- Slartibarty