|
|
| Line 1: |
Line 1: |
| ==Modding docs reorganization==
| | {{#tag:syntaxhighlight| |
| ===Motivation===
| | { |
| # Create one entry point for new mod authors which helps them get started: | | "Format": "{{Content Patcher version}}", |
| #* What can mods do (i.e. is their idea feasible)?
| | {{#tag:nowiki|{{{content|{{{1}}}}}}}} |
| #* What are the different types of mods (e.g. SMAPI / Content Patcher / Json Assets / etc), and which do they need for their idea?
| | } |
| #* How do they get started?
| | |lang=json}} |
| #* Where can they get help / ask questions (e.g. link to [[Modding:Help]])?
| |
| # Split SMAPI code from [[Modding:Maps]] into its own page to reduce confusion.
| |
| # Reorganize documentation to make room for more guided tutorials (especially for Content Patcher, whose documentation can be overwhelming for new mod authors).
| |
| | |
| ===Possible scheme===
| |
| {| class="wikitable"
| |
| |-
| |
| ! page
| |
| ! notes
| |
| |-
| |
| | ''Mod author guide''
| |
| | New page. A unified entry point for new mod authors which covers the fundamentals, explains the different mod types, and links to the other sections.
| |
| |-
| |
| | ''SMAPI author guide''<br />''Content Patcher author guide''<br />''Json Assets author guide''
| |
| | Introductory page about creating mods of a given type. Contains a quick blurb about the mod type, links back to intro page, explains how to navigate the section, and links to the tutorial / doc pages. Contains subpages for tutorials and documentation.
| |
| | |
| [[Modding:Maps]] would be split between ''Content Patcher author guide/Map format'' (general info) and ''SMAPI author guide/Map format'' (SMAPI-specific info, links to other page).
| |
| | |
| Most [[Modding:Index#Advanced topics|'advanced topics' pages]] would be part of the Content Patcher author guide, linked from other sections as needed.
| |
| |- | |
| | ''Migration guides/*''
| |
| | Docs to help mod authors migrate to newer game/SMAPI/etc versions (equivalent to the current [[Modding:Index#Migration guides]]). These aren't split by mod type since there's significant overlap.
| |
| |}
| |
| | |
| ==Callout templates==
| |
| Just some draft template designs for modding tutorials.
| |
| | |
| ===Tip/info===
| |
| <div style="border-radius: 3px; padding: 8px; background: #e3fcef; min-height: 3em; display: flex; flex-direction: row; align-items: center; max-width: 60em;">
| |
| <div style="font-size: 2.5em; line-height: 1em; margin-right: 0.5rem;">ⓘ</div>
| |
| <div>This is the 'getting started' tutorial page. When you're done here, check the box on the right for more documentation!</div>
| |
| </div>
| |
| | |
| ===Warning===
| |
| <div style="border-radius: 3px; padding: 8px; background: #fffae6; min-height: 3em; display: flex; flex-direction: row; align-items: center; max-width: 60em;">
| |
| <div style="font-size: 3em; line-height: 1em; margin-right: 0.5rem;">⚠</div>
| |
| <div>'''Make sure to [[Modding:Modder Guide/APIs/Manifest#Dependency|add the dependency to your manifest]]!'''<br />Otherwise players will get confusing errors if the other mod isn't installed, or if it gets loaded after your mod.</div>
| |
| </div>
| |
| | |
| ===Error=== | |
| <div style="border-radius: 3px; padding: 8px; background: #ffebe6; min-height: 3em; display: flex; flex-direction: row; align-items: center; max-width: 60em;">
| |
| <div style="font-size: 3em; line-height: 1em; margin-right: 0.5rem; color: red;">🅧</div>
| |
| <div>'''XNB mods are an obsolete type of mod and are no longer recommended.'''<br />SMAPI can't check them for compatibility and they may cause bugs, crashes, or save corruption. Use XNB mods at your own risk, or see [[#Alternatives using Content Patcher|alternatives using Content Patcher]].</div>
| |
| </div>
| |
{
"Format": "2.8.0",
{{{1}}}
}
