A dev version of (A practice file generator for everyone's favorite game: Super Mario Sunshine)
Find a file
Matteias Collet 137b280c6c minor cleanup
2020-07-03 04:16:37 +02:00
.github/workflows trigger build on pr 2020-07-01 08:52:12 +02:00
.vscode wip multi-lang support 2020-07-02 23:55:48 +02:00
codes localize code injector 2020-07-03 01:17:34 +02:00
dockerfiles wip 2020-07-01 08:52:12 +02:00
scripts clean 2020-07-03 03:42:57 +02:00
site minor cleanup 2020-07-03 04:16:37 +02:00
.dockerignore wip 2020-07-01 08:52:12 +02:00
.editorconfig switch from azure-pipelines to github actions 2020-06-29 23:31:44 +02:00
.gitattributes Update .gitattributes 2020-07-01 09:25:44 +02:00
.gitignore init vuepress 2020-06-29 23:31:44 +02:00
.prettierrc prevent flickering & .prettier 2020-06-29 23:31:44 +02:00
docker-compose.yml switch from azure-pipelines to github actions 2020-06-29 23:31:44 +02:00
LICENSE add license 2020-06-29 23:31:44 +02:00
package.json minor cleanup 2020-07-03 04:16:37 +02:00
Readme.md typo [skip ci] 2020-07-02 14:23:15 +02:00
yarn.lock wip multi-lang support 2020-07-02 23:55:48 +02:00

GCT Generator

GitHub license CD Pipeline

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


Features


Contributing

Updating Practice Codes

The codes are stored as XML files (one for each game version) in the /codes directory. If you want to add or change codes edit the corresponding 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).

Code Removal

Codes are generally not deleted. If you want to remove a code, please comment it out in the corresponding XML file.

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 <!-- injectionpoint --> 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.

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