User Interface Modding

Planetary Annihilation User Interface Modding

The Planetary Annihilation User Interface (UI) is based on the following technologies:

• Javascript
  • KnockoutJS
  • jQuery
• HTML5
• Coherent UI 2.x by Coherent Labs
• Chromium by Google
• Planetary Annihilation engine

PA User Interface Scenes and Panels

The PA user interface is web based using an in-game browser provided by Coherent UI 2 that interacts with the PA engine.

Each HTML page is loaded as a scene under the following fixed hierarchy:

• main
  • game > start, server_browser, etc
  • uberbar

Each scene can also load other scenes as panels (similar to an iFrame as they do not share session storage).

eg the game and uberbar scenes are loaded as panels by main.

The game scene defaults to the start scene and this changes as the user navigates between the following: (listed in alphabetical order)

• armory
• planets
• community_mods (NEW)
• connect_to_game
• galactic_war
• game_over (loaded by live_game so technically should be under live_game)
• gamestats (loaded by live_game so technically should be under live_game)
• guide
• leaderboard
  • shared_build
• live_game
• load_planet
• match_making
• new_game
• replay_browser
• replay_loading
• save_game_browser
• server_browser
• settings
• social (unused)
• start
• system_editor
• transit

There are also two special hidden atlas scenes:

• icon_atlas
• special_icon_atlas

PA User Interface Modding Guidelines

• no remote loading (no longer needed now that we have auto updating)
• do not use global scenes unless absolutely needed (avoid loading unneeded code into every UI scene)