UMP is a framework for modding games using Undertale Mod Tool - It is quick to learn (contains only a small guide) and has useful resources for maintaining mods with a decently large code base.
This framework at the moment works only in the Bleeding Edge version of Undertale Mod Tool. Also, as new versions are released be careful with errors that may arise from decompilation differences.
UMP (pronounce it by letters or phonetically, both is fine) is a (mini) framework for modding using Undertale Mod Tool. It focuses around being able to better organize your gamemaker (and assembly) code for your mod. Its features include:
-
You can organize all your code as external
.gml
files in a single folder, with any subdirectory organization, and it will link all subdirectories. -
You can configurate what code entries each file will affect depending on the file name. The standard use case for this is for example making a file named
obj_OBJECT_NAME_Step_0.gml
map to a code entrygml_Object_OBJECT_NAME_Step_0.gml
; you are free to customize it to your project -
Automatically create new objects, if code for such an object is detected, and organizes new functions so that they are always defined in a proper order
-
Allows to easily create custom functions, allowing you to define multiple functions in one file
-
Allows for using PATCH files which will only change parts of a code entry, reducing unused code and making the patches more version resistent
-
Allows using enums in UTMT (syntax isn't the same as in normal GML, check guide)
-
Allows using inline C# methods to generate GML, which work by defining them in the C# part of the script and calling them in GML
-
Allows for code preprocessing using symbols
If your project already contains a base .csx
script, then:
- Download the
ump.csx
file from the releases - Drop it anywhere you want inside your project
- Inside your main
.csx
script, add#load "RELATIVE PATH TO ump.csx"
at the top - The mod is installed! Check the guide to learn how to use it
See: Guide on how to use the framework
Unsure if UMP is good for you? Check examples of mods that use it and see if you like it.