Difference between revisions of "Omgifol"

From DoomWiki.org

[checked revision][checked revision]
m (+wl Revenant)
m (External links: update drawmaps.py description)
Line 80: Line 80:
* [https://bitbucket.org/alexmax2742/omgifol Fork] by [[Alex Mayfield (AlexMax)]] on BitBucket
* [https://bitbucket.org/alexmax2742/omgifol Fork] by [[Alex Mayfield (AlexMax)]] on BitBucket
* [https://github.com/jminor/omgifol Fork] by jminor on GitHub
* [https://github.com/jminor/omgifol Fork] by jminor on GitHub
* [http://www.gamers.org/~fpv/drawmaps.py drawmaps.py script] with scale and logging support
* [http://www.gamers.org/~fpv/drawmaps.py drawmaps.py script] with scale, logging and spawn points support

Latest revision as of 13:49, 11 June 2019

Omgifol is a Python library for WAD files. It is open source software originally written by Fredrik Johansson and currently maintained by Devin Acker (Revenant), and is released under the terms of the MIT License. The most recent version, 0.4.0, was released February 22, 2018.

In September 2015 Fredrik confirmed that the original library was no longer being maintained[1], and recommended to use a more actively maintained fork by Revenant. In November of the same year, this fork was given Fredrik's blessing[2] to become the basis of a new release, and nearly two years later it was finally published to the Python Package Index as version 0.3.0.

As of version 0.3.0, the library aims for out-of-the-box compatibility with both Python 2.7 and Python 3.


Code example[edit]

mirror.py, a demo script that mirrors maps in a WAD, which is included in the 0.2 release:

from sys import argv
from omg import *
from omg.mapedit import *

def mirror(map):
    ed = MapEditor(map)
    for v in ed.vertexes:
        v.x = -v.x
    for l in ed.linedefs:
        l.vx_a, l.vx_b = l.vx_b, l.vx_a
    for t in ed.things:
        t.x = -t.x
        t.angle = (180 - t.angle) % 360
    ed.nodes.data = ""
    return ed.to_lumps()

def main(args):
    if (len(args) < 2):
        print "    Omgifol script: mirror maps\n"
        print "    Usage:"
        print "    mirror.py input.wad output.wad [pattern]\n"
        print "    Mirror all maps or those whose name match the given pattern"
        print "    (eg E?M4 or MAP*)."
        print "    Note: nodes will have to be rebuilt externally.\n"
        print "Loading %s..." % args[0]
        inwad = WAD()
        outwad = WAD()
        pattern = "*"
        if (len(args) == 3):
            pattern = args[2]
        for name in inwad.maps.find(pattern):
            print "Mirroring %s" % name
            outwad.maps[name] = mirror(inwad.maps[name])
        print "Saving %s..." % args[1]

if __name__ == "__main__": main(argv[1:])

Drawing maps[edit]

Another included demo script is drawmaps.py to save map preview images. This script is one of the tools most suitable for creating map views on Doom Wiki. After the initial v0.2 release, Fredrik made further improvements to its handling of the specified image dimensions[3].

In April 2016, Frans P. de Vries added support for a scale parameter that is applied to all requested map images, and for optional verbose logging. The following example command renders all DOOM2.WAD maps at the same scale (with only the largest maps sized down to fit within 1600 pixels) so the viewer gets a good impression of the size differences between them:

python drawmaps.py DOOM2.WAD MAP* 1600 4.0

A subsequent addition in September/October 2018 was to optionally render numbered spawn points for deathmatch starts (in green) and Capture the Flag/Capture the Chalice starts (in blue and red), allowing such map views to illustrate multiplayer map analysis and tactics.

Another variant[4] in the fork by Alex Mayfield adds drawing small squares for all things.


"OMGIFOL" stands for "Oh My God! It's Full Of Lumps!"

See also[edit]

External links[edit]


  1. Fredrik (30 September 2015). "A faster way to generate PLAYPAL / COLORMAP." Doomworld Forums. Retrieved 20 April 2016.
  2. jmickle66666666 (26 November 2015). "Putting omgifol on pypi?" GitHub. Retrieved 6 October 2017.
  3. fredrik_j (11 December 2006). "Omgifol Python WAD Library Code demo / drawmaps.py." Sourceforge. Retrieved 20 April 2016.
  4. Alex Mayfield (11 September 2006). "Alex Mayfield omgifol demo / drawmaps.py." Bitbucket. Retrieved 30 April 2016.