This wiki is archived from 2021-09-05

Creating Your First Planetary Annihilation Mod: Difference between revisions

From Planetary Annihilation: TITANS and Classic PA Wiki
Jump to navigation Jump to search
Line 54: Line 54:
Update your modinfo.json with your forum post URL.
Update your modinfo.json with your forum post URL.


For release mods please create a post on steam discussions:
For released mods please create a post on steam discussions:


* Titans: http://steamcommunity.com/app/386070/discussions/
* Titans: http://steamcommunity.com/app/386070/discussions/
* Classic: http://steamcommunity.com/app/233250/discussions/
* Classic: http://steamcommunity.com/app/233250/discussions/
For each update please post a new comment in your forums and steam discussions post with any changes then update your original posts.


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


Check the status of your mod at: https://palobby.com/community-mods/
Check the status of your mod at: https://palobby.com/community-mods/
== [[File:gold-rank-icon.png|50px]] Updating Your Released Mod ==
Update your modinfo.json version and zip filename then resubmit to PAMM.
For each update of your mod please post a new comment in your forums and steam discussions post with any changes then update your original posts.

Revision as of 12:41, 23 April 2017

File:Titans-icon.png Creating Your First Planetary Annihilation Mod

Released mods are typically installed and downloaded automatically using in-game using Community Mods.

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:

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:

Update your modinfo.json with your forum post URL.

For released mods please create a post on steam discussions:

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

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/

File:Gold-rank-icon.png Updating Your Released Mod

Update your modinfo.json version and zip filename then resubmit to PAMM.

For each update of your mod please post a new comment in your forums and steam discussions post with any changes then update your original posts.