This wiki is archived from 2021-09-05
Creating Your First Planetary Annihilation Mod
File:Titans-icon.png Creating Your First Planetary Annihilation Mod
Released mods are typically installed and downloaded automatically using the in-game Community Mods manager.
During mod development and testing local filesystem 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 for your development or test versions. eg com.pa.mikeyh-some-mod-name-dev
File:Platinum-rank-icon.png Mod Directory Structure
Local filesystem mods are installed 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
- com.pa.mikeyh.some-mod-name
- mods
- com.pa.mikeyh.some-mod-name
- client_mods
File:Gold-rank-icon.png Testing Your Mod
Filesystem mods with a valid modinfo.json installed in the 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 mod info without restating PA.
Other file changes typically require a restart of PA.
File:Gold-rank-icon.png Submitting Your Released Mod
Before submitting your mod create a forum post in the appropriate forum:
- Titans Released Mods: https://forums.uberent.com/forums/released-mods.102/
- Titans Work-In-Progress Mods: https://forums.uberent.com/forums/work-in-progress-mods.103/
- Classic PA Released Mods: https://forums.uberent.com/forums/released-mods.86/
- Classic PA Work-In-Progress Mods: https://forums.uberent.com/forums/work-in-progress-mods.87/
Update your modinfo.json with your forum post URL.
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 with a unique version number for each update in the zip filename and modinfo.json.
A new game lobby UI client mod would be submitted as a downloadable URL to:
- com.pa.mikeyh.some-mod-name_v1.0.0.zip
- modinfo.json
- ui
- mods
- com.pa.mikeyh.some-mod-name
- new_game.js
- com.pa.mikeyh.some-mod-name
- mods
- ui
- modinfo.json
GitHub projects with download links to releases are preferred.
If using Dropbox links they must end with dl=1 to be downloadable.
Check the status of your mod at: https://palobby.com/community-mods/