Change 'vvm' to 'vvmtool' output, add Contributing section

This commit is contained in:
Marco Cawthorne 2021-08-09 13:37:51 +02:00
parent 74e5f22c76
commit 773c3484a0
3 changed files with 37 additions and 23 deletions

View File

@ -3,15 +3,15 @@ override CXXFLAGS+= -Wall -fsigned-char
default: all
all: vvm
all: vvmtool
clean:
-$(RM) vvm vvm.o
-$(RM) vvmtool vvm.o
%.o : %.cpp
$(CXX) -o $@ -c $<
vvm: vvm.o
$(CXX) -o vvm $^
vvmtool: vvm.o
$(CXX) -o vvmtool $^
vvm.o: vvm.cpp vvm.h util.h

View File

@ -4,15 +4,15 @@ CXX=i686-w64-mingw32-g++
default: all
all: vvm.exe
all: vvmtool.exe
clean:
-$(RM) vvm.exe vvm.w32.o
-$(RM) vvmtool.exe vvm.w32.o
%.w32.o : %.cpp
$(CXX) -o $@ -c $<
vvm.exe: vvm.w32.o
$(CXX) -o vvm.exe $^ -static -static-libgcc -static-libstdc++
vvmtool.exe: vvm.w32.o
$(CXX) -o vvmtool.exe $^ -static -static-libgcc -static-libstdc++
vvm.w32.o: vvm.cpp vvm.h util.h

View File

@ -3,15 +3,14 @@
This is the exporter for our extended model format (**VVM**).
It can export both **standard IQM files** and our **extended format** for use in **FTEQW**.
It can export both **standard IQM files** and our **extended format called VVM** for use in **FTEQW**.
It's based off Lee Salzman's iqm tool.
**These days, you can find an upgraded version of this tool inside the
[FTE SRC](https://sourceforge.net/p/fteqw/code/HEAD/tree/), that has become
much more than an iqm exporter and links against more dependencies.**
**These days, you can find an upgraded version of this tool that supports loads more formats in the
[FTE SRC](https://sourceforge.net/p/fteqw/code/HEAD/tree/), however links against more dependencies**
*For those reasons, we are preserving our version of the original, extended tool here.*
*For those reasons, we are preserving our version of the original, extended tool here. This is the version that shipped with The Wastes' SDK in 2018.*
It will be updated if we make changes to our format, those will also be pushed upstream to FTE's general purpose model exporter tool.
@ -36,6 +35,31 @@ Some features that our extended specification (VVM) has to offer:
**NOTE: Using any of the VVM features is not supported in any engine other than FTEQW**
The tool's output will let you know if you're outputting an IQM compatible file or not.
# Building
Make sure you have a C++ compiler installed and issue:
```make```
There's a Makefile for mingw cross-compilation as well.
# Usage
Please read the `vvm.txt` file included in this repository for more information.
# Contributing
If you're looking for bug-fixes to the existing tool, stay here and post issues
and send pull requests if you happen to find bugs!
If you want more specialized features, support for more output formats and the like
those should be handled by the tool in [FTE SRC](https://sourceforge.net/p/fteqw/code/HEAD/tree/) as that
specializes in that sort of thing.
Any bugs that get fixed here will be checked against the above tool as well.
# History
In 2016 when we had our first prototype of The Wastes, we started out using DPM for
toolchain related reasons and quickly migrated to IQM. However we needed a better
@ -58,16 +82,6 @@ in conjunction with the FTEQW builtins that'd later be exposed to the game-logic
However, the initial extensions to the IQM format in FTE were designed by us; and this
is the exporter that was used to make our game.
# Building
Make sure you have a C++ compiler installed and issue:
```make```
# Usage
Please read the `vvm.txt` file included in this repository for more information.
# Notes
Extra resources, such as the pre-release files we shared on inside3d.com: