FlagBrew / PKSM-Scripts

General purpose scripts to use with PKSM.
58 stars 14 forks source link

PKSMScript

Table of Contents

Installing Scripts

If you're using PKSM v6.0.0 or later then you already have most (if not all) scripts already installed

If you're still using PKSM v5.1.x (which is no longer receiving support), do the following:

  1. Download the scripts.7z from this release
  2. Extract the contents and copy the scripts folder to your SD card so that its path is /3ds/PKSM/scripts

Legality Warning

There is risk to using some of these scripts, particularly on the most recent games (US/UM and Su/Mo).

The following is a list of unlabeled scripts (with no legal counterpart) known to edit parts of your save to illegal values:

Replaced Scripts

Old versions of these scripts included the following elements that could be flagged as illegal if a save is put through strict hack checks

Past Gen

These scripts may cause problems in the unlikely event you should ever have to go through thorough hack checks

Script Notes

Some scripts deal with complicated mechanics or have effects that cannot be summarized to fit in their names. Helpful details about these scripts can be found on this wiki page.


Making Scripts

For simple scripts and a basic guide to figuring out the edits you want the script to make, see the docs README.

If you're looking to make a picoC script for PKSM, check out the PKSM scripting API documentation in the wiki


Credits


Script file format

# "Legacy" PKSM script structure
# u8 magic[10]        // PKSMSCRIPT
# u32 offset          // save offset to write the data to
# u32 length          // payload length
# u8 payload[len]     // payload data
# u32 repeat_times    // repeat payload n times
# ...