A Quake mapping devkit by dumptruck_ds
lango.lan.party@gmail.com
version 1.1.2
2019-07-10

******************************************************
******************************************************
ALWAYS START A NEW FOLDER WHEN USING THIS MOD. 
DO NOT COPY THESE FILES OVER AN EXISTING VERSION
OF THE MOD.
******************************************************
******************************************************
NOTE: If you use this DevKit, your project should be 
released  as a stand-alone mod and installed into its
own folder in the Quake directory. 

To get started, unzip mod_template.zip into your Quake 
directory and rename the my_mod folder to the name of 
your mod. You should not include the progs_dump sample
maps with your mod. There are files listed below you
are free to use.

Currently this is untested and unsupported in COOP

***Please read the PDF manual for detailed information.***

INSTALLATION:

Create a folder called pd_112 in your Quake directory.
Unzip the contents of the zip to that new folder.
Run Quake with the following command line:

-game pd_112 +map start

or run Quake as usual and type

game pd_112

in the console and hit enter. Then use the menu to start a new game.

If you are using Darkplaces or FTEQW the command is:

gamedir pd_112

or use Simple Quake launcher to launch Quake with progs_dump as the selected
mod. https://github.com/m-x-d/Simple-Quake-Launcher-2/releases

Take a tour and play the included sample maps. The sources are included for
your reference. pd_112.wad contains all textures from the sample maps.

Use the included FGD files with TrenchBroom or JACK. There is currently no .DEF
available yet.

In the progs folder you will find the following items that are used in this mod:

candle.mdl - from the Rogue mission pack.
debris.mdl - from Rubicon2
s_flame.spr - from Duke Nukem 3D
g_shotgn.mdl - from Rubicon2 by metlslime
g_shotty.mdl - created by Slapmap 
spark.mdl - from Rubicon2 by metlslime
s_null.spr - from Quoth

In the maps/debris folder find custom break .bsps you can use:

brick01.bsp
wood1.bsp

In the sound/dump folder:

elec22k.wav - looping electricity sound
rumble.wav - earthquake sound from the Rogue mission pack
water_59_02 - underwater sound for currents etc.
spark.wav - from the Rubicon2 mod

In the sound/break folder are six custom break sounds you can use.

pd_bricks.wav
pd_metal1.wav
pd_metal2.wav
pd_stones1.wav
pd_wood1.wav
pd_wood2.wav

==============================================================================

This is a compilation of QuakeC code from various sources. Use at your own risk. 
PLEASE contact me if you use progs_dump for a project, I'd love to see your work!

                                                              -dumptruck_ds

The source for this mod is included and can be found on Github:
https://github.com/dumptruckDS/progs_dump_qc

==============================================================================
progs_dump requires a modern Quake engine.

Recommended Quake Source Ports:

vkQuake (1.02.1 or above)
https://github.com/Novum/vkQuake/releases

Quakespasm-Spiked (0.93.1 and above)
http://triptohell.info/moodles/qss/

Quakespasm (0.93.1 and above)
http://quakespasm.sourceforge.net/download.htm

Mark V (1099 release 4 or above)
http://quakeone.com/markv/

Darkplaces (recommended version is August 29, 2017 Build)
http://icculus.org/twilight/darkplaces/files/?C=M;O=D

FTEQW
http://fte.triptohell.info/index.php?p=downloads

------------------------------------------------------------------------------
Known Issues:

	- sounds triggered with play_sound_triggered will not continue to loop
	after a saved game is loaded and will need to be re-triggered

*Darkplaces (August 29, 2017 Build)
	
	- Does not display fish kill count properly
	- movedir key in misc_particlespray and misc_particle is stuck on default
	- noise1 key in func_togglewall may not play
	- func_fall does not work if targeted
	- issue with embedding sleeping zombies in brushes can be seen in pd_zombies

*FTEQW (Build 5121)

	- will not display reverse animations in misc_model if speed key is set to
	a negative number. 
	- Some textures may not display properly.
	- Some issues with embedding sleeping zombies in brushes can be seen in 
	pd_zombies

==============================================================================
Distribution / Copyright / Permissions (verbiage courtesy of Arcane Dimensions)
------------------------------------------------------------------------------

Please do not use any of these assets in ANY COMMERCIAL PROJECT.
and remember to give credit if you use any of these assets.

The QC files in this MOD are based on 1.06 source files by ID Software.
These files are released under the terms of GNU General Public License v2 or
later. You may use the source files as a base to build your own MODs as long
as you release them under the same license and make the source available.
Please also give proper credit. Check http://www.gnu.org for details.

Quake I is a registered trademark of id Software, Inc.

All of these resources may be electronically distributed only at
NO CHARGE to the recipient in its current state and MUST include this
readme.txt file.

===========================================================================