User:Pathoschild/Sandbox: Difference between revisions
imported>Pathoschild revert template test |
imported>Pathoschild + Draft argument syntax highlighting |
||
| Line 1: | Line 1: | ||
==Draft argument syntax highlighting== | |||
The draft output for a potential template to format arguments in a consistent and more modder-intuitive way. | |||
<ul> | |||
<li><code> | |||
friendship | |||
<span style="text-decoration: gray underline dashed;" title="A required argument named 'name'. The whole argument between '<' and '>' should be replaced with a string (text) value."><span style="color:#888;"><</span><span style="color:blue;">''string''</span> name<span style="color:#888;">></span></span> | |||
<span style="text-decoration: gray underline dashed;" title="One or more required arguments named 'number'. The whole argument between '<' and '>+' should be replaced with an integer (whole number) value. This argument can be repeated."><span style="color:#888;"><</span><span style="color:blue;">''int''</span> amount<span style="color:#888;">>+</span></span> | |||
</code></li> | |||
<li><code> | |||
IS_FESTIVAL_DAY | |||
<span style="text-decoration: gray underline dashed;" title="An optional argument named 'locationContext'. The whole argument between '[' and ']' should be replaced with a string (text) value. If the argument is omitted, defaults to "any"."><span style="color:#888;">[</span><span style="color:blue;">''string''</span> locationContext<span style="color:#888;">''="any"'']</span></span> | |||
<span style="text-decoration: gray underline dashed;" title="An optional argument named 'dayOffset'. The whole argument between '[' and ']' should be replaced with an integer (whole number) value. If the argument is omitted, defaults to 0."><span style="color:#888;">[</span><span style="color:blue;">''int''</span> dayOffset<span style="color:#888;">''=0'']</span></span> | |||
</code></li> | |||
<li><code> | |||
viewport | |||
<span style="text-decoration: gray underline dashed;" title="A required argument named 'x'. The whole argument between '<' and '>' should be replaced with an integer (whole number) value."><span style="color:#888;"><</span><span style="color:blue;">''int''</span> x<span style="color:#888;">></span></span> | |||
<span style="text-decoration: gray underline dashed;" title="A required argument named 'y'. The whole argument between '<' and '>' should be replaced with an integer (whole number) value."><span style="color:#888;"><</span><span style="color:blue;">''int''</span> y<span style="color:#888;">></span></span> | |||
<span style="text-decoration: gray underline dashed;" title="A required argument with the exact value "clamp". This should be used as shown.">true</span> | |||
<span style="text-decoration: gray underline dashed;" title="An optional argument which can have one of these exact values: "true", "unfreeze". The whole argument between '[' and ']' should be replaced with one of those values."><span style="color:#888;">[</span>true <span style="color:#888;">''or''</span> unfreeze<span style="color:#888;">]</span></span> | |||
</code></li> | |||
</ul> | |||
==Modding docs reorganization== | ==Modding docs reorganization== | ||
===Motivation=== | ===Motivation=== | ||
Latest revision as of 17:50, 12 October 2025
Draft argument syntax highlighting
The draft output for a potential template to format arguments in a consistent and more modder-intuitive way.
friendship <string name> <int amount>+IS_FESTIVAL_DAY [string locationContext="any"] [int dayOffset=0]viewport <int x> <int y> true [true or unfreeze]
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.