Readme: add Usage section that covers the basics

This commit is contained in:
Marco Cawthorne 2023-10-08 23:24:17 -07:00
parent f228121fd8
commit a09ae7261a
Signed by: eukara
GPG key ID: CE2032F0A2882A22
3 changed files with 14 additions and 8 deletions

View file

@ -2,9 +2,7 @@ name: Linux CI
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
tags: ['v*.*.*']
jobs:
build:
@ -31,4 +29,4 @@ jobs:
- uses: actions/upload-artifact@v3
with:
name: vmap-bin
path: vmap
path: vmap

View file

@ -2,9 +2,7 @@ name: Windows CI
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
tags: ['v*.*.*']
jobs:
@ -48,4 +46,4 @@ jobs:
- uses: actions/upload-artifact@v3
with:
name: vmap-win
path: vmap.exe
path: vmap.exe

View file

@ -19,6 +19,16 @@ A fork of q3map2, now available as a stand-alone compiler targetting [FTEQW](htt
- Support for entity key: _entsurfaceflags, so surfaces can override their surfaceflags
- Support for entity key: _entcontentflags, so brushes can override their contentflags
## Usage
BSP: `./vmap [options] dm_foobar`
VIS: `./vmap [options] -vis dm_foobar`
LIGHT: `./vmap [options] -light dm_foobar`
You want to pass `-fs_basepath /path/to/game/root` and `-game` arguments to specify where to read textures from. If you wanted to, for example, compile a map included within Nuclide's 'base' directory you'd end up with a command-line like this:
`./vmap -fs_basepath /home/user/nuclide-sdk/ -game platform -game base test_sun`
## Compiling
To compile on a standard GNU/Linux system:
`make`