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

RISEN3D   L A U N C H E R   R E A D M E

===============================================================================
R3DLauncher Version 6.7  -  June  2008

THIS LAUNCHER IS DESIGNED TO WORK EXPLICITLY WITH RISEN3D ONLY

           


IWAD LOCATION

The R3DLauncher uses Risen3D's Compliant Iwad Structure. So it is important that your Iwads are located in at least one of the search criteria locations specified in the Risen3D documentation.

Assuming you installed Risen3D to your 'C' drive your compliant directories would be as follows ....

c:\Risen3D
c:\Risen3D\iwads
c:\Risen3D\data

Alternatively, you can use DOOMWADDIR  to set the path as an Environment Variable.

For Win98 and ME edit your autoexec.bat.
Example: SET DOOMWADDIR=C:\IWADS assuming your Iwads are contained in the C:\IWADS Directory.

For Win2K and XP ( or other NT platforms )
Open My Computer / Properties / Advanced / Environment Variables and add the following - Variable DOOMWADDIR   Value C:\IWADS

However, you will more than likely not have to worry about this as the structure is fairly flexible. If however the R3DLauncher  indicates that it was unable to find the Iwads,  you will be required to setup a Compliant Iwad folder as stipulated above or just simply add your own user Iwad locations, use the method that is illustrated below.


THE USER DIRECTORY

The R3DLauncher is designed to make full use of the Risen3D's User Directory. If you are not familiar with  how this useful option works then please read the Risen3D Docs. The User Directory is also referred to as a Udir.

A Udir is the folder where all the game files are stored and in turn Risen3D uses the R3DGames folder as the parent directory for all Udirs. Therefore, using Requiem as an example Udir, the structure would look like this ...

C:\Risen3D\R3DGames\Requiem

It is not necessary to know anything about the Udir game structure if using the R3Dlauncher, all management and creation of the Udir folders can be performed by the launcher, it is only necessary to place the zipped pwads into the R3DArchive folder ( or specify your own user archive location ) and then by right clicking on the selected archive create a Udir, the illustration below shows how this is achieved.

Just unzip the archive contained in the R3DArchives folder to your nominated Udir folder, in the illustration shown below this was named REQUIEM. An auto-loading Udir was selected because Requiem has more than one file which requires loading. In general it is best to create an auto loading Udir for all pwads.

After unzipping is completed the launcher will automatically take you to your nominated Udir folder.


MODES FOR LAUNCHING GAMES


WADS

This is the best and a particularly easy way to launch wads, useful for wad authors as you can warp to any level in an instant.
A Wads launch is great for checking out new wads before deciding if they are worthy of your attention, there is no need to  know which map to warp to or what Iwad to use, as a Wads launch automatically takes care of this.

There are three lists to choose under the Wads Tab.

Base Games  - These are Iwads found in the Compliant Iwad  folders or a location specified by the user.

Game Folders   - All pwads located in any User Directory structure. There are two types of Udir, either auto or  manual  loading, these can be created by the launcher by just right clicking on the selected folder.   

Archives  -  Any zip files that are placed in the R3DArchives folder can be viewed, converted to Udir folders or simply run from the archive. This is a great way of storing and running single maps. All files contained within the archive are automatically loaded and GL nodes are created prior to launch. You can almost use an Archives launch exclusively - ideal for single map pwads.

If you don't wish to use the R3DArchives folder to store your zipped pwads, you can specify a location from anywhere on your PC, just right click on the selected Archives option and nominate the folder of your choice.

Note1: It is not possible to auto-load all archived pwads as some require to have their resources built before they can be played, this is particularly the case with a few of the older TCs, also be wary of archives that contain directories.

Note2:  Certain pwads may require a GL and normal nodes build, using  the Archives mode will not be possible in these cases. The launcher will prompt you when this situation occurs and you can just create an auto Udir and build GL and normal nodes.

Savegames - It is possible to launch a savegame by simply selecting the game required in the savegame view pane. The user can choose between either a map or savegame launch.

 

DROP ZONE

