This wiki is archived from 2021-09-05
Planetary Annihilation Modding: Difference between revisions
(Created page with "= 50px Planetary Annihilation Titans & Classic Modding Wiki =") |
mNo edit summary |
||
(46 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Modding]] | |||
= Planetary Annihilation Titans & Classic Modding Wiki = | |||
* [[Planetary Annihilation Community Mods|Community Mods]] | |||
* [[Planetary_Annihilation_Client_Mods|Client Mods]] | |||
* [[Server Mods]] | |||
== Mod Development == | |||
* [[Creating Your First Planetary Annihilation Mod|Creating Your First Mod]] | |||
* [[Mod Structure]] | |||
* [[User Interface Modding]] | |||
* [[Shaders]] | |||
* [[Particle System]] | |||
* [[Planetary Annihilation APIs|APIs]] | |||
* [[Planetary Annihilation Local Server|Local Server]] | |||
Development Tools | |||
* [https://code.visualstudio.com/ Visual Studio Code] is free and useful for JSON editing | |||
* [https://forums.planetaryannihilation.com/threads/pa-modding-reference-guides-applications-tools.48136/ PA Modding Reference Guides, Applications & Tools] is a master thread on the official forums | |||
{{Example Mods}} | |||
{{Submitting and Updating Your Mod}} | |||
{{ New Mod Submission Offline }} | |||
{{Mod Privacy / Security Guidelines}} | |||
== Server Mod Guidelines == | |||
{{Server Mod Guidelines}} | |||
== UberId / UberName / DisplayName == | |||
{{UberId / UberName / DisplayName}} |
Latest revision as of 08:37, 9 September 2021
Planetary Annihilation Titans & Classic Modding Wiki
Mod Development
- Creating Your First Mod
- Mod Structure
- User Interface Modding
- Shaders
- Particle System
- APIs
- Local Server
Development Tools
- Visual Studio Code is free and useful for JSON editing
- PA Modding Reference Guides, Applications & Tools is a master thread on the official forums
Example Mods
- Custom Skybox: https://wiki.palobby.com/wiki/Example_Mod_Custom_Skybox
- Bigger Boom Bot: https://wiki.palobby.com/wiki/Example_Mod_Bigger_Boom_Bot
- Chat Alert: https://wiki.palobby.com/wiki/Example_Mod_Chat_Alert
Submitting Your Mod
Before submitting your mod ensure that it is not outputting any errors to either the game's client or server logs.
You must create a forum post in the appropriate forum and link it in your modinfo file:
- 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/
For released mods please create a post on steam discussions with prefix [MOD]:
- Titans: http://steamcommunity.com/app/386070/discussions/
- Classic: http://steamcommunity.com/app/233250/discussions/ (use prefix [MOD][TITANS] if titans only)
The Community Mods server requires a downloadable URL to a ZIP archive of your top level directory containing your modinfo.json and mod files.
A new game lobby UI client mod would be submitted as a downloadable URL to:
- com.pa.mikeyh.some-mod-name.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 static download links to a release branch are preferred for auto updating.
eg https://github.com/user/com.pa.mod/archive/release.zip
You can exclude files from the zip using .gitattributes:
.gitattributes export-ignore .gitignore export-ignore
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/
Updating Your Mod
Existing mods will update automatically if you update the existing zip without changing the URL or mod identifier. GitHub will do that automatically.
When changing your mod please remember to update the date and version.
For each update of your mod please post a new comment to your forum and steam discussions posts with any changes then update your original posts.
Check the status of your mod at: https://palobby.com/community-mods/
New Mod Submission
Join the official discord: https://discord.gg/pa and ask to be added to the #mod-submissions channel.
Post the URL to your zip mod in the #mod-submissions channel.
This can't be a link to a download page, it must be a direct link to the zip file.
Existing mods will update automatically if you update the existing zip without changing the URL or mod identifier.
Links to GitHub are preferred.
Mod Privacy / Security Guidelines
Any mods found remotely harvesting, collecting or tracking user information will be removed and the mod creator permanently banned.
If you have a specific reason to collect information remotely then post about it first in the mod forums and ask permission.
Create your own unique identifier and save in user settings if you need to validate user identity over time.
Save only the minimal information required and do not associate or track IP addresses or any other personally identifiable information.
Assume your server will be hacked eventually so be careful what you save and how you secure data.
Server Mod Guidelines
Server mods should NOT:
- install outside of current game
- make changes to user settings or data without permission
- take over PA in any way eg full screen with no cancel option
- prevent players from leaving game
- show inappropriate content
Badly behaved server mods will be killed.
UberId / UberName / DisplayName
Display names are considered public info and can be easily changed. They are not a reliable way to identify users.
UberIds
UberIds are unique long numbers you can store as strings to identify users without personally identifiable information.
UberNames
UberNames were replaced by uberIds and are only used now for linked forums names. Steam users will have an auto generated uberName like steam000000000000000.
Ubernames cannot be changed except when linking a forum account with steam.
Ubernames are used for non steam logins to PlayFab / UberNet via the Uber Launcher, PA launched manually and web based Community Chat
Note: PA Stats was never updated to use uberIds.