by Daniel Swanson (Dani J)
<dani.j@ddsdesign.co.uk>
12/08/2004

http://modelyard.newdoom.com/

CONTENTS:
1. Introduction
1.1 History
1.2 Features
2. Installation
2.1 Customisation via jDRP.ded
3. Paths, Structure & Naming Conventions
3.1 jDRP Structure
3.2 Suggested Addon Structure
4. Contributors
5. Bugs?
6. Contacts

=================================================================================
1. INTRODUCTION

The jDoom Resource Pack (jDRP) is designed to provide resources for use in jDoom,
a sourceport based on iD game DOOM, which runs under The Doomsday Engine by
Jaakko Kerдnen.

The original Doom is a phenomenon. The fact that this pack and The Doomsday Engine
exist, is testament to the effect this series has had in capturing the imaginations
of players across the world.

The goal of the jDRP is provide upto date, high quality resources to heighten the
Doom gaming experience above and beyond that of Doom, whilst staying true to it's
origins.

.................................................................................
1.1 History

The jDRP has developed from the Modelpack, which has undergone many changes over
the years. In latter versions, the modelpack diversified to include much more than
models and now provides all the extended resources used by jDoom.

The pack has had many maintainers over the years, the following is a list of all
previous maintainers:

Aug 2003 - The current maintainer Daniel Swanson aka Dani J
Aug 2002 > Aug 2003 - Anton Rzheshevski aka Cheb
Mar 2002 > Aug 2002 - Abbs
Before Mar 2002 I don't know...

The jDRP uses resources contributed from various different sources.
Refer to section 4-Contributors for further details.

.................................................................................
1.2 Features

Graphics:
* 3D models replacing everything in Doom. From player characters to HUD weapons
* Particle textures used for new effects and modifications of others (eg gore fx)

Features Planned for future versions:
In the future I would like to see other resources made available by the jDRP,
such as a standard hires texture pack and high quality soundfx & music.

=================================================================================
2. INTSTALLATION

If you downloaded the version of the jDRP with the automatic installer all you
should need to do now is open up Kickstart and select the jDRP Addon.

For Win32 users who use KickStart I have included a ksa Addon profile for the
jDRP. With the pack installed in the default locations all you need to do is
launch KickStart and activate the jDRP in the Addons tab. If you don't wish to
use Kickstart, follow the instructions below as for Linux/Mac users.

If youv'e done a manual install this is where everything goes:
eg: if doomsday is installed in c:\Doomsday install to c:\Doomsday\data\jdoom.

jDRP.pk3 --> Doomsday/Data\jDoom
jDRP.ded --> Doomsday/Defs\jDoom
jDRP*.ksa --> Doomsday/kicksprofiles
\Docs\*.* --> Doomsday/docs

Linux/Mac users. Atm there is no KickStart launcher application for your platform.
For that reason you need to tell Doomsday where to find the jDRP files.

Doomsday has built in support to automatically load data files if placed in the
correct folder. To use this feature this is where you need to place the jDRP files:

jDRP.pk3 --> Doomsday/Data/jDoom/auto
jDRP.ded --> Doomsday/Defs/jDoom/auto
\Docs\*.* --> Doomsday/docs

The other alternative is to install the files to the 'standard' location as per the
Win32 with KickStart install. And then add the following to the command line when
starting jDoom:

-file }Data/jDoom/jDRP.pk3 -def }Defs/jDoom/jDRP.ded

=================================================================================
2. CUSTOMISATION VIA JDRP.DED

It is possible to customise which parts of the jDRP you would like to use by editing
jDRP.ded (found in Defs/jDoom in a standard install). Each part of the jDRP is
modular and is self contained in it's own .pk3 within the main jDRP.pk3

Say for instance you wanted to disable just the Demon model. Open jDRP.ded an look
for this line:

Include "M-Demon.ded";

To disable it, all you need to do is comment out that line with the '#' character.
So:

# Include "M-Demon.ded";

=================================================================================
3. PATHS, STRUCTURE & NAMING CONVENTIONS

