This wiki is archived from 2021-09-05

Community Mods Testing: Difference between revisions

From Planetary Annihilation: TITANS and Classic PA Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Modding]]
[[Category:Modding]]
= [[File:Titans-icon.png|50px]] Community Mods Testing =
= Community Mods Testing =


For release notes see: [[Planetary Annihilation Community Mods Release Notes]]
For release notes see: [[Planetary Annihilation Community Mods Release Notes]]
Line 6: Line 6:
For an implementation overview see: [[Planetary Annihilation Community Mods Implementation]]
For an implementation overview see: [[Planetary Annihilation Community Mods Implementation]]


== [[File:gold-rank-icon.png|50px]] Install the PTE ==
== Install the PTE ==


Install the PTE build using steam or the Uber launcher.
Install the PTE build using steam or the PA launcher.


== [[File:gold-rank-icon.png|50px]] Locate your PA directory and PTE installation directory ==
== Locate your PA directory and PTE installation directory ==


Locate your [https://wiki.palobby.com/wiki/Planetary_Annihilation_directory PA Directory]
Locate your [https://wiki.palobby.com/wiki/Planetary_Annihilation_directory PA Directory]
Line 18: Line 18:
Locate the PTE directory in your PA installation. The PTE installation directory will be different if installed using steam.
Locate the PTE directory in your PA installation. The PTE installation directory will be different if installed using steam.


== [[File:gold-rank-icon.png|50px]] Update the user interface in your copy of PA==
== Update the user interface in your copy of PA==


Merge replace media/ui in your PA app directory with [https://github.com/mikeyh/pa-ui/tree/community-mods https://github.com/mikeyh/pa-ui/tree/community-mods]
Merge replace media/ui in your PA app directory with [https://github.com/mikeyh/pa-ui/tree/community-mods https://github.com/mikeyh/pa-ui/tree/community-mods]
Line 24: Line 24:
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/
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|50px]] Update the server script in your copy of PA==
== 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/color-table https://github.com/mikeyh/pa-server-script/tree/color-table]
Replace media/server_script in your PA app directory with [https://github.com/mikeyh/pa-server-script/tree/custom-servers https://github.com/mikeyh/pa-server-script/tree/custom-servers]


== [[File:gold-rank-icon.png|50px]] Create empty client_mods and server_mods directories ==
== 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.
For faster startup... rename your client_mods directory to client_mods-PAMM and server_mods directory to server_mods-PAMM in your PA directory.
Line 36: Line 36:
File system mods are only used during mod development.
File system mods are only used during mod development.


== [[File:gold-rank-icon.png|50px]] Launching the test build ==
== 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).
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|50px]] Switching between the test and stable build ==
== 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.
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|50px]] Some mods may no longer work ==
== Some mods may no longer work ==


Various mods that use new functionality have been updated for this build and some may load different versions from PAMM.
Various mods that use new functionality have been updated for this build and some may load different versions from PAMM.
Line 51: Line 51:
* ubermap
* ubermap


== [[File:gold-rank-icon.png|50px]] Focus areas for testing ==
== Focus areas for testing ==


Please focus on the following areas:
Please focus on the following areas:
Line 85: Line 85:
** server mods status shows for hosts (uploading / downloading / mounting)
** server mods status shows for hosts (uploading / downloading / mounting)
** AI personalities
** AI personalities
** selected system info
* live game improvements
** player summary / list for both players and spectators with left / right click
** planet summary tooltip and previews
** planet list
* saved game and play from here on local servers with and without server mods


== [[File:gold-rank-icon.png|50px]] Frameworks testing ==
== Frameworks testing ==


Install latest PTE then merge replace media/ui in your PA app directory with [https://github.com/mikeyh/pa-ui/tree/frameworks https://github.com/mikeyh/pa-ui/tree/frameworks]
Install latest PTE then merge replace media/ui in your PA app directory with [https://github.com/mikeyh/pa-ui/tree/frameworks https://github.com/mikeyh/pa-ui/tree/frameworks]
Line 93: Line 99:


* unmodded and modded UI looks and operates the same as current PTE across different languages
* unmodded and modded UI looks and operates the same as current PTE across different languages
* look for any any NEW javascript errors that show in console or logs
* look for any styling or layout differences (may be very subtle)
* look for any NEW javascript errors that show in console or logs


== [[File:gold-rank-icon.png|50px]] Download testing ==
== Download testing ==


* install latest PTE
* install latest PTE
Line 112: Line 119:
* post 3 separate manual download times in seconds using chrome for: https://dfpsrd4q7p23m.cloudfront.net/community-mods/downloads/com.pa.legion-expansion-client.zip
* post 3 separate manual download times in seconds using chrome for: https://dfpsrd4q7p23m.cloudfront.net/community-mods/downloads/com.pa.legion-expansion-client.zip


== [[File:gold-rank-icon.png|50px]] Still in progress ==
== Still in progress ==


* requesting permission timeout / cancel option
* requesting permission timeout / cancel option
Line 119: Line 126:
* user interface for download errors  
* user interface for download errors  


== [[File:gold-rank-icon.png|50px]] Future updates ==
== Future updates ==


* unit selector
* unit selector
* community mods manager UI updates
* community mods manager UI updates

Latest revision as of 10:38, 9 September 2021

Community Mods Testing

For release notes see: Planetary Annihilation Community Mods Release Notes

For an implementation overview see: Planetary Annihilation Community Mods Implementation

Install the PTE

Install the PTE build using steam or the PA launcher.

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.

Update the user interface in your copy of PA

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

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/

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-servers

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.

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).

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.

Some mods may no longer work

Various mods that use new functionality have been updated for this build and some may load different versions from PAMM.

The following mods will not work:

  • ubermap

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
  • new game lobby improvements
    • chat history is loaded after a refresh, load system, etc
    • server mods show with tooltips
    • server mods status shows for hosts (uploading / downloading / mounting)
    • AI personalities
    • selected system info
  • live game improvements
    • player summary / list for both players and spectators with left / right click
    • planet summary tooltip and previews
    • planet list
  • saved game and play from here on local servers with and without server mods

Frameworks testing

Install latest PTE then merge replace media/ui in your PA app directory with https://github.com/mikeyh/pa-ui/tree/frameworks

Focus:

  • unmodded and modded UI looks and operates the same as current PTE across different languages
  • look for any styling or layout differences (may be very subtle)
  • look for any NEW javascript errors that show in console or logs

Download testing

  • install latest PTE
  • rename existing client_mods / mods and server_mods directories (they need to be missing or empty)
  • set command line options (space separated)
    • --localstorageurl=localstorage-testing (clean config)
    • --forwardlogs
    • --log-threshold=6
    • --coherent-log-level=TRACE
  • launch PA
  • install legion expansion and quit before downloaded
  • delete all files in $PA/download (just to be sure)
  • restart PA
  • wait for download to complete and start to show
  • post full client log in testing room
  • post 3 separate manual download times in seconds using chrome for: https://dfpsrd4q7p23m.cloudfront.net/community-mods/downloads/com.pa.legion-expansion-client.zip

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)
  • user interface for download errors

Future updates

  • unit selector
  • community mods manager UI updates
Retrieved from "https://wiki.palobby.com/w/index.php?title=Community_Mods_Testing&oldid=3446"