Template:Project/Documentation
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. |
| Title | Name of the project. Defaults to the page title, so this can usually be omitted. | Foo |
| Image | File name of an image/screenshot to show. | Translation patch screenshot.png |
| 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]
|
| ReleasedAt | 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 |
| Homepage | Link to your project's homepage. | https://example.com |
| Source code | Link to the source code | https://github.com/foo/bar |
| Download | Download link to your project. Can also be a link to a file on this Wiki. | https://example.org/foo.ups |
Example:
{{Project
| Type=Tool
| ShortDescription=Sacrifices Boks for the greater good.
| Image=Translation patch screenshot.png
| TargetROM=Boktai 1 (U)
| Author=[[User:Raphi|]]
| License=[https://spdx.org/licenses/MIT.html MIT]
| ReleasedAt=2024-08-11
| UpdatedAt=2024-12-24
| Dependencies=Python
| Homepage=https://boktaihacking.net
| SourceCode=https://example.org/
| Download=https://boktaihacking.net/foo.ips
}}
results in:
Project/Documentation
| Description | Sacrifices Boks for the greater good. |
|---|---|
| Target ROM | Boktai 1 (U) |
| Author | Raphi |
| License | MIT |
| Dependencies | Python |
| Released at | 2024-08-11 |
| Updated at | 2024-12-24 |
| Homepage | https://boktaihacking.net |
| Source code | https://example.org/ |
| Download | https://boktaihacking.net/foo.ips |