worldspawn/README.md

# ![WorldSpawn Logo](icon.png) WorldSpawn
The worlds most opinionated fork of QER.

The editor we use at Vera Visions to create BSP levels.
It was forked from NetRadiant in 2018 and was a result of necessity.

We wanted to move away from a proprietary toolchain that had technical issues the developer would not ever get back to us about, so we ended up here.

Use it if you actually want to use the features listed below - note that they require a modified engine as our BSP format is different from standard idTech 3 BSP.
You will not be able to make levels compatible with other games and engines.

There's plenty of other editors for the first-party id Tech games.

![Screenshot](docs/screen.jpg)

## Editor Changes
- All texture coordinates use the Valve 220 format for compatibility with WorldCraft exported .map files
- Integration with our material system (goodbye .shader files)
- Support for vertex-color/alpha editing of patches using our new fixed patch format, allowing technologies such as 4-way texture blending and whatever your designers can imagine.
- Lots of bug fixes, like the 'ghost-ent' bug, which places dummy ents at the center of your map which somehow had flown other peoples radar for 20+ years
- Simplified build system, so less dependencies!
- Support for VVM/IQM model format in the BSP compiler
- Support for High-Dynamic-Range lightmaps in the BSP compiler
- Support for Cubemap aware surfaces in the BSP compiler
- Support for our patchDef2WS and patchDef3WS curved surfaces in the compiler

## Compiling
To compile on a standard GNU/Linux system:
`LDFLAGS=-ldl gmake -j $(nproc)`

For BSD systems you'll have to point CFLAGS to whereever your package headers are installed.
gtkgtlext-1.0 is notorious for using both include and lib/gtkgtlext-1.0/include for headers. Yes.

Clang should also be supported, pass CC=clang and CXX=clang++ if you want to use it.

We don't work on NT. You're on your own with that one.

## Dependencies
* gcc-c++
* gtk2-devel
* gtkglext-devel
* libxml2-devel
* libjpeg8-devel
* minizip-devel

## Support
If you need help with this, you're better off using an alternative editor.
Compatibility is not a priority here.
README: mention dependencies as well as a screenie 2021-06-05 20:16:22 +00:00			`# ![WorldSpawn Logo](icon.png) WorldSpawn`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00			`The worlds most opinionated fork of QER.`

			`The editor we use at Vera Visions to create BSP levels.`
README: Clarify and fix typo 2021-06-05 20:18:59 +00:00			`It was forked from NetRadiant in 2018 and was a result of necessity.`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00
README: Clarify and fix typo 2021-06-05 20:18:59 +00:00			`We wanted to move away from a proprietary toolchain that had technical issues the developer would not ever get back to us about, so we ended up here.`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00
README: mention dependencies as well as a screenie 2021-06-05 20:16:22 +00:00			`Use it if you actually want to use the features listed below - note that they require a modified engine as our BSP format is different from standard idTech 3 BSP.`
			`You will not be able to make levels compatible with other games and engines.`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00
Create README.md 2020-12-05 11:23:45 +00:00			`There's plenty of other editors for the first-party id Tech games.`

README: mention dependencies as well as a screenie 2021-06-05 20:16:22 +00:00			`![Screenshot](docs/screen.jpg)`

			`## Editor Changes`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00			`- All texture coordinates use the Valve 220 format for compatibility with WorldCraft exported .map files`
			`- Integration with our material system (goodbye .shader files)`
			`- Support for vertex-color/alpha editing of patches using our new fixed patch format, allowing technologies such as 4-way texture blending and whatever your designers can imagine.`
README: mention dependencies as well as a screenie 2021-06-05 20:16:22 +00:00			`- Lots of bug fixes, like the 'ghost-ent' bug, which places dummy ents at the center of your map which somehow had flown other peoples radar for 20+ years`
			`- Simplified build system, so less dependencies!`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00			`- Support for VVM/IQM model format in the BSP compiler`
			`- Support for High-Dynamic-Range lightmaps in the BSP compiler`
			`- Support for Cubemap aware surfaces in the BSP compiler`
README: mention dependencies as well as a screenie 2021-06-05 20:16:22 +00:00			`- Support for our patchDef2WS and patchDef3WS curved surfaces in the compiler`
Create README.md 2020-12-05 11:23:45 +00:00
			`## Compiling`
README: address building instructions 2021-06-02 12:54:27 +00:00			`To compile on a standard GNU/Linux system:`
			`LDFLAGS=-ldl gmake -j $(nproc)`
Create README.md 2020-12-05 11:23:45 +00:00
README: address building instructions 2021-06-02 12:54:27 +00:00			`For BSD systems you'll have to point CFLAGS to whereever your package headers are installed.`
			`gtkgtlext-1.0 is notorious for using both include and lib/gtkgtlext-1.0/include for headers. Yes.`

			`Clang should also be supported, pass CC=clang and CXX=clang++ if you want to use it.`

			`We don't work on NT. You're on your own with that one.`
Create README.md 2020-12-05 11:23:45 +00:00
README: mention dependencies as well as a screenie 2021-06-05 20:16:22 +00:00			`## Dependencies`
			`* gcc-c++`
			`* gtk2-devel`
			`* gtkglext-devel`
			`* libxml2-devel`
			`* libjpeg8-devel`
			`* minizip-devel`

Create README.md 2020-12-05 11:23:45 +00:00			`## Support`
README: address building instructions 2021-06-02 12:54:27 +00:00			`If you need help with this, you're better off using an alternative editor.`
Don't force maximize the mainframe. 2021-06-02 18:37:42 +00:00			`Compatibility is not a priority here.`