README

   1 WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!!
   2
   3 THIS IS NOT THE ORIGINAL VAVOOM SOURCE CODE. IT IS HEAVILY
   4 MODIFIED, MAY HAVE NEW BUGS, AND ALTERED GAMEPLAY!
   5
   6 PLEASE, DON'T SEND BUG REPORTS TO THE ORIGINAL AUTHORS!
   7
   8 Ketmar Dark // Invisible Vector
   9 ketmar@ketmar.no-ip.org
  10
  11 WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!!
  12
  13 k8vavoom is the fork of the excellent Doom sourceport Vavoom. It features
  14 three unique lightning systems, one based on lightmaps (like Quake), one
  15 with Doom3-style lighting, and one based on shadowmaps. Please note that
  16 k8vavoom is not a carbon copy of Vavoom, so full backward compatibility
  17 should not be expected.
  18
  19 DON'T FORGET TO CHECK "OPTIONS" MENU,
  20 YOU WILL FIND ALOT OF INTERESTING THINGS THERE!
  21
  22
  23 ## SOUNDFOUNTS
  24
  25 you can put SF2 from GZDoom in ~/.k8vavoom/soundfonts directory, and it
  26 will be autoloaded.
  27 actually, any SF2/DLS dropped into this directory will be autoloaded.
  28 if you don't like GZDoom sound font, you can use the one from this post:
  29 https://forums.duke4.net/topic/6973-sc-55-soundfont-huge-update/
  30 it is quite big, but sounds more like Roland SC-55 (as the name implies).
  31
  32 if that soundfont is too big for you, you may try a new Miracle one:
  33 https://www.doomworld.com/forum/topic/111665
  34 it also sounds good, and it is only 8MB!
  35
  36 WARNING: SFPACK sound founts are not supported!
  37
  38 you can use "snd_sf2_file" cvar to specify the path to your soundfont.
  39
  40
  41 ## GNU/LINUX GAMERS SECTION
  42
  43 ### INSTALLATION
  44
  45 If you're on an Arch-based Linux distribution, you may use an AUR package.
  46
  47 For all the other flavours of GNU/Linux you have to compile k8vavoom from
  48 the sources. Make sure you have at least the following libraries in your
  49 system: SDL2, OpenAL, libopus, libvorbis, libflac. Also, you MUST run
  50 `make install` command because k8vavoom won't run from an arbitrary
  51 location.
  52
  53 Please, refer to "docs/k8vavoom.txt" for more info.
  54
  55
  56 ### CONFIGURATION
  57
  58 k8vavoom stores its user configuration and supplemental files in the
  59 `~/.k8vavoom` directory.
  60
  61 ~/.k8vavoom
  62    \
  63    |-autoload
  64    |   \
  65    |   |-doom
  66    |   |  \
  67    |   |  |-<subdir>
  68    |   |  |-cool_models.pk3
  69    |   |  |-autorun.rc
  70    |   |
  71    |   |-<game name>
  72    |
  73    |-iwads
  74    |  \
  75    |  |-DOOM.WAD
  76    |  |-DOOM2.WAD
  77    |  |...
  78    |
  79    |-sshots
  80    |
  81    |-saves
  82    |
  83    |-modes.rc
  84
  85 You'd better create "~/.k8vavoom/iwads" directory and put at least one
  86 IWAD file there to play a game. You can specify a game name with the
  87 corresponding command line switch, e.g. -doom, -doom2, -tnt, etc.
  88
  89
  90 #### Autoload
  91
  92 If you want some wad or pk3 resource to be loaded automatically on start,
  93 you can put it into "autoload/<game name>" directory. Sub-directories are
  94 not scanned at the start, but they can be used within "autorun.rc" config
  95 file.
  96
  97 The "autorun.rc" file allows you to define groups of resources, e.g.
  98
  99 ```
 100 group "models-weapon" {
 101   models/mdl_wpn_bfg.pk3
 102   models/mdl_wpn_chaingun.pk3
 103   models/mdl_wpn_chainsaw.pk3
 104   models/mdl_wpn_launcher.pk3
 105   models/mdl_wpn_plasma.pk3
 106   models/mdl_wpn_shotgun.pk3
 107   models/mdl_wpn_ssg.pk3
 108 }
 109 ```
 110
 111 So in this example new weapon model will be loaded on start. Command line
 112 switch `-skip-auto <group name>` can be used to disable some groups.
 113
 114
 115 #### Screenshots
 116
 117 Screenshots are saved in the "sshots" directory with the name
 118 `shotXXXX.png`, where XXXX is a counter starting with 0000.
 119
 120
 121 #### Saved games
 122
 123 Games are saved in the "saves" directory under the separate
 124 sub-directories. The sub-directories names are k8vavoom configuration
 125 hashes. This means that saves from the different games (or pwads) won't
 126 be visible under another configurations.
 127
 128 That is, if you've played some WAD without its custom music and decided
 129 to add its *MUS.WAD now, you will not see your previous saves, cause the
 130 game config will be different.
 131
 132 But if you are *ABSOLUTELY* sure that your new wad contains only cosmetic
 133 features that *CANNOT* influence the game, you can use "-cosmetic filename"
 134 CLI argument to avoid savegame invalidation.
 135
 136 To stay on the safe side, use "-cosmetic" only for pwads containing music
 137 and/or sounds. Everything else may break the save, or even the engine.
 138
 139
 140 #### Custom game modes
 141
 142 You can aggregate some customisation setting into groups referred here as
 143 'modes' with the `modes.rc` file. See example:
 144
 145 ```
 146 /* options:
 147   DisableBloodReplacement
 148     disable all blood replacements (but Gore Mod still can replace blood)
 149     this effectively disables all custom blood from any mod
 150
 151   DisableGoreMod
 152     don't load gore mod, even if it is requested by the user
 153
 154   DisableBDW
 155     don't load bdw mod, even if it is requested by the user
 156 */
 157
 158 mode "d4v" {
 159   // this is case insensitive, and supports DOS-style globs
 160   basedir "doom*"
 161   // this will load pwads before "-file"
 162   // use `postpwad` command for pwad list to load after "-file"
 163   pwad "/mnt/bigfoot/vavoom/D4V/D4V.wad"
 164   // skip autoload groups from "autoload.rc"
 165   skipauto "brightmap*", "glow", "models-*", "smooth*", "spritefix*", "id0-bm"
 166   // options
 167   DisableBDW
 168   // aliases
 169   alias "doom4vanilla"
 170 }
 171
 172 ```
 173
 174 To select a mode use the command line switch `-mode <mode name>`. For the
 175 given example both `-mode b4v` and `-mode doom4vanilla` will do the trick.