User:Pathoschild/Sandbox - Revision history

imported>Pathoschild: + Draft argument syntax highlighting

2025-10-12T17:50:42Z

+ Draft argument syntax highlighting

← Older revision		Revision as of 17:50, 12 October 2025
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===

imported>Pathoschild: revert template test

2025-02-01T18:58:23Z

revert template test

@@ Line 1: / Line 1: @@
-{{#tag:syntaxhighlight|
+==Modding docs reorganization==
+===Motivation===
-    "Format": "{{Content Patcher version}}",{{#tag:nowiki|{{{content|{{{1}}}}}}}}}<!--account for newline at start & end of parameter-->
+# Create one entry point for new mod authors which helps them get started:
-|lang=json}}
+#* What can mods do (i.e. is their idea feasible)?

imported>Pathoschild: fix trailing whitespace

2025-02-01T18:50:45Z

fix trailing whitespace

← Older revision		Revision as of 18:50, 1 February 2025
Line 1:		Line 1:
	{{#tag:syntaxhighlight\|		{{#tag:syntaxhighlight\|
	{		{
	"Format": "{{Content Patcher version}}",{{#tag:nowiki\|{{{content\|{{{1}}}}}}}}		"Format": "{{Content Patcher version}}",{{#tag:nowiki\|{{{content\|{{{1}}}}}}}}}<!--account for newline at start & end of parameter-->
	}
	\|lang=json}}		\|lang=json}}

imported>Pathoschild: fix whitespace

2025-02-01T18:49:38Z

fix whitespace

← Older revision		Revision as of 18:49, 1 February 2025
Line 1:		Line 1:
	{{#tag:syntaxhighlight\|		{{#tag:syntaxhighlight\|
	{		{
	"Format": "{{Content Patcher version}}",		"Format": "{{Content Patcher version}}",{{#tag:nowiki\|{{{content\|{{{1}}}}}}}}
	{{#tag:nowiki\|{{{content\|{{{1}}}}}}}}
	}		}
	\|lang=json}}		\|lang=json}}

imported>Pathoschild: template test

2025-02-01T18:47:29Z

template test

@@ 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}}

imported>Pathoschild: + modding doc reorganization notes

2021-04-30T05:35:38Z

+ modding doc reorganization notes

← Older revision		Revision as of 05:35, 30 April 2021
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.

imported>Pathoschild: /* Callout templates */ add max widths

2021-04-30T03:07:54Z

Callout templates: add max widths

← Older revision		Revision as of 03:07, 30 April 2021
Line 3:		Line 3:

	===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 9:

	===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 15:

	===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>

imported>Pathoschild: + draft callout templates

2021-04-30T02:58:14Z

+ draft callout templates

New page

==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;">
<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;">
<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;">
<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>