OBLIGE Modding Wiki






This tutorial will show how to create a module which adds new monster definitions for OBLIGE to use.

Step 1

Pick a short name for your module. It must only contain letters, digits, and the underscore '_', and must start with a letter. For example, "foobie" and "big_demon3" are OK, but "3d_tiger" and "$#!^" are invalid names.

Step 2

In the modules folder in OBLIGE, there is a file called new_monsters.template. Copy this to a new file, changing the name to the name you picked in step 1, and setting the file extension (sometimes called the file type) to "lua".

Example: foobie.lua

Lowercase filenames are best. If the file extension is not set correctly, OBLIGE will not load it. You can see which files are being loaded by viewing the log file after starting OBLIGE, via Menu > View Logs.

Step 3

Open your file with a text editor, such as NOTEPAD (which comes with the Windows operating system) or gedit for Linux. Do NOT use a word processor program, such as Microsoft Word, because they do not create plain text files and OBLIGE will not be able to read them.

Find all occurrances of the word "CUSTOM" and change it to your name for the module, using uppercase letters this time.


Step 4

Here you will create the entries for one or more monsters. There is already a single entry in the template, called 'monster1'. Each entry is defined by fields in between curly brackets { .... }. You can add more monsters by copying an existing entry, changing the name, and making sure the opening and closing brackets match up. If you mess up the brackets, OBLIGE will raise an error when it starts.

You can give the monsters custom names, e.g. "demon3", but like before you can only use letters, digit and the underscore, and it cannot begin with a digit. If you added extra monster entries, their names need to be different. Also, the name should be different to the ones from the game itself -- otherwise your monster will replace the existing one.

Each monster entry consists of a number of field names and their values, with a single field on each line. Here is a description of the most common fields you can use:

Compulsory Fields:

this is the ID number of the monster, the same number you would use in the editor (like Doom Builder).
the radius of the monster. If this is too small, this monster will probably end up being stuck in a wall or another monster.
the height of the monster.
the probability of using this monster. Higher values make the monster more likely to be used in a room. Note this is NOT a percentage or absolute value, so values above 100 are perfectly valid.
the health points of the monster.
approximately how much damage the monster would do the player (on average). This is basically the amount of health which OBLIGE will add into the map to compensate for fighting one of these monsters (the exact amount depends on user settings).
the main kind of attack the monster does. There are three possible values: "melee", "missile", and "hitscan" (these values are strings and must have the double quotes).

Optional Fields:

this is an indicator of the toughness of a monster. Easy monsters should have low numbers (1 to 3), tougher monsters are between 4 to 7, and bosses have values of 8 or 9. This also controls, roughly, how far along in an episode or full game the monster will be first introduced. The default value is '1'.
this controls how many monsters to use in a room, where 1.0 is normal, higher values produce more monsters, and lower values produce less monsters. For particularly nasty monsters, like the Archvile in DOOM, low numbers like 0.2 are good for ensuring they are used sparingly in a room.
this probability value is used when the Strength setting of "Crazy" is selected. It allows some fine tuning of the monster balance, but more importantly allows using a monster which would not normally appear, like the SS Nazi of DOOM 2.
set this to "true" (without the quotes) for monsters which fly. OBLIGE can place flying monsters in places which wouldn't make sense for walking ones, like in liquid areas.
set to "true" (without the quotes) for monsters which are partially or completely invisible.
set to "true" (without the quotes) if the monster is particularly nasty. This has a few effects, the main obvious one is the monster will not be placed on the map in groups (not on purpose, anyway).

(Note: the are several more fields which are supported by OBLIGE. These are beyond the scope of this article. If you are interested then I suggest looking at some existing monster definitions, such as those for DOOM 2.)

Step 5

Now you can test your module. Start OBLIGE (if it was already open then close it first), and your new module should appear in the modules list. Enable your module, and build some levels, and the new monster(s) should appear.

When playing the levels, be sure to load any WADs or PK3s which contain the monster graphics (etc) in addition to the WAD created by OBLIGE (which only contains the generated levels).

Testing Tips

  1. you can set a 'prob' value much higher than normal, like 999, to make sure that the monster gets added into the levels. Once it is working, then set the 'prob' value back to normal.
  2. OBLIGE sometimes skips using a monster for a zone, and possibly the whole level, so if it hasn't appeared on the first level, check some other levels. Also, monsters with a high 'level' value usually don't appear in the early levels of an episode or whole game.
Page last modified on October 22, 2016, at 08:03 AM

SourceForge.net       PmWiki