Current Guidelines

Rev 07a (2022/02/20): Show/Hide

Patch Submission Guidelines

Your patch must work with the latest version of Asar.
We no longer accept patches designed for any other assemblers such as xkas or wla. You can find the latest version of Asar here.
Patches that consist exclusively of simple hex edits must be of sufficient functional depth.
Generic singular edits such as "modify Banzai Bill's X speed" are better posted in the Tweaks section. Refer to the Tweaks Section guidelines to determine whether your code is best suited as a patch or a tweak.
Your patch must set freespace correctly if applicable.
A patch that inserts code in freespace must use an
```
autoclean
```
command behind one or more labels present in freespace, as well as a
```
freecode
```
or
```
freedata
```
command as appropriate where the inserted code begins.
Patches that hijack timing-insensitive run-every-frame routines are best converted to and submitted as UberASM code.
It is highly recommended - but not strictly required - that a patch hijacking a single routine for the sole purpose of running every frame be converted to code to be inserted with UberASM Tool and submitted in its respective section. This applies to code meant to run in-game or in NMI.
Patches that hijack during a blank will be moderated for efficiency much more strictly.
Code that runs during NMI or in an IRQ must be very cycle-friendly to avoid overflows (see: black bars, graphical glitches), and optimization will be given significantly more weight as a rejection criterion during moderation; consider submitting NMI-only code as UberASM.

See here for the General SMW ASM Submission Guidelines & Changelog.

Changelog

Rev 07a [2022/02/20]

Amended the guideline allowing hex edit patches of sufficient functional depth for additional clarity upon the creation of the Tweaks section.

Rev 07 [2020/03/01]

Amended the guideline forbidding simple hex edits to allow hex edit patches of sufficient functional depth.

Rev 06 [2019/05/15]

Guidelines overhauled:

Removed several guidelines given the creation of the General SMW ASM Section Submission Guidelines.
Established guideline mandating that patches insert with Asar, forbidding xkas or wla.
Established guideline forbidding simple hex edits.
Established guideline mandating the use of
```
autoclean
```
along with
```
freecode
```
or
```
freedata
```
when appropriate.
Established guideline encouraging submitting timing-independent code that runs every frame as UberASM.
Established guideline forewarning of strict moderation for efficiency for code running in NMI/IRQ.

Rev 05c [2019/05/11]

Removed the example code demonstrating proper automatic SA-1/Super FX detection and RAM remapping.

Rev 05b [2019/05/11]

Revamped formatting with no change to content.

Rev 05a [2016/10/01]

Moved the ASM section tag list to its own page.

Rev 05 [2016/10/01]

Changed the guideline regarding tagging/detection of SA-1 resources to include Super FX.
Changed the example code demonstrating proper automatic SA-1 detection and RAM remapping to include Super FX detection.

Rev 04a [2016/09/29]

Added a list of tags.

Rev 04 [2016/09/29]

Added a new guideline mandating the use of the .palmask file format for included palettes.
Added a new guideline requiring the inclusion of version information.

Rev 03 [2015/10/18]

Changed the guideline mandating patch insertion with xkas or Asar to specifically require insertion with Asar.
Changed the guideline mandating the use of a RATS tag to mandate the use of
```
freecode
```
instead.
Added a new guideline for SA-1 compatible resources requiring the use of the sa-1 tag and automatic SA-1 detection and RAM remapping.
Added example code demonstrating proper automatic SA-1 detection and RAM remapping.
Removed link to antiquated patch submission guidelines.

Rev 02 [2014/08/15]

[Changes lost]

Rev 01 [2012/05/29]

Original publication.

Patch Submission Guidelines

Follow Us On

Affiliates