README

WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!!

THIS IS NOT THE ORIGINAL VAVOOM SOURCE CODE. IT IS HEAVILY
MODIFIED, MAY HAVE NEW BUGS, AND ALTERED GAMEPLAY!

PLEASE, DON'T SEND BUG REPORTS TO THE ORIGINAL AUTHORS!

Ketmar Dark // Invisible Vector
ketmar@ketmar.no-ip.org

WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!!

k8vavoom is the fork of the excellent DooM sourceport Vavoom. It features
three unique lightning systems, one based on lightmaps (like Quake), one
with DooM3-style lighting, and one based on shadowmaps. Please note that
k8vavoom is not a carbon copy of Vavoom, so full backward compatibility
should not be expected.

DON'T FORGET TO CHECK "OPTIONS" MENU,
YOU WILL FIND ALOT OF INTERESTING THINGS THERE!


## SOUNDFOUNTS

you can put SF2 from GZDoom in ~/.k8vavoom/soundfonts directory, and it
will be autoloaded.
actually, any SF2/DLS dropped into this directory will be autoloaded.
if you don't like GZDoom sound font, you can use the one from this post:
https://forums.duke4.net/topic/6973-sc-55-soundfont-huge-update/
it is quite big, but sounds more like Roland SC-55 (as the name implies).

if that soundfont is too big for you, you may try a new Miracle one:
https://www.doomworld.com/forum/topic/111665
it also sounds good, and it is only 8MB!

WARNING: SFPACK sound founts are not supported!

you can use "snd_sf2_file" cvar to specify the path to your soundfont.


## AUTOMAP KEYS

currently, automap keys are not configurable, sorry.

TOGGLE FLOOR/CEILING/NONE TEXTURING: T
FOLLOW: H
GRID ON/OFF: G
PUT MARK: M
SELECT NEXT MARK: N
DELETE SELECTED MARK: C/DELETE

note that you can manage your marks with "N" and "C". pressing "N"
will cycle through all marks, and you can delete current mark with
"C".


## GNU/LINUX GAMERS SECTION

### INSTALLATION

If you're on an Arch-based Linux distribution, you may use an AUR package.

For all the other flavours of GNU/Linux you have to compile k8vavoom from
the sources. Make sure you have at least the following libraries in your
system: SDL2, OpenAL, libopus, libvorbis, libflac. Also, you MUST run
`make install` command because k8vavoom won't run from an arbitrary
location.

Please, refer to "docs/k8vavoom.txt" for more info.


### CONFIGURATION

k8vavoom stores its user configuration and supplemental files in the
`~/.k8vavoom` directory.

~/.k8vavoom
   \
   |-autoload
   |   \
   |   |-doom
   |   |  \
   |   |  |-<subdir>
   |   |  |-cool_models.pk3
   |   |  |-autorun.rc
   |   |
   |   |-<game name>
   |
   |-iwads
   |  \
   |  |-DOOM.WAD
   |  |-DOOM2.WAD
   |  |...
   |
   |-sshots
   |
   |-saves
   |
   |-modes.rc

You'd better create "~/.k8vavoom/iwads" directory and put at least one
IWAD file there to play a game. You can specify a game name with the
corresponding command line switch, e.g. -doom, -doom2, -tnt, etc.


#### Autoload

If you want some wad or pk3 resource to be loaded automatically on start,
you can put it into "autoload/<game name>" directory. Sub-directories are
not scanned at the start, but they can be used within "autorun.rc" config
file.

The "autorun.rc" file allows you to define groups of resources, e.g.

```
group "models-weapon" {
  models/mdl_wpn_bfg.pk3
  models/mdl_wpn_chaingun.pk3
  models/mdl_wpn_chainsaw.pk3
  models/mdl_wpn_launcher.pk3
  models/mdl_wpn_plasma.pk3
  models/mdl_wpn_shotgun.pk3
  models/mdl_wpn_ssg.pk3
}
```

So in this example new weapon model will be loaded on start. Command line
switch `-skip-auto <group name>` can be used to disable some groups.


#### Screenshots

Screenshots are saved in the "sshots" directory with the name
`shotXXXX.png`, where XXXX is a counter starting with 0000.


#### Saved games

Games are saved in the "saves" directory under the separate
sub-directories. The sub-directories names are k8vavoom configuration
hashes. This means that saves from the different games (or pwads) won't
be visible under another configurations.

That is, if you've played some WAD without its custom music and decided
to add its *MUS.WAD now, you will not see your previous saves, cause the
game config will be different.

But if you are *ABSOLUTELY* sure that your new wad contains only cosmetic
features that *CANNOT* influence the game, you can use "-cosmetic filename"
CLI argument to avoid savegame invalidation.

To stay on the safe side, use "-cosmetic" only for pwads containing music
and/or sounds. Everything else may break the save, or even the engine.


#### Custom game modes

You can aggregate some customisation setting into groups referred here as
'modes' with the `modes.rc` file. See example:

```
/* options:
  DisableBloodReplacement
    disable all blood replacements (but Gore Mod still can replace blood)
    this effectively disables all custom blood from any mod

  DisableGoreMod
    don't load gore mod, even if it is requested by the user

  DisableBDW
    don't load bdw mod, even if it is requested by the user
*/

mode "d4v" {
  // this is case insensitive, and supports DOS-style globs
  basedir "doom*"
  // this will load pwads before "-file"
  // use `postpwad` command for pwad list to load after "-file"
  pwad "/mnt/bigfoot/vavoom/D4V/D4V.wad"
  // skip autoload groups from "autoload.rc"
  skipauto "brightmap*", "glow", "models-*", "smooth*", "spritefix*", "id0-bm"
  // options
  DisableBDW
  // aliases
  alias "doom4vanilla"
}

```

To select a mode use the command line switch `-mode <mode name>`. For the
given example both `-mode b4v` and `-mode doom4vanilla` will do the trick.