PA Mod Manager (PAMM)

A guide to setting up mods for use with Planetary Annihilation using the third edition (Flubb's) of PA Mod Manager v1.5.2.

Introduction

This guide is intended for use where the in-game Community Mods item is no longer available. If you see Community Mods on the main menu then you should use that functionality over PA Mod Manager (PAMM).
https://steamcommunity.com/sharedfiles/filedetails/?id=1417396826

Requirements

You are required to have PowerShell version 4 or later. This version is built into Windows 8.1 and later editions of Windows.

Windows 7 users should follow the Weekend Scripter's guide to installing PowerShell[devblogs.microsoft.com]. But seriously, you're outside of support, it's time to upgrade for goodness sake.

Installing PAMM

Download the latest release[github.com].

Extract the contents of the PAMM zip to a folder of your choice. From there you simply need to run the appropriate installer for your OS:

• Linux/macOS - install.sh
  
• Windows - install-windows.bat

The installation will perform multiple extractions, so be patient while it runs.

The output will look something like the screenshot below. Note that this was done using PowerShell v7.1.5 in Windows Terminal, so your output may look slightly different.


The output will tell you the location PAMM has been installed to. On Windows a desktop icon called PAMM will also be created.

If you encounter the error "Latest Atom Shell release not found" during the install, please refer to the manual install[github.com] instructions in PAMM's readme.

Finding Mods

The Available Mods feed no longer functions, therefore you will need to manually locate mods.

Mods authors will need to provide download locations for their mods, so check relevant mod threads for any updates, or ask on the official PA Discord[discord.gg].

Every mod will have a thread on the official forums[forums.planetaryannihilation.com].

The Planetary Annihilation and Planetary Annihilation: TITANS hubs on Mod DB contain a number of mods.

The planetary-annihilation[github.com] and planetary-annihilation-titans[github.com] tags on GitHub are also commonly used by mods and can be a way to locate them. There is also a list of repositories containing the name[github.com].

Mod's on GitHub will provide one or more zip files for download. Download the "Source code" zip file if no other zip files are available.

For the Legion Expansion you will need to do the following:

1. https://github.com/Legion-Expansion/Legion-Expansion/releases/latest
2. Download `com.pa.legion-expansion-client.zip`
3. Download `com.pa.legion-expansion-server.zip`
4. https://github.com/Quitch/AI-Mod-Compatibility-Patch/releases/latest
5. Download the source code zip - this is a server mod

Legion Commanders are not currently shown as red, but will be the last four in the Commander selection list.

Installing Mods

PAMM uses a different format to Community Mods and so you will need to reinstall any mods you wish to use so that PAMM can detect them.

Mods are separated between client and server mods. The folders for these are found in the same root directory that PAMM was installed to. For details refer to the PA support article Where is the Planetary Annihilation Data Directory?[support.planetaryannihilation.com]

Any mod you wish to use must be downloaded and then extracted into the relevant folder. A mod should indicate to you whether it is a client or server mod. Mods which affect the UI tend to be client, while those which add new units are server mods.

Below is an example of a client_mods folder.

Using PAMM

On first opening PAMM you will be shown the News tab. This will fail to load any data, as will the Available Mods tab, since these feeds are no longer operational. This load may also need to complete before your mods can be displayed in the other tabs.


The UI Mods will display any client mods you have (mods which always apply) and the Server Mods will server mods (mods applied only if you are the lobby host). Currently these will contain only some basic mods that ship with the game, any mods you previously had via Community Mods will need to be installed locally to be detected.

Mods can be activated simply by clicking on them. This will fill in the circle next to their name, indicating that they are active. Once you have competed activating the mods you want simply click the Launch PA button.

Upgrading Mods

PAMM doesn't support automatic updates, therefore you will need to manually check for mod updates or subscribe to new releases if that mod is hosted on GitHub.

Before installing a new version of a mod you must first delete the old version's folder. Do not overwrite older versions with new ones.

PAMM Limitations

As PAMM does not support the companion mods system used by Community Mods, for games where you're using mods which add additional units such as Legion Expansion, all players will need the mod installed.

PAMM also does not have mod merging, which means you cannot use multiple mods that add additional units.

Uninstalling PAMM

First open PAMM and ensure you have disabled all installed mods, both UI and Server. Then close PAMM.

Next you should remove all PAMM mods by deleting the contents of the following directories in your Planetary Annihilation Data Directory[support.planetaryannihilation.com], where they exist:

• client_mods
  
• mods
  
• server_mods

On Windows, versions of PAMM prior to 1.5 can be uninstalled using Programs and Features. Versions 1.5 and later do not appear in Programs and Features. To remove PAMM manually delete the following directories in your Planetary Annihilation Data Directory[support.planetaryannihilation.com]:

• pamm
  
• pamm_cache

On Linux, delete pamm_cache from your Planetary Annihilation Data Directory[support.planetaryannihilation.com], then delete pamm from ~/.local/share and the pamm.desktop file from ~/.local/share/applications

On macOS, delete pamm_cache from your Planetary Annihilation Data Directory[support.planetaryannihilation.com], then delete the pamm folder from your desktop.

[Dirty Cleaner]

Why when i run install.bat it says electron releasee not found?

[Quitch]

Added instructions on uninstalling PAMM. There is also a mechanism now to activate Community Mods again which is laid out in the Community Mods guide - https://steamcommunity.com/sharedfiles/filedetails/?id=1417396826

[Notice]

after trying to launch my game with PAMM my game broke and i'm unable to play even after resetting my sdd/ external hard drive 5 times while unistalling all my steam games

[[DKS]MiCaMoQ]

2/2:

Even though I understand the above "just install this manually behind the curtains thingy" as a way-forward, it is just compounding the problem. I've reasoned about this below in the message thread.

Please remember that advice like this "sticks" years ahead. Will it be good advice for this game? Right now; maybe. Will it be for other games? For other mod-developers (some much less trustworthy)? Can a (sorry to say) doubtful github account be trusted, even in this matter? This is not something I think we, you, anyone should suggest to the broad audience of a game. I believe we all have a responsibility here, mod devs, PA crew, and the community to strive for "professional" solutions and not "hacks".

Again, and just to underline it, I really love your contributions and I have enjoyed many other mods for the game too.

PA imho is at the moment on life-support. Get the officially supported community mods back as a direct option in the game itself.

[[DKS]MiCaMoQ]

1/2:

You could not have said it more clearly Fixalated: "officially adopted by the game itself.".

Mods are something we (the userbase) have become acustomed to and actually rely on. It was a great improvement on the game - which is undoubtly why it was enrolled officially in the game code. Removing it is a mindblowingly what-da-fa* move by the developers/employees of PA.

Don't get me wrong here; I love that the community pitches in and makes great addons for the game. That goes especially for you Quitch + crew. I'd really wish that I could cheer for you to keep on going but this move is just beyond comprehension. Hopefully things will go back to where it was "originally" (for years).

[Quitch]

Added section on PAMM's limitations

[Quitch]

Added details on installing the Legion Expansion

[Quitch]

@tkstumpf, not at this time.

[Oatmeal]

Thanks for the info, looking forward to that update to the built in support.

[tkstumpf]

Is there still a way to disable units?, that use to also be in the in dame mod section.