[REFERENCE] UI Modding System

Raevn · August 4, 2013

UI Modding System
Alpha Disclaimer: This information is still being compiled, but is currently based on PA Build 51531 and may change.
See PA Modding Changes for any changes that may have been made after this build.

Starting in build 51118, Planetary Annihilation included a new modding system for User Interface mods. A readme for this system can be found in the PA\media\ui\mods folder, and is reproduced below. The system works by loading the designated files after the default UI files, either globally or for certain scenes.

For CSS files, this means simply creating a file with the appropriate CSS changes, as the later values will overwrite the former default ones. For Javascript & HTML, it is a bit more involved depending on what you wish to achieve.

While HTML fragments are not yet directly supported, the same effect can be achieved through the use of JQuery, with functions like replaceWith.

The following threads may also help:

http://forums.uberent.com/forums/viewtopic.php?f=72&t=50264

http://forums.uberent.com/forums/viewtopic.php?f=72&t=50271

Readme.txt:
** NOTE **
Like all our systems, this is subject to change. We are intending to add a more comprehensive mod system latter on which
will replace (and improve on) this system. But the community is already creating mods, and this will make it easier.

To add a ui mod:
1) Create a file called 'ui_mod_list.js' and add it the ui/mods directory.

2) Format the 'ui_mod_list.js' file as follows:
Code:
/* start ui_mod_list */
var global_mod_list = [

];

var scene_mod_list = {
    'connect_to_game': [

    ],
    'game_over': [

    ],
    'icon_atlas': [

    ],
    'live_game': [

    ],
    'load_planet': [

    ],
    'lobby': [

    ],
    'matchmaking': [

    ],
    'new_game': [
  
    ],
    'server_browser': [

    ],
    'settings': [

    ],
    'special_icon_atlas': [

    ],
    'start': [

    ],
    'system_editor': [

    ],
    'transit': [
  
    ]
}
/* end ui_mod_list */
3) Add js and css files to the lists. For example:
Code:
var global_mod_list = [
    'custom.css'
    'custom.js'
];
and/or
Code:
    'live_game': [
        'scene_specific_custom.css',
        'scene_specific_custom.js'
    ],
Only .css and .js files are currently supported (html fragments will be supported latter). No naming convention is required, but you should
use very specific names to avoid conflicting with other mods. Resources such as images and fonts don't need to be specified in the list.

Files will be loaded in the same order as they appear in the list, and the files will be loaded after the relevant base ui files are loaded.
Files in the 'global_mod_list' will be loaded for every ui scene, while files in the 'scene_mod_list' will only be loaded for the labled scene.

4) Tips

a) File paths should be relative to the active scene. For instance, if you wanted to add hello_mod.js file (located in /mods/global directory) you would use:
'../../mods/global/hello_mod.js'
because all default scenes live in a /alpha/{scene}/ directory, and you need to go up two directories to get to the /mods directory.

[... more here latter]
Click to expand...

Raevn · August 4, 2013

<reserved>

Raevn · August 4, 2013

<reserved>

[REFERENCE] UI Modding System

Raevn Moderator Alumni

Raevn Moderator Alumni

Raevn Moderator Alumni

Share This Page

[REFERENCE] UI Modding System

Raevn Moderator Alumni

Raevn Moderator Alumni

Raevn Moderator Alumni

Share This Page

Useful Searches