Difference between revisions of "User:Pathoschild/Sandbox"
Jump to navigation
Jump to search
Pathoschild (talk | contribs) (+ draft callout templates) |
Pathoschild (talk | contribs) (+ modding doc reorganization notes) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | ==Modding docs reorganization== | ||
| + | ===Motivation=== | ||
| + | # Create one entry point for new mod authors which helps them get started: | ||
| + | #* What can mods do (i.e. is their idea feasible)? | ||
| + | #* 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? | ||
| + | #* 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== | ==Callout templates== | ||
Just some draft template designs for modding tutorials. | Just some draft template designs for modding tutorials. | ||
===Tip/info=== | ===Tip/info=== | ||
| − | <div style="border-radius: 3px; padding: 8px; background: #e3fcef; min-height: 3em; display: flex; flex-direction: row; align-items: center;"> | + | <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 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>This is the 'getting started' tutorial page. When you're done here, check the box on the right for more documentation!</div> | ||
| Line 9: | Line 39: | ||
===Warning=== | ===Warning=== | ||
| − | <div style="border-radius: 3px; padding: 8px; background: #fffae6; min-height: 3em; display: flex; flex-direction: row; align-items: center;"> | + | <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 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>'''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> | ||
| Line 15: | Line 45: | ||
===Error=== | ===Error=== | ||
| − | <div style="border-radius: 3px; padding: 8px; background: #ffebe6; min-height: 3em; display: flex; flex-direction: row; align-items: center;"> | + | <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 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>'''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> | </div> | ||
Latest revision as of 05:35, 30 April 2021
Modding docs reorganization
Motivation
- Create one entry point for new mod authors which helps them get started:
- What can mods do (i.e. is their idea feasible)?
- 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?
- 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
| 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 Content Patcher author guide 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 '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
ⓘ
This is the 'getting started' tutorial page. When you're done here, check the box on the right for more documentation!
Warning
⚠
Make sure to add the dependency to your manifest!
Otherwise players will get confusing errors if the other mod isn't installed, or if it gets loaded after your mod.
Otherwise players will get confusing errors if the other mod isn't installed, or if it gets loaded after your mod.
Error
🅧
XNB mods are an obsolete type of mod and are no longer recommended.
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.
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.