Template:Project/Documentation: Difference between revisions

Project/Documentation
Description	Sacrifices Boks for the greater good.
Target ROM	Boktai 1 (U)
Author	Raphi
License	MIT
Dependencies	Python
Updated at	2024-12-24
Homepage	https://boktaihacking.net
Download	https://boktaihacking.net

VisualWikitext

Revision as of 20:01, 11 August 2024

Use this template to highlight the most important information about your romhack (or romhacking resource/tool). Almost all parameters are optional, just set whichever ones are relvant to your project. Unless specified otherwise, all parameters are arbitrary wikitext.

Parameter	Description	Example wikitext
Type	Required. Either `Romhack` or `Tool`.	`Romhack`
ShortDescription	Required. One brief sentence that describes your project.	Sacrifices Boks for the greater good.
TargetROM	Which ROM(s) your project is compatible with	Boktai 1 (U)
Author	The people who made the project. Probably you.	`[[User:YourUserName\|]]`
License	The license that applies to your project.	`[https://spdx.org/licenses/MIT.html MIT]`
CreatedAt	Date on which project was initially released.	2024-08-11
UpdatedAt	Date on which the project was last updated. Omit if it hasn't been updated yet.	2024-12-24
Dependencies	If your project is a tool, and it requires dependencies to work, list them here.	Python
Download	Download link to your project. Can also be a link to a file on this Wiki.	https://example.org/foo.ups
Homepage	Link to your project's homepage.	https://example.com

Example:

{{Project
| Type=Tool
| ShortDescription=Sacrifices Boks for the greater good.
| TargetROM=Boktai 1 (U)
| Author=[[User:Raphi|]]
| License=[https://spdx.org/licenses/MIT.html MIT]
| CreatedAt=2024-08-11
| UpdatedAt=2024-12-24
| Dependencies=Python
| Download=https://boktaihacking.net
| Homepage=https://boktaihacking.net
}}

results in:

@@ Line 13: / Line 13: @@
 | Author || The people who made the project. Probably you. || <code><nowiki>[[User:YourUserName|]]</nowiki></code>
 |-
-| License || The license that applies to your project. || <code>[https://spdx.org/licenses/MIT.html MIT]</code>
+| License || The license that applies to your project. || <code><nowiki>[https://spdx.org/licenses/MIT.html MIT]</nowiki></code>
 |-
 | CreatedAt || Date on which project was initially released. || 2024-08-11
@@ Line 33: / Line 33: @@
 | ShortDescription=Sacrifices Boks for the greater good.
 | TargetROM=Boktai 1 (U)
-| Author=[[User:Raphi|Raphi]]
+| Author=[[User:Raphi|]]
 | License=[https://spdx.org/licenses/MIT.html MIT]
 | CreatedAt=2024-08-11