Modding Tools / Notes

• MODDING NOTES and TOOLS
• located in Z_Tools , includes :

• 00_mod_selector.py = art mod selector , generates a custom MassImport list from selected mod folders
• 

• 00_psd_to_GumpOverrides.py = art mod selector for Ultima Outlands , exports source art to GumpOverrides
• 

• 01_image_rotate_to_isometric.py = convert square textre to isometric 45 degree land tile ( ART_M )
• 

• 02_image_composite_multi.py = composites adjacent or overlaping images to assemble sliced tree images , saves arrangment as json for disassembly later
• 

• 02_extract_map_mul.py = loads map mul and exports land tile data from region to csv , to be loaded in blender addon z_blender_GEN_ultima_landtiles.py
• substance painter files for ENV textures

• 03_hotkeys_to_diagram.py = visualize hotkeys from razor
• 

• 02_font_import_mul_edit.py = visualize and edit font glyphs from .mul file
• 

• 03_image_comparison_compositor.py = creates composite image of before and after item art
• 

• 04_ui_gump_composite_loader.py = visualize gump composites for debug
• 

• 04_image_tree_compositor.py = visualize gump composites for debug
• 

Modding Notes

a collection of info for modding ultima online art .

MUL

art assets are compressed into .mul files . modding the art is handled by 'patching' the new art into the corresponding categorical mul file .

• ART = Art_S ( items , placed objects ) , Art_M ( flat isometric landtiles )
• GUMPS = user interface , menus , character sheet equipment
• TEXTURES = land textures used on the terrain

TOOLS

UO Fiddler

• https://github.com/polserver/UOFiddler
• tool to explore and export the art in the mul files .
• Searchable by name or ID ( ids can be found in game saying ">info" or "-info" )
• can Batch export all by category

Mulpatcher by Varan

• http://varan.uodev.de/
• primary tool for patching , using the autopatching feature by txt file
• autopatch txt example ( "HEX imagename.bmp" example= "0xF88 item_reagent_NightShade_0xF88.bmp" )

Export

• 00_psd_to_GumpOverrides.py = Automatically export from psd source files into a GumpOverrides folder

  Image Magick

  • https://imagemagick.org/script/download.php
  • command line image operations
  • in this project currently using imagemagick by a .bat to batch convert psd to bmp and set BMP3 format

  ENVIRONMENT TEXTURES

  Textures - mapped to 3d terrain

  Landtiles ( Art_M ) - isometric tiles , placed in world mixed with 3d textures on flat areas .

  • for each envrionment texture there is a corresponding art_m landtile , and additional art after that .

  TEX_to_ART_M

  • this python script will batch convert Textures to ART_M , however isnt perfect and recommend additional adjustments
  • 
  • located in Z_Tools/01_image_rotate_to_isometric.py

  TEX_debug

  • this python script useful for visual debug , composites numbers onto each texture
  • 
  • located in Z_Tools/03_debug_image_num_color.py

  Substance Painter of ENV textures :

• located in Z_Tools/*.spp
• env_dirt_grass , env_sand_grass , env_mountain , env_cave_mountain
• 

AUTOPATCH

• ( "HEX imagename.bmp" example= "0xF88 item_reagent_NightShade_0xF88.bmp" )
• generated from spreadsheet
• 
• located in Z_Tools/ultima_mods_ART.xlsx , ultima_mods_ENV.xlsx , ultima_mods_UI.xlsx

NAMING

• exports from UOFiddler are HEX or Numbered
• 00_num_to_hex.py = batch rename files in target folder from number to HEX
• file list entered into spreadsheet and renamed based on this convention :
• CATEGORY_Group_Name_NUM_HEX
• batch renaming .bat may be generated from spreadsheet column

HUES

• generaly the color gradients are mapped 0 to 1 greyscale values of the art .
• however some are split into 2 , mapping the color gradient to the greyscale values of 0 to 0.5 and 0.5 to 1 .
• ( this might be done to increase total hues available and/or create complex multi color gradient art compressing the arts value ranges remapping to the multi color gradient )
• example = skill scroll , a necromantic scroll fit to the lower hue gradient by its values fit 0 to 0.5
• when creating these arts recommend using the curves adjustment layer to remap the range .

LINKS

• servuo - https://www.servuo.com/
• gaechti - http://www.burningsheep.ch/