Sonic 3 Title Card Mappings Generator (S3TCG)

This CLI (Command Line Interface) Tool allows users to easily create title cards for Sonic 3 & Knuckles

Examples

Compression tools

• Flex 2

• mdcomp

• ClownMapEd/SonMapEd

Requirements

• Python 3.6 or newer

• A Terminal / Command Prompt

How To Run

Linux/BSD/Mac OS

python3 s3tcg-api.py

Windows

python s3tcg-api.py

The following instructions are for S3&K users, but SCE follows this mostly the same; there is a dedicated SCE section for the information that differs

MAPPINGS INSTRUCTIONS

• In General/Sprites/Title Cards/Map - Title Card.asm (or Map - Title Card S3.asm for S3 alone) replace the original zone mappings (minus the label) with the versions in your terminal (or output.txt).

ART INSTRUCTIONS

• In Level/XXX/KosinskiM Art/Title card.bin needs to be replaced with the Kosinski Moduled (KosM) compressed version of the output.bin file

SCE SPECIFIC INFORMATION

• Make sure to Enter SCE when asked which game

• Compress to KosPM instead of KosM (Objects/Main/Title Card/KosinskiPM Art/Levels/XXX - Title Card.kospm)

• The Mappings are in Objects/Main/Title Card/Object Data/Map - Title Card.asm