Creating Your First Planetary Annihilation Mod

File:Titans-icon.png Creating Your First Mod

Released mods are typically downloaded from the in-game Community Mods manager.

During mod development and testing file system mods are used.

File:Platinum-rank-icon.png Mod Identifiers

Every mod must have a unique identifier.

The required format is lowercase reverse domain name notation.

eg com.palobby.some-mod-name

If you don't have your own domain or prefer to use your forum / game handle then prefix with com.pa.handle.some-mod-name

eg com.pa.mikeyh.some-mod-name

My personal preference is dashes (-) over underscores (_) for readability.

To avoid conflicts with your released version use a different identifier. eg com.pa.mikeyh-some-mod-name-dev

File:Platinum-rank-icon.png Mod Directory Structure

Local filesystem mods are saved in the Planetary Annihilation Data Directory based on the type of mod:

• Client Mods: client_mods (might be mods on very old installs from alpha / beta)
• Server Mods: server_mods

Every mod must be contained in a single top level directory with a modinfo.json JSON file as documented in Mod Structure.

A new game lobby UI client mod would be installed as a filesystem client mod using:

• Planetary Annihilation Data Directory
  • client_mods
    • com.pa.mikeyh.some-mod-name
      • modinfo.json
      • ui
        • mods
          • com.pa.mikeyh.some-mod-name
            • new_game.js

File:Gold-rank-icon.png Testing Your Mod

Filesystem mods with a valid modinfo.json installed in filesystem mod directories will automatically appear in the installed tab of Community Mods in PA.

If your mod does not appear check the following:

• modinfo.json is valid JSON with all mandatory properties as documented in Mod Structure
• mod directory is in the correct mod directory for its context

You can edit modinfo.json then reload file system mods to update your info without restating PA.

File changes typically require a restart of PA.

File:Gold-rank-icon.png Submitting Your Mod

Mods are currently still submitted to the old PAMM server using your GitHub account via: http://pamm-mereth.rhcloud.com/mod

The PAMM server requires a downloadable URL to a ZIP archive of your top level directory.