From 5eb3ab91957908f87b6a890e92ebf0358d2eaa93 Mon Sep 17 00:00:00 2001 From: Sally Coolatta Date: Fri, 20 Sep 2024 17:08:57 -0400 Subject: [PATCH] Add UDMF extension documentation --- docs/udmf.txt | 273 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 273 insertions(+) create mode 100644 docs/udmf.txt diff --git a/docs/udmf.txt b/docs/udmf.txt new file mode 100644 index 000000000..ea6cfb146 --- /dev/null +++ b/docs/udmf.txt @@ -0,0 +1,273 @@ +=============================================================================== +Universal Doom Map Format - Ring Racers extensions v1.0 - 20.09.2024 + + Copyright (c) 2024 Sally Cochenour. + Copyright (c) 2024 Kart Krew Dev. + + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.2 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + +=============================================================================== + +This document serves to only specify changes that "Dr. Robotnik's Ring Racers" +makes to the base UDMF specification. + +======================================= +I. Grammar / Syntax +======================================= + +No changes were made. + +======================================= +II. Implementation Semantics +======================================= + +------------------------------------ +II.A : Storage and Retrieval of Data +------------------------------------ + +No changes were made. + +----------------------------------- +II.B : Storage Within Archive Files +----------------------------------- + +Between the TEXTMAP and ENDMAP lumps, Ring Racers supports the following +additional lumps: + + BEHAVIOR = Compiled ACS code. + ZNODES = Compiled extended / GL friendly nodes. These are required. + PICTURE = A Doom graphic lump, expected to be 320x200. Intended to be a + screenshot of the map itself. This is used by the game for level + select menus. + MINIMAP = A Doom graphic lump, expected to be 100x100. Intended to be a + an overview of the map. This is used by the game for the minimap + on-screen HUD. + ENCORE = A Doom flat lump, expected to be 16x16. Describes a color remap + palette to use in Encore Mode. + TWEAKMAP = A Doom flat lump, expected to be 16x16. Describes a color remap + palette to use outside of Encore Mode. + +Any lumps not listed or specified in the original document will be ignored by +the game. In particular, the "SCRIPTS" lump is considered to be ACS source +code, and is garantueed to be ignored by the engine. + +-------------------------------- +II.C : Implementation Dependence +-------------------------------- + +Ring Racers does not aspire for Doom backwards compatibility, thus it does not +support any of the namespaces in the original document, and only implements +its own: "ringracers". Any maps not using the "ringracers" namespace is +considered unsupported. + +======================================= +III. Standardized Fields +======================================= + +Ring Racers' namespace implements the following additional fields: + + version = ; // Specifies the map format version. + // This is used for resolving backwards compatibility issues. + + // Note that this doesn't map directly to specification version; + // it means behavior of an already existing field or action special + // was changed. + + // 0 / default - RR indev + // 1 - RR v2.0, spec v1.0 + // 2 - RR v2.4, spec v1.0 + + linedef + { + moreids = ; // Additional IDs, specified as a space separated list of numbers (e.g. "2 666 1003 4505") + + arg5 = ; // Argument 5. Default = 0. + arg6 = ; // Argument 6. Default = 0. + arg7 = ; // Argument 7. Default = 0. + arg8 = ; // Argument 8. Default = 0. + arg9 = ; // Argument 9. Default = 0. + + stringarg0 = ; // String argument 0. This replaces usage of 'arg0' when specified. + stringarg1 = ; // String argument 1. This replaces usage of 'arg1' when specified. + + alpha = ; // Transparency value of the mid-textures. Default = 1.0. + renderstyle = ; // The rendering mode to use for the mid-textures. + // Can be "translucent", "add", "subtract", "reversesubtract", "modulate", or "fog". + // Default = "translucent". + + // The following flags default to false. + blockplayers = ; // true = line blocks players. + skewtd = ; // true = upper and lower textures are skewed to match slopes. + noskew = ; // true = mid-textures are not skewed to match slopes. + midpeg = ; // true = invert mid-texture unpegged behavior. + midsolid = ; // true = mid-texture has collision. + wrapmidtex = ; // true = mid-textures are wrapped. + nonet = ; // true = special is disabled in networked multiplayer games. + netonly = ; // true = special is only enabled in networked multiplayer games. + notbouncy = ; // true = disable bouncing collision. + transfer = ; // true = use FOF transfer properties effect. + } + + sidedef + { + repeatcnt = ; // Number of times to mid-texture wrap. Default = 0. + } + + vertex + { + zfloor = ; // The floor height at this vertex, for vertex slopes. + zceiling = ; // The ceiling height at this vertex, for vertex slopes + } + + sector + { + lightfloor = ; // The floor's light level. Default is 0. + lightceiling = ; // The ceiling's light level. Default is 0. + + lightfloorabsolute = ; // true = 'lightfloor' is an absolute value. Default is + // relative to the owning sector's light level. + lightceilingabsolute = ; // true = 'lightceiling' is an absolute value. Default is + // relative to the owning sector's light level. + + moreids = ; // Additional IDs, specified as a space separated list of numbers (e.g. "2 666 1003 4505") + + xpanningfloor = ; // X texture offset of floor texture, Default = 0.0. + ypanningfloor = ; // Y texture offset of floor texture, Default = 0.0. + + xpanningceiling = ; // X texture offset of ceiling texture, Default = 0.0. + ypanningceiling = ; // Y texture offset of ceiling texture, Default = 0.0. + + rotationfloor = ; // Rotation of floor texture in degrees, Default = 0.0. + rotationceiling = ; // Rotation of ceiling texture in degrees, Default = 0.0. + + floorplane_a = ; // Define the plane equation for the sector's floor. Default is a horizontal plane at 'heightfloor'. + floorplane_b = ; // 'heightfloor' will still be used to calculate texture alignment. + floorplane_c = ; // The plane equation will only be used if all 4 values are given. + floorplane_d = ; + + ceilingplane_a = ; // Define the plane equation for the sector's ceiling. Default is a horizontal plane at 'heightceiling'. + ceilingplane_b = ; // 'heightceiling' will still be used to calculate texture alignment. + ceilingplane_c = ; // The plane equation will only be used if all 4 values are given. + ceilingplane_d = ; + + friction = ; // Sector's friction. Default = 0.90625. + gravity = ; // Sector's gravity multiplier. Default = 1.0. + damagetype = ; // Damage inflicted by the sector. + // Can be "None", "Generic", "Lava", "DeathPit", "Instakill", or "Stumble". + // Default = "None". + + action = ; // Sector action, same as line special. Default = 0. + arg0 = ; // Argument 0. Default = 0. + arg1 = ; // Argument 1. Default = 0. + arg2 = ; // Argument 2. Default = 0. + arg3 = ; // Argument 3. Default = 0. + arg4 = ; // Argument 4. Default = 0. + arg5 = ; // Argument 5. Default = 0. + arg6 = ; // Argument 6. Default = 0. + arg7 = ; // Argument 7. Default = 0. + arg8 = ; // Argument 8. Default = 0. + arg9 = ; // Argument 9. Default = 0. + stringarg0 = ; // String argument 0. This replaces usage of 'arg0' when specified. + stringarg1 = ; // String argument 1. This replaces usage of 'arg1' when specified. + + lightcolor = ; // Sector's light color as RRGGBB value. Default = 0x000000. + lightalpha = ; // Sector's light color alpha value. Default = 25. + fadecolor = ; // Sector's fog color as RRGGBB value. Default = 0x000000. + fadealpha = ; // Sector's fog color alpha value. Default = 25. + fadestart = ; // Sector's fog start distance. Default = 0. + fadeend = ; // Sector's fog end distance. Default = 31. + + // The following flags default to false. + colormapfog = ; // true = render transparent planes at light level instead of fullbright + colormapfadesprites = ; // true = fog color affects fullbright sprites + colormapprotected = ; // true = colormap cannot be changed at run-time + + flipspecial_nofloor = ; // true = plane touch specials aren't ran when on the floor + flipspecial_ceiling = ; // true = plane touch specials are ran when on the ceiling + triggerspecial_touch = ; // true = specials are ran when touching edges of sector + triggerspecial_headbump = ; // true = plane touch specials are ran when touching the opposite plane than gravity + invertprecip = ; // true = precipitation spawning rules are inverted + gravityflip = ; // true = flip gravity of objects in this sector + heatwave = ; // true = add heat wave screen effect + noclipcamera = ; // true = camera is not blocked by this sector + ripple_floor = ; // true = add ripple effect to floor + ripple_ceiling = ; // true = add ripple effect to ceiling + invertencore = ; // true = encore remap rules are inverted + flatlighting = ; // true = directional lighting is forced off + forcedirectionallighting = ; // true = directional lighting is forced on + nostepup = ; // true = objects can't step up + doublestepup = ; // true = objects have increased step up + nostepdown = ; // true = objects can't step down + cheatcheckactivator = ; // true = players activate cheat checks when in this sector + exit = ; // true = players finish match when entering sector + deleteitems = ; // true = items instantly explode when entering sector + fan = ; // true = players are propelled upwards in this sector + zoomtubestart = ; // true = sector is start of a zoom tube + zoomtubeend = ; // true = sector is end of a zoom tube + + repeatspecial = ; // true = repeatable action + continuousspecial = ; // true = action is executed every game tick + playerenter = ; // true = player activates when entering + playerfloor = ; // true = player activates when touching floor + playerceiling = ; // true = player activates when touching ceiling + monsterenter = ; // true = enemy activates when entering + monsterfloor = ; // true = enemy activates when touching floor + monsterceiling = ; // true = enemy activates when touching ceiling + missileenter = ; // true = items / projectiles activate when entering + missilefloor = ; // true = items / projectiles activate when touching floor + missileceiling = ; // true = items / projectiles activate when touching ceiling + } + + thing + { + pitch = ; // Pitch of thing in degrees. Default = 0 (horizontal). + roll = ; // Pitch of thing in degrees. Default = 0 (horizontal). + + scalex = ; // Vertical visual scale on thing. Default = 1.0. + scaley = ; // Horizontal visual scale on thing. Default = 1.0. + scale = ; // Vertical and horizontal visual scale on thing. Default = 1.0. + + mobjscale = ; // Physical scale on thing. Default = 1.0. + + foflayer = ; // Which FOF is treated as the base floor/ceiling. + // This changes what 'height' is relative to. + // Default = 0, for no FOF. + + // Action special arguments + arg5 = ; // Argument 5. Default = 0. + arg6 = ; // Argument 6. Default = 0. + arg7 = ; // Argument 7. Default = 0. + arg8 = ; // Argument 8. Default = 0. + arg9 = ; // Argument 9. Default = 0. + + stringarg0 = ; // String argument 0. This replaces usage of 'arg0' when specified. + stringarg1 = ; // String argument 1. This replaces usage of 'arg1' when specified. + + // These arguments modify object behavior on a per-type basis. + // Not to be confused with action special arguments. + thingarg0 = ; // Argument 0. Default = 0. + thingarg1 = ; // Argument 1. Default = 0. + thingarg2 = ; // Argument 2. Default = 0. + thingarg3 = ; // Argument 3. Default = 0. + thingarg4 = ; // Argument 4. Default = 0. + thingarg5 = ; // Argument 5. Default = 0. + thingarg6 = ; // Argument 6. Default = 0. + thingarg7 = ; // Argument 7. Default = 0. + thingarg8 = ; // Argument 8. Default = 0. + thingarg9 = ; // Argument 9. Default = 0. + thingstringarg0 = ; // String argument 0. This replaces usage of 'thingarg0' when specified. + thingstringarg1 = ; // String argument 1. This replaces usage of 'thingarg1' when specified. + + // Following flags default to false. + flip = ; // true = object has reversed gravity + } + +======================================= +Changelog +======================================= + +1.0: 20.09.2024 +- Initial document created.