Difference between revisions of "Enhanced Client Modding"

Revision as of 19:50, 10 March 2026

List of Mods

The EC is written in the programming language Lua and uses XML to control interface layout. You do not need special software to interact with either .lua or .xml file types. Notepad or another text editor will work just fine. However, some of the graphics files use Direct Draw Surface format and .dds files may not work with all image processing software. GIMP is recommended for image processing as it is both free and can work with .dds files.

Within the client's installation directory, normally something like

This PC> Local Disk (C:)> Program Files (x86)> Electronic Arts> Ultima Online Enhanced> UserInterface

is a file named Custom_UI_Documentaion.zip

Once unzipped, this file will produce a hyper-linked document providing instructions on how to modify the Enhanced Client. Open the folder the documentation was unzipped into and double-click "index.html" to load the document.

With the game running, you can make changes to a .lua or .xml file, save the file, and reload your interface from within the game to the see changes you've made. The default key binding to reload the interface is Control+R, but this can be remapped at the bottom of User Settings> Input.

Reload Interface key binding

You can also switch entire UI's while the game is running through the User Settings> Options> CustomUI menu.

Hot Swap your UI

Finally, you can switch languages while the game is running through the User Settings> Options> Language menu. If you are designing in English, especially .xml buttons, non-English languages may run off, or wrap, on the button. Being able to test .xml code definitions and language postions on the fly, without having to exit and reload the entire client, is a nice boon.

Hot Swap your language

How to

Resources

Color Design

Color Code Converter Easily switch between Hex RGB and HSL. HTML color names.
Color Dictionary Hundreds of colors with names and html codes for each hue.
Stratics Hues Dictionary UO Hue colors and codes

Image Processing Software

GIMP The GNU Image Manipulator Program - a free crowdsourced version of photoshop. Works with the .dds files used in UO's EC.
GIMP Tutorial Video Davies Media Design 10 Tips for GIMP Beginners

Software

Lua homepage The language of the EC.
ZeroBrane An alternate, and quite good, integrated development environment (IDE) for working with Lua.
EC SuperViewer Built by Pinco to comb through the EC's art and sound files. Downloaded from Pinco's Discord.
Mythic Package Editor Built out by Pinco to extract, modify, and reinsert files into the EC's .uop files. Downloaded from Pinco's Discord.

Support

@@ Line 1: / Line 1: @@
 * [[Enhanced Client Mod List | List of Mods]]
+The EC is written in the programming language Lua and uses XML to control interface layout. You do not need special software to interact with either .lua or .xml file types. Notepad or another text editor will work just fine. However, some of the graphics files use Direct Draw Surface format and .dds files may not work with all image processing software. [https://www.gimp.org/downloads/ GIMP] is recommended for image processing as it is both free and can work with .dds files.
+Within the client's installation directory, normally something like
+<code>This PC> Local Disk (C:)> Program Files (x86)> Electronic Arts> Ultima Online Enhanced> UserInterface</code>
+is a file named Custom_UI_Documentaion.zip
+Once unzipped, this file will produce a hyper-linked document providing instructions on how to modify the Enhanced Client. Open the folder the documentation was unzipped into and double-click "index.html" to load the document.
+With the game running, you can make changes to a .lua or .xml file, save the file, and reload your interface from within the game to the see changes you've made. The default key binding to reload the interface is Control+R, but this can be remapped at the bottom of User Settings> Input.
+<gallery mode="nolines">
+HotReloadInterface.jpg |Reload Interface key binding
+</gallery>
+You can also switch entire UI's while the game is running through the User Settings> Options> CustomUI menu.
+<gallery mode="nolines">
+HotSwapUI.jpg |Hot Swap your UI
+</gallery>
+Finally, you can switch languages while the game is running through the User Settings> Options> Language menu. If you are designing in English, especially .xml buttons, non-English languages may run off, or wrap, on the button. Being able to test .xml code definitions and language postions on the fly, without having to exit and reload the entire client, is a nice boon.
+<gallery mode="nolines">
+HotSwapLanguage.jpg |Hot Swap your language
+</gallery>
+==How to==
+* [[Enhanced Client Custom Mods |How to create a custom mod]]
+* [[Enhanced Client Custom Icons |How to create a custom icon]]
+* [[Enhanced Client Custom Actions |How to create a custom action]]
@@ Line 5: / Line 39: @@
+Color Design
+* [https://www.rapidtables.com/web/color/color-wheel.html Color Code Converter] Easily switch between Hex RGB and HSL. HTML color names.
+* [https://www.color-meanings.com/list-of-colors-names-hex-codes/ Color Dictionary] Hundreds of colors with names and html codes for each hue.
+* [https://wiki.stratics.com/index.php?title=UO:Hues Stratics Hues Dictionary] UO Hue colors and codes
+Image Processing Software
+* [https://www.gimp.org/downloads/  GIMP] The GNU Image Manipulator Program - a free crowdsourced version of photoshop. Works with the .dds files used in UO's EC.
+* [https://www.youtube.com/watch?v=1MLnP0OiEkw  GIMP Tutorial Video] Davies Media Design 10 Tips for GIMP Beginners
+Software
+* [https://www.lua.org/ Lua homepage] The language of the EC.
+* [https://studio.zerobrane.com/ ZeroBrane] An alternate, and quite good, integrated development environment (IDE) for working with Lua.
+* [[EC SuperViewer]] Built by [[Pinco's UI |Pinco]] to comb through the EC's art and sound files. Downloaded from [https://discord.gg/bEJ4kE8c8V Pinco's Discord].
+* [[Mythic Package Editor]] Built out by [[Pinco's UI |Pinco]] to extract, modify, and reinsert files into the EC's .uop files. Downloaded from [https://discord.gg/bEJ4kE8c8V Pinco's Discord].
+Support
 * [https://www.youtube.com/watch?v=Uf2MtkAX46g  Storm's mod install video tutorial]
 * [https://community.stratics.com/forums/reference-library.614/  Stratics Resource Library]
 * [https://uo.com/wiki/ultima-online-wiki/technical/enhanced-client-custom-user-interface/  UO.com Wiki]
+====See Also====
+* [[Enhanced Client]]
+* [[Enhanced Client Guide]]