This wiki is archived from 2021-09-05
Creating Your First Planetary Annihilation Mod
File:Titans-icon.png Creating your first mod
File:Platinum-rank-icon.png Introduction
Released mods are downloaded from the in-game Community Mods.
When developing your own mod we use filesystem mods.
The first step is to pick a Mod Identifier. 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.
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
- Server Mods: server_mods
Every mod must be contained a single top level directory with a JSON modinfo.json file as documented in Mod Structure.
A new game lobby UI client mod would be installed 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
- com.pa.mikeyh.some-mod-name
- mods
- com.pa.mikeyh.some-mod-name
- client_mods
File:Platinum-rank-icon.png Enabling the mod
Filesystem mods with a valid modinfo.json will automatically appear in the installed tab.
To avoid conflicts with your released version use a different identifier. eg com.pa.mikeyh-some-mod-name-dev
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
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.