Community Mods Testing

File:Titans-icon.png Community Mods Testing

For release notes see: Planetary Annihilation Community Mods Release Notes

For an implementation overview see: Planetary Annihilation Community Mods Implementation

File:Gold-rank-icon.png Install the PTE

Install the PTE build using steam or the Uber launcher.

File:Gold-rank-icon.png Locate your PA directory and PTE installation directory

Locate your PA Directory

Make a backup of your entire PA directory.

Locate the PTE directory in your PA installation. The PTE installation directory will be different if installed using steam.

File:Gold-rank-icon.png Update the user interface in your copy of PA

SKIP THIS STEP UNTIL NOTIFIED

Merge replace media/ui in your PA app directory with https://github.com/mikeyh/pa-ui/tree/custom-commanders

Fonts and videos are not in github so if you replace media/ui you will need to at least add back the fonts to /media/ui/main/shared/font/

File:Gold-rank-icon.png Update the server script in your copy of PA

Replace media/server_script in your PA app directory with https://github.com/mikeyh/pa-server-script/tree/custom-commanders

File:Gold-rank-icon.png Create empty client_mods and server_mods directories

For faster startup... rename your client_mods directory to client_mods-PAMM and server_mods directory to server_mods-PAMM in your PA directory.

The client_mods directory may be named just mods on older installs.

File system mods are only used during mod development.

File:Gold-rank-icon.png Launching the test build

On windows the test build is launched manually using the first PA.exe in your copy (not the PA.exe inside bin_x64).

File:Gold-rank-icon.png Switching between the test and stable build

To switch back to the stable build rename client_mods-PAMM back to client_mods and server_mods-PAMM back to server_mods in your PA directory.

File:Gold-rank-icon.png Many mods may not work at this time

Any mods using mixed case or that depend on frameworks using mixed case will fail to load.

A fix will be in the PTE but is NOT available in the current test build.

Look for 404's with a mixed case path or filename in the debugger or logs.

The following mods will work:

• pa chat
• system sharing
• display rank
• second PIP
• ready up
• auto start game
• auto name
• lobby system preview
• exodus
• hot build
• pa stats
• simple server mods

Some mods that use new functionality have been updated for this build and will load different versions from PAMM.

The following mods will not work:

• ubermap

File:Gold-rank-icon.png Focus areas for testing

Please focus on the following areas:

• mod mounting and resetting
  • mounting of client mods during startup
  • remounting of client mods on return to start
  • mounting / remounting of client mods in galactic war with different loadouts and technology discovered
  • deferred mounting of server mods when hosting a game
  • resetting of server mods when leaving a game and returning to start
• uberbar functionality
  • without pa chat installed
  • with pa chat installed
• general unmodded live game experience related to mouse handling, selection and functionality of each live game panel
• general build stability unmodded and modded
• custom server integration (without faster server browser or PA stats installed)
  • can see custom server games
  • can host custom server games
    • max players and max spectators are based on server max
  • can join custom server games
  • can invite to custom server games
  • can receive invites to custom server games
• game invite improvements
  • no invite to game option when already in lobby
  • no invite to game option when already invited
  • invites are updated with lobby status
  • invites are updated with lobby password
  • invites are cancelled when inviter leaves game lobby
  • invites are cancelled when game starts with no free spectator slots

File:Gold-rank-icon.png Still in progress

• requesting permission timeout / cancel option
• connecting to server timeout / cancel option
• system info in server_browser, load_planet, new_game, live_game_planets, etc (replacing functionality from faster server browser, system sharing and better system view)
• colour table adjustments eg for number of players
• basic server mod upload / download status
• custom commanders

File:Gold-rank-icon.png Future updates

• user interface for download errors
• unit selector
• community mods manager UI updates