Current Guidelines

Rev 09 (2020/03/01): Show/Hide

Block Submission Guidelines

Your block must work with the latest version of GPS (Gopher Popcorn Stew) and be in the .asm format.
We no longer accept blocks designed for old block insertion programs such as Jonwil's BlockTool or smkdan's BTSD. You can find the latest version of GPS here.
Make sure to fill out the Act As field correctly.
Please use three digit values (025, 130, etc.) when completing the Act As field in your submission. Alternatively, enter "Any" if your block does not require a specific setting. If your blocks work with or require a specific amount of act-like values, please enter "Various" and include a readme file detailing proper usage.
Blocks must have a
db $42
or
db $37
header directive at the top of the file.
GPS requires one of these two header directives, as well as the corresponding 3-byte long jumps per offset. You can find a template block here.
You can use
```
db $42
```
if your block doesn't execute wallrunning code to save space; otherwise, use
```
db $37
```
.
The value of RAM address $0F must be preserved and restored if used under the SpriteV or SpriteH labels, unless modified deliberately.
This scratch RAM address is used by the sprite/object interaction routine that runs after GPS runs its code; failure to preserve $0F can cause interaction bugs.
You must use GPS' shared subroutine system when applicable.
Commonly utilized block subroutines are included with GPS in the "routines" folder and are shared amongst inserted blocks; these routines must be utilized whenever possible, barring specialized adaptations specific to your block. Routines are generally called as macros (ex. %kill_sprite()), but some have special setup conditions as described in the routine's .asm file.
Do not submit unoptimized or overly specific Blockreator blocks.
Blocks created using Blockreator must be optimized and made to use GPS' shared subroutines prior to submission. Furthermore, blocks deemed to be too niche will be rejected (ex. "solid to Player 2 if less than 40 coins collected").
Include a
print
statement in the .asm file containing an appropriate description of the block's function.
GPS generates .dsc list files that allow the user to preview a custom description of the blocks you add for user convenience. A description may be added to your block if missing, and may be altered if useless or misleading at a moderator's discretion.
If submitting a pack of blocks dependent on one another to function (ex. slope setups), please include a sample list.txt and map16 file.
For ease of use to the average user, submissions that require more than 5 blocks to work (eg. not packs of individual blocks) must include a base list file to work from, as well as a map16 page with the same order as the list.

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

Changelog

Rev 09 [2020/03/01]

Added a new guideline mandating the preservation of RAM address $0F if used under the SpriteV or SpriteH labels.

Rev 08 [2019/05/15]

Guidelines overhauled:

Removed several guidelines given the creation of the General SMW ASM Section Submission Guidelines.
Established guideline mandating that blocks insert with GPS, forbidding BlockTool or BTSD.
Established guideline mandating correct entry of the Acts As field.
Established guideline mandating the use of either the
```
db $42
```
or
```
db $37
```
header directive.
Established guideline mandating the use of GPS's shared routines when possible.
Established guideline forbidding highly specific blocks or unoptimized Blockreator blocks.
Established guideline requiring the inclusion of a description by way of the
```
print
```
command.
Established guideline requiring the inclusion of a base list file for packs of interdependent blocks.

Rev 07 [2018/03/11]

Added a new guideline discouraging the inclusion of unnecessary files.

Rev 06 [2016/10/01]

Moved the ASM section tag list to its own page.

Rev 05a [2016/09/29]

Added a list of tags.

Rev 05 [2016/09/29]

Added a new guideline requiring the inclusion of version information.

Rev 04 [2016/01/12]

Added a new guideline requiring the inclusion of both .pal and .palmask files for blocks that include a custom palette.

Rev 03a [2015/10/18]

Added a new guideline encouraging the inclusion of a description by way of the
```
print
```
command.

Rev 03 [2015/10/18]

Added a guideline encouraging the use of GPS's shared routines.
Added a guideline requiring SA-1-only blocks be tagged as sa-1.
Removed link to antiquated block submission guidelines.

Rev 02 [2013/03/11]

[Changes lost]

Rev 01 [2012/05/29]

Original publication.

Block Submission Guidelines

Follow Us On

Affiliates