75 lines
3.5 KiB
Markdown
75 lines
3.5 KiB
Markdown
# GCT Generator
|
|
|
|
[](https://github.com/BitPatty/gctGenerator/blob/master/LICENSE)
|
|
[](https://github.com/BitPatty/gctGenerator/actions?query=workflow%3A%22CD+Pipeline%22)
|
|
|
|
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](https://github.com/QbeRoot/fastcodes)
|
|
- Creates cheatfiles ready for use with [Nintendont](https://github.com/FIX94/Nintendont), [Gecko Cheat Manager](https://wiibrew.org/wiki/CheatManager) and [Dolphin](https://github.com/dolphin-emu/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).
|
|
|
|
When adding new codes keep in mind that the English title/description are mandatory.
|
|
|
|
### Adding translations
|
|
|
|
1. Create a new file `<lang>.json` in `site/.vuepress/i18n`, where `<lang>` is the language code you want to add. Copy the contents of `en-US.json` into your file and translate each entry in the JSON file.
|
|
2. Create a new folder with your language code in `site` (such as `site/de` for German). Create a new markdown file for each existing page (`guide.md`, `index.md`, `ios58.md`, ...) and translate its contents from the English version.
|
|
3. Create a new entry in `site/.vuepress/i18n/locales.json` with the site metadata and navigation items for your language.
|
|
4. Open `Codes.xml` and add a translation for each code (`<title>` and `<description>`).
|
|
|
|
### Updating Guides
|
|
|
|
You can find the guides in the [site](https://github.com/BitPatty/gctGenerator/tree/master/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](https://nodejs.org/en/) version 14.X lTS installed on your local.
|
|
|
|
```sh
|
|
# 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`.
|
|
|
|
**!!! Note that if yarn was used, `yarn codes:clean` is ran automatically as a pre-commit hook, removing all injected codes and staging ALL changes.** If you want to commit changes without cleaning codes first you have to commit through `git commit --no-verify`.
|
|
|
|
### Build and preview the site (Docker)
|
|
|
|
The project root provides a [docker-compose](https://docs.docker.com/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.
|
|
|
|
```sh
|
|
# Build and serve the site on http://localhost:8080
|
|
# Press CTRL+C to stop the container
|
|
docker-compose up --build
|
|
```
|