Due to the vast amount of user created addons it soon became apparent that an
easily modified structure was needed. This structure follows the guide lines set
by The Doomsday Engine.

Note: All paths will be used relative to The Doomsday Engine base path.

.................................................................................
3.1 jDRP Structure

jDRP.pk3
|______Info.inf -Info file containing details about the pack
|
|______data
| |_jDoom
| |_____Auto -All module pk3's go here
| |_____Patches -All Hires patches shared by all Doom game variants:
| | |_doom1
| | |_doom2
| | |_doom2-plut
| | |_doom2-tnt
| |
| |_____Textures -All textures & particle textures
| |_____Models -All models
|
|
|______defs -All definition files (.ded)
|
|______docs -All documentation (including this file)

The models directory is futher subdivided as follows:

|_Models
|______Decor -All decorations in folders prefixed into types:
| |_L-BigLamp - L = LIGHTS
| |_M-EvilEye - M = MISC
| |_N-BigTree - N = NATURE
| |_G-StonePillar - G = GOTHIC
| |_T-Barrel - T = Tech
| \|/
|
|______FX -Standard FX used by other models/things:
| |_Explosions
| |_Fire
|
|______HUD -All HUD weapons in folders:
| |_BFG
| |_Chaingun
| |_Chainsaw
| \|/
|
|______Items -All collectable items in folders prefixed into types:
| |_A-Cell - A = AMMO
| |_E-ComputerMap - E = EQUIPMENT
| |_H-Medikit - H = HEALTH/ARMOR
| |_K-BlueCard - K = KEYS
| |_P-Berzerk - P = POWERUPS
| |_W-BFG - W = WEAPONS
| \|/
|
|______Monsters -All monsters in folders:
| |_Arachnotron
| |_HellKnight
| \|/
|
|______Player -All player (marine) models:
|
|______Projectiles -All projectiles in folders:
|_ImpFireball
|_BFGShot
\|/

...................................................................................
3.1 SUGGESTED ADDON STRUCTURE

I suggest that third partys use a similar structure for distributing addons.
This is so that they can be easily used via an addon management program.

MyAddon.pk3
|______Info.inf -Info file containing details about the pack.
| An example file is included in the jDRP docs folder
|
|______data
| |_jDoom
| |_____Auto -All module pk3's go here
| |_____Patches -All Hires patches shared by all Doom game variants:
| | |_doom1
| | |_doom2
| | |_doom2-plut
| | |_doom2-tnt
| |
| |_____Textures -All textures & particle textures
| |_____Models -All models
|
|______defs -All definition files (.ded)
|
|______docs -All documentation

===================================================================================
4. CONTRIBUTORS

The jDRP has had many contributors over the years here's a run down on who's helped:

Abbs
Aklash Pahk
Chilvence
Dani J - That's me!
Edmundo Bordeu
Jonn Gorden
Jow
other SOG members - http://www.planetquake.com/sog/
The URIY

+ Many others who have helped in other ways,
Phoebus aka William Mull
Grimlock
Skyjake aka Jaakko Kerдnen

I do my best to make sure everyone who contributes to the pack gets a mention but
if your work appears in the pack and I haven't mentioned you here, then let me know.
(see section 6-Contacts)

Note: All paths will be used relative to The Doomsday Engine base path.

=================================================================================
5. BUGS?

Being the $up3r l33t person I am the pack doesn't have any...
Nah just kidding, if you find something you think is a bug then let me know.
Please provide good instructions on how to recreate the bug and I'll do my best
to fix it. (see section 6-Contacts)

=================================================================================
6. CONTACTS

Feel free to contact me about anything regarding the pack. Or just to tell me what
a great job I've done ;)

You can reach me at either http://modelyard.newdoom.com/
or by emailing me at dani.j@ddsdesign.co.uk

Have fun and enjoy the pack. It's taken many people, much hard work to produce it.

Dani J
----------------------------------------------------------------------------------------------
- kiksprofiles/jDRP.ksa (853 B)