Difference between revisions of "Modding:Documentation"

From DoomRL Wiki

Jump to: navigation, search
m (link to tutorial)
m (added some information to "Getting Started")
Line 2: Line 2:
  
 
== Getting Started ==
 
== Getting Started ==
 +
A good place to ask for advice on modding is the Chaosforge's IRC channel, #chaosforge. This requires some sort of IRC client: a free web-based client can be found [http://en.irc2go.com/webchat/?net=QuakeNet&room=Chaosforge here]. The modding subforum on the Chaosforge forums is also useful in learning about modules, and is a great place to find actual modules from other modders.
  
[[Modding:Tutorial|Tutorial]] (work in progress but has enough info to begin creating simple mods)
+
There is also a [[Modding:Tutorial|series of tutorials]] in place to help with some of the basics of modding (as well as some advanced tricks for more experienced modders). It is suggested that you read through these if you want to understand most of the documentation. If you want to learn only enough to build a quick map, head to the tutorial [[Modding:Tutorial/Constructing a Map|Constructing a Map]] for guidelines and an example.
  
== Documentation ==
+
If you're just here to figure out how to play modules, it is a very simple process:
  
 +
*Download either a folder with the .module extension (this is a "raw" module) or a file with the .WAD extension.
 +
*Place the folder or file into your "modules" directory, located in your DoomRL folder.
 +
*Start DoomRL, then select the "Custom Game" option.
 +
*Select from any of the modules in the menu, at which point the normal game startup procedure will begin.
 +
 +
== Documentation ==
 
This section is documents the DoomRL modding system including the various objects and libraries available to modders.
 
This section is documents the DoomRL modding system including the various objects and libraries available to modders.
  

Revision as of 18:12, 11 October 2011

Players are allowed to load custom game content into the DoomRL engine using the Custom Game menu option. These packages (called modules, mods, or wads) of new content are created by various members of the DoomRL community; look for modules on the modding forum.

Contents

Getting Started

A good place to ask for advice on modding is the Chaosforge's IRC channel, #chaosforge. This requires some sort of IRC client: a free web-based client can be found here. The modding subforum on the Chaosforge forums is also useful in learning about modules, and is a great place to find actual modules from other modders.

There is also a series of tutorials in place to help with some of the basics of modding (as well as some advanced tricks for more experienced modders). It is suggested that you read through these if you want to understand most of the documentation. If you want to learn only enough to build a quick map, head to the tutorial Constructing a Map for guidelines and an example.

If you're just here to figure out how to play modules, it is a very simple process:

  • Download either a folder with the .module extension (this is a "raw" module) or a file with the .WAD extension.
  • Place the folder or file into your "modules" directory, located in your DoomRL folder.
  • Start DoomRL, then select the "Custom Game" option.
  • Select from any of the modules in the menu, at which point the normal game startup procedure will begin.

Documentation

This section is documents the DoomRL modding system including the various objects and libraries available to modders.

Modules

Base Object

Main Objects

Secondary Objects

Other

Constants

Personal tools