GCT Generator

This repository contains the code behind the Super Mario Sunshine Cheatfile Generator at https://gct.zint.ch/

Features

Custom cheat combination
Custom stage loader based on QbeRoot's fastcodes
Creates cheatfiles ready for use with Nintendont, Gecko Cheat Manager and Dolphin

Contributing

Updating Practice Codes

The codes are stored in the Codes.xml file. If you want to add or change codes edit the XML file. Note that GMSJ0A refers to the NTSC-J 1.1 release of Super Mario Sunshine. (It's not actually called version A but that's what we've been calling it for years due to a misconception on what the A on the back of the box means).

Updating Guides

You can find the guides in the site folder. Simply edit the corresponding markdown file (.md).

Note that in the code reference files everything following the  tag will be removed during the next build.

Site Development

If you intend to change site code you need NodeJS version 12.18.1 or greater installed on your local.

# Install yarn
npm i -g yarn

# Install dependencies
yarn

# Run project in watch mode
# This will serve the page in development mode on http://localhost:8080
yarn dev

# Build project
yarn build

The XML codes will be written automatically to the json file and code reference during the following actions:

Starting the development server with yarn dev
Building the site with yarn build

If you want to inject the codes at any given point you can use yarn codes:inject.

Before opening a PR make sure you run yarn codes:clean to remove the injected codes.

Build and preview the site (Docker)

The project root provides a docker-compose file, which creates a clean build (with the same configuration as the production build) and spins up a minimal Apache server on your local, serving the resulting build on port 8080.

# Build and serve the site on http://localhost:8080
# Press CTRL+C to stop the container
docker-compose up --build

2.6 KiB Raw Blame History