Modding:Tutorial/Constructing a Map/Source - Revision history

Epyon at 12:27, 11 August 2025

2025-08-11T12:27:51Z

Game Hunter: fixed for 0995

2012-01-24T00:58:33Z

fixed for 0995

Game Hunter: slightly different webpage

2011-09-30T03:01:46Z

slightly different webpage

Game Hunter: more moving

2011-09-23T19:56:19Z

more moving

New page

<source lang="lua">
--module.lua file

module = {
id = "blank",
name = "A Blank Map",
author = "DoomRL Mod Team",
webpage = "http://doom.chaosforge.org/wiki/Modding:Tutorial",
version = {0,1,0},
drlver = {0,9,9,4},
type = "single",
description = "This is an example mod, intended to be altered by anyone wanting " ..
"to test things using the DoomRL base set.",
difficulty = true,
}
</source>

<source lang="lua">
--main.lua file

core.declare("blank", {} )

function blank.OnEnter()
ui.msg("Hello world!")

--give the man a shotty
player.inv:add("shotgun")
--create shotgun shell item with a modified amount of ammo
local pack = item.new("shell")
pack.ammo = 50
player.inv:add(pack)
end

--local variables not within a loop are local to the file itself
--for global variables (across all files), you want to use core.declare()
--always remember to declare things before they are called somewhere else!
local countdown = 600
local minute = 0
local exit_check = true

function blank.OnTick()
--keeps track of game minutes
if countdown == 0 then
countdown = 600
minute = minute + 1
ui.msg("Number of minutes passed: ".. minute)
end
countdown = countdown - 1

--warns player if they are on stairs
if player:get_position() == coord.new(45,10) and exit_check then
ui.msg("Leaving already?")
exit_check = false
end
if player:get_position() ~= coord.new(45,10) and not exit_check then
exit_check = true
end
end

local killCount = 0

function blank.OnKill()
killCount = killCount + 1

--display messages dependent on kills
if killCount == 1 then
ui.msg("You have killed 1 enemy.")
else ui.msg("You have killed " .. killCount .. " enemies.")
end
if killCount == 10 then
ui.msg("Wow, killing spree!")
end
end

function blank.OnKillAll()
--more enemies are added whenever all are defeated
Level.summon("former",5)
ui.msg("They just keep coming!!")

--as a compensation, you are healed to 100% each time
player.hp = player.hpmax
end

function blank.OnExit()
ui.msg_enter("Goodbye world!")
end

--Personally I like to add this at the end, but these hooks can be placed in any order.
function blank.run()
Level.name = "Blank Map"
Level.name_number = 0
Level.fill("pwall")

local translation = {
["."] = "floor",
["#"] = "pwall",
[">"] = "stairs",
["h"] = {"floor", being = "former"}, --places cell with being on top
["]"] = {"floor", item = "garmor"}, --places cell with item on top
["k"] = {"floor", being = "former", item = "phase"}, --places cell with both
}

local map = [[
##############################################################################
#............................................................................#
#............................................................................#
#............................................................................#
#............................................................................#
#...................................................h........................#
#............................................................................#
#......................................................h.....................#
#............................................................................#
#......................................]....>........h.....k.................#
#............................................................................#
#......................................................h.....................#
#............................................................................#
#...................................................h........................#
#............................................................................#
#............................................................................#
#............................................................................#
#............................................................................#
#............................................................................#
##############################################################################
]]
Level.place_tile(translation,map,1,1)
Level.player(39,10)
end
</source>

@@ Line 5: / Line 5: @@
      id          = "blank",
      name        = "A Blank Map",
-     author      = "DoomRL Mod Team",
+     author      = "DRL Mod Team",
-     webpage     = "http://doom.chaosforge.org/wiki/",
+     webpage     = "http://drl.chaosforge.org/wiki/",
      version     = {0,1,0},
      drlver      = {0,9,9,5},
      type        = "single",
      description = "This is an example mod, intended to be altered by anyone wanting " ..
-                   "to test things using the DoomRL base set.",
+                   "to test things using the DRL base set.",
      difficulty  = true,
+}

@@ Line 8: / Line 8: @@
      webpage     = "http://doom.chaosforge.org/wiki/",
      version     = {0,1,0},
-     drlver      = {0,9,9,4},
+     drlver      = {0,9,9,5},
      type        = "single",
      description = "This is an example mod, intended to be altered by anyone wanting " ..
@@ Line 90: / Line 90: @@
      Level.name = "Blank Map"
      Level.name_number = 0
-     Level.fill("pwall")
+     Level.fill("wall")
      local translation = {
      ["."] = "floor",
-     ["#"] = "pwall",
+     ["#"] = "wall",
      [">"] = "stairs",
      ["h"] = {"floor", being = "former"},                 --places cell with being on top
@@ Line 124: / Line 124: @@
 ]]
      Level.place_tile(translation,map,1,1)
      Level.player(39,10)
 end
 </source>