This wiki is archived from 2021-09-05

Planetary Annihilation Mod Structure: Difference between revisions

From Planetary Annihilation: TITANS and Classic PA Wiki
Jump to navigation Jump to search
(Created page with "Category:Modding = 50px Planetary Annihilation Mod Structure = == 50px Mod Identifiers == {{Mod Identifiers}}...")
 
No edit summary
Line 6: Line 6:
{{Mod Identifiers}}
{{Mod Identifiers}}


== [[File:platinum-rank-icon.png|50px]] Mod Packaging ==


 
{{Mod Packaging}}
Mods are packaged as zip archives.
 
Every mod must have a modinfo.json at the top level.
 
Mod specific files are

Revision as of 19:52, 31 March 2016

File:Titans-icon.png Planetary Annihilation Mod Structure

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.

File:Platinum-rank-icon.png Mod Packaging

Mods are packaged as zip archives.

Every mod must have a modinfo.json at the top level.

Mod specific files must be saved under a unique path using lowercase names.

eg ui/mods/com.palobby.some-mod-name/

With user interface modding the convention for filenames is based on the scene name.

eg ui/mods/com.palobby.some-mod-name/server_browser.js

Please make sure you only include mod files in your zip and exclude any files not required. eg src, artwork, etc