When minimising the launcher to a drop zone, it is possible to drag and drop a pwad ( even in it's zipped form ) from any location on your PC.

     

Note1:  Certain pwads may require a GL and normal nodes rebuild, using  the Drop Zone mode will not be possible in these cases. The launcher will prompt you when this situation occurs whereby you will be required to create an auto-loading Udir for the building of GL and normal nodes.

Note2:  The Drop Zone method launches games fullscreen regardless of whether the window option is set.

BATCH FILES

The R3DLauncher can create batch files by using all selected file and option information, once a launch type has been chosen it's just a matter of pressing the Batch File button. A batch file will then be created in the Risen3D folder bearing the name of the selected Udir, Games Folder or Profile.  Creating batch files, like Profiles is a alternative way of storing unique game scenarios that may not be possible with a Wads launch. Batch files can also provide a quick link to executing games without further need to use the launcher. However, batch files cannot be created if using the Archives launch state.

Note1: Also remember older Operating Systems such as Win98 can be restricted in the number of characters batch files are allowed.

Note2: Batch Files must be launched from within the Risen3D Directory - the location they were created.

 

PROFILES

Profiles have become somewhat redundant in the R3DLauncher and need only be used if there is a problem getting a game to work with a normal Wads launch.

A Profiles launch is similar to the way Doomsday's Kickstart launches games, however there is one notable exception,  you do not need to specify the jDoom.ded or R3D.ded.

Profiles are ideal for customising games requiring pwads kept in  remote folders ( not in a Risen3D Udir ).

Using the Requiem example - C:\Risen3D\Requiem\ or D:\Pwads\Requiem  ... or whatever.

Any switches included in the Game Options box only effect the individual game of the saved Profile.

Note: Profiles need to be enabled from within the R3DLauncher - Options - Launcher Preferences.

 


MUSIC LISTS

Music files or CD tracks can be loaded into games by using music lists, these can be created under the Sound Tab by clicking on MUSIC and then the New button. To create a new list you must first specify your game type under  the Game menu, Doom2 (default) or Doom. In the menu select Music to add a new selection ( mp3, mod, it or s3m format) or Tracks to add a new CD track. Depending on what game type you selected, your selection will be added sequentially to the game type map format ( map01 - 32 or e1m1 - e4m9). If the range of maps is different in the wad you wish to play then the maps can be altered by right clicking on the selection to bring up the selection editing menu, a useful list of tasks can be performed in this menu such as replacing or deleting selections.

Individual selections can be manually sorted in the list by dragging the selection to the desired position.

Note: There is no need to have a CD in the drive while selecting tracks, the launcher uses a quick select method by use of the drop down menu Tracks.

After a music list has been created it's just a matter of selecting a listed item and activating the load button.

GL NODES

The R3DLauncher will initiate the R3DGlbsp node builder if any wad file is found  not to have imbedded GL nodes or a corresponding R3Dgwa file. It will not bother with any wad files that contain no map content.

You can also manually build GL nodes by right clicking on the selected wad, where you are presented with two options.

Build GL nodes - these are the usual GL nodes that the R3DLauncher or Risen3D automatically build if not already detected, the existing nodes used in the original pwad creation are left intact. In the majority of cases this type of GL node building is all that's required.

Build GL and normal nodes - certain pwads may still exhibit rendering errors which can be fixed by building both GL and normal nodes - the av.wad ( Alien Vendetta ) is a good example of this. If prompted by the launcher to build GL and normal nodes then a more accurately rendered map will result. Keep in mind if launching pwads from a zipped file - GL and normal nodes cannot be built.

When using the GL and normal nodes option, GL nodes are imbedded in the pwad but can easily be restored by right clicking on the corresponding R3Dbak file located in the GAME FILES  list by selecting Restore Pwad.

Note:  Certain pwads must have GL and Normal nodes built to run with  Risen3D - The cchest2.wad, dmdjm02.wad (version 1), hl092604.wad, thespir2.wad, DV.wad, DVII-1u.wad, HC20.wad, bbb.wad, sinedie.wad and blowup.wad are known examples to date. The R3DLauncher will prompt you to build these type of nodes when any of these pwads are detected.


MISSING MODEL PACKS

If there are checkboxes greyed out under the Misc Tab, this means you do not have the corresponding Model Packs installed. You can obtain these packs from the Risen3D Home Page under the downloads section. The checkboxes will become enabled after the packs have been  installed.


R3DLAUNCHER FILES AND DIRECTORIES

\R3DLaunch\R3Dlauncher.exe
\R3DLaunch\required .ocx and .dll files
\R3DLaunch\Links.dat
\R3DLaunch\config.r3d
\R3DLaunch\sky240.r3d ( database of R3D pwads stretch sky )
\R3DLaunch\build.r3d ( database of pwads requiring Normal and GL nodes )
\R3DLaunch\boom.r3d ( database of pwads requiring special boom considerations )
\R3DLaunch\FinalDoom.r3d ( database of pwads requiring Final Doom iwads )
\R3DLaunch\Profiles\ ( stored profiles )
\R3DLaunch\GameInfo\ ( stored map information )
\R3DLaunch\Res\ ( various graphics resources )
\R3DLaunch\Zips\ ( unpacked archive content )
\R3DLaunch\Music\ ( music play lists )
\R3D_Docs\R3DLauncher.htm

 

LAUNCHER TIPS


FREQUENTLY ASKED QUESTIONS

How do I get started?

Just place ( or download ) all your zipped pwads into either the R3DArchive folder or a folder of your choosing, from there you can either run the game from the archive or convert the files into a Udir folder by right clicking on the selected archive..

Alternatively, you can install pwads ( zipped or otherwise )  located anywhere on your PC  to the Risen3D Udir structure by using this button 

What is a Udir?

Also know as the User Directory  it enables savegames to be stored within the games own unique directory structure. The real advantage of a Udir is the ability to promote good housekeeping and management of pwads. Risen3D also uses the Udir type to know whether to auto load it's contents or not.

Why have auto-loading and manual-loading Udirs?

Auto - some archives have resource wads (music or textures) as well as deh files included with the main level wad - these files can be setup in an auto-loading Udir,  the launcher will take control of the loading sequence and automatically load all the files. In the vast majority of cases this can be achieved without any problems, however, be aware that some archives contain files where the resources have to be built prior to launching. If ded files are placed in the Udir folder they also will be loaded automatically, this is ideal for R3D specific maps.

Using the Requiem example, Risen3D uses C:\Risen3D\R3DGames\Requiem\Pwads\ as the auto-loading Udir folder.

Manual - If you wished to have more than one level wad within a Udir folder, such as several wads of a similar theme grouped together, then a manual-loading Udir will enable you to manually select an  individual wad to launch.

Using the Requiem example, Risen3D uses C:\Risen3D\R3DGames\Requiem\Gwads\ as the manual-loading Udir folder.

Why are GL nodes required?

Risen3D requires GL nodes to be built so that the accurate rendering of maps is possible. Risen3D uses the r3dgwa file extension.

What are Custom Global Ded Files?

These are definition files which can be set for all launches within the Models Tab, these are not loaded if using a profile launch, unless the Switch to DED Files button is pressed, since profiles use their own unique definition file list. Any or all custom .ded files can now be selected for use via the Custom Global DED Files pane. It is highly recommended that any custom .ded files are placed in the \Defs\Custom folder if the user wishes to use them with R3D addons or R3D specific pwads. Additional .ded files will not work otherwise.

 

CREDITS

SkyJake - for Doomsday and the code base of this Launcher.

GMJ - for Risen3D.

Andrew Apted - for his GL nodes builder, Glbsp.

Info-zip's software - unzip32.dll which can be obtained  from http://www.info-zip.org/pub/infozip/

Mike Le Voi - for samples of his unzip code which were modified for use in this launcher.

 
DISCLAIMER

THE R3DLAUNCHER SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 
 
 

Report all bugs to abbs@bigpond.net.au - include the current launch.log, risen3d.out and the current version of the R3DLauncher.