Modding:Basics/Helping Out
From Starbounder - Starbound Wiki
This page represents a list of needed documentation for modding. Feel free to add to it so that someone from the modding community can help contribute. Please tag any created pages with [[Category:Modding]] to help organize the pages into the Modding space. Alternatively add {{Modding}} to the bottom of the page, which will automatically do that and insert a quick navigation for Modding related pages.
- Category revamp: It'd probably be easier to use if things were categorized by "systems" instead of what they are; for example, Modding:Object/Lua, Modding:Object/Parameters instead of Modding:Lua/Object, Modding:Lua/Parameters, etc
- Luckily the wiki allows for a page to be in multiple categories so Lua tables could still be accessible via eg. Modding:Lua/Tables or something?
- Clean up Modding:Lua/Variables: they're missnamed "variables" when it'd more be "parameters", and these pages mix both what the scripts use and what the C++ engine uses
- Modding:Basic_Property_Modification rewrite; it talks about the depreciated __merge feature, should be rewrote for the patching feature. Modding:Advanced_Modding talks about it, maybe use it instead directly?
- The best probably would be to make a separate page documenting the patching system http://community.playstarbound.com/threads/basic-patching-now-with-path-guide-v1-9.84496/ and separate tutorials making use of it
- Asset_Tree documentation (exploding folders into their own articles)
- Modding/tutorials list?
- There's Projects:Guides#Modding Guides -- should probably be linked on the Modding:Portal page
- list of tech moves (not exhaustive, there is also "altFire" and possibly others): http://pastebin.com/Kfa09N7q
- list of all(?) UI elements: http://pastebin.com/tC3WkVP4
- ^is this still required?
- A page about the Mod Uploader Tool http://community.playstarbound.com/threads/uploading-a-mod-onto-the-steam-workshop-step-by-step-how-to.118399/
- Maybe separate from a "Upload to the workshop" page?
- Fix / merge Modding:.codexitem -> Modding:.codex
- Fix / merge .sword -> activeitems
- When 1.3 comes out, Modding:Lua/Tables/ScriptCanvas
Using the Templates
There are a few templates that are used across all Modding related pages. The primary one being the Quick Navigation feature, which you can access using {{Modding}}, which consists of many .Nav templates. The first one is at Modding:.nav and from there on you should be able to access all of them.
Lua Templates
- Form-based Assistant (Use this when editing Lua documentation!)
- http://starbounder.org/Template:Lua/Type
- http://starbounder.org/Template:Lua/Link
- http://starbounder.org/Template:Lua/Variable
- http://starbounder.org/Template:Lua/Function
- http://starbounder.org/Template:Lua/Parameter
- http://starbounder.org/Template:Lua/Argument