Konami's 1989 arcade game Teenage Mutant Ninja Turtles as a native game for computers, the Nintendo Switch, Android and Anbernic's handhelds, built on its decompilation, tmntarcade-decomp: the game's programs in C, checked frame by frame against MAME in state, picture and sound. Two games come out of it:

• TMNT Arcade: the arcade game as it is: coins, the test mode, four players.
• TMNT: the console version, the arcade game made for playing at home.

This repository contains no game data: you bring your own ROM set (MAME's tmnt, World 4 Players), and the game takes its assets out of it.

Download the package for Windows, Linux or macOS from the releases (on macOS TMNT Arcade comes in a package of its own, tmnt-arcade-macos-universal.zip). Keep tmnt.zip beside the game, or drop it on its window when it asks: the first time, it takes the assets out of it.

Each device has a package of its own, its games without assets (Android's, when the release signs them), ready to take them out of your tmnt.zip on the device, beside the tool that makes your own of them on a computer (for Windows, macOS and Linux):

• Nintendo Switch (tmnt-switch.zip): TMNT.nro and TMNT Arcade.nro for the Homebrew Menu, with tmnt.zip in /switch/tmnt/ on the SD card; or TMNT NSP makes TMNT.nsp and TMNT Arcade.nsp for the HOME menu.
• Android (tmnt-android.zip): TMNT APK makes TMNT.apk and TMNT Arcade.apk with the assets inside, signed with a key of yours (ports/android/apk); a release signed with the project's key also has them in ready/, without assets, with tmnt.zip in the app's folder. Phones, tablets, and TVs with Android TV or Google TV (the Chromecast with Google TV too: its Android is 32-bit, and the APKs have both kinds), in the TV's apps with a banner.
• Anbernic's H700 handhelds (tmnt-anbernic.zip, RG40XX H...): the folder for PORTS, with tmnt.zip in PORTS/tmnt/; or TMNT Anbernic makes it with the assets inside.

What a tool makes has the game's data in it: it is yours alone, never share it. Each package's README.txt says how.

The pre-release testing, in the releases too, has the next release's changes for the players to try before it comes out: made again at each change from the branch testing, TMNT's OPTIONS showing which (V1.0.6-TEST12). It may not work yet; what you find goes in the issues.

• ARCADE: the arcade's game with no coins: START brings a player in at any time, up to four, and on a continue lets him pick his turtle again.
• SPLINTER WAY: NORMAL (5 lives and 3 continues), BOSS RUSH (from one boss to the next, 5 lives and no continues) and RONIN (one turtle against the enemies of a four-player game).
• MULTIPLAYER: up to four computers on the local network in one game (below).
• OPTIONS: controls for four players, difficulty, lives, demo sound, region (the NINJA or HERO title), video (window, full screen, sharp, smooth, bilinear or CRT pixels, integer scale, WIDE 16:10, 16:9 or 20:9, VSYNC, FPS, PRESS START blinking, still or off), volume, sound test.
• The pause in a game: CONTINUE, RESTART, QUIT GAME.
• And the Konami code on the menu.

• Keyboard: the arrows move, Z or left Ctrl attacks, X or left Alt jumps, Enter is START; Escape pauses (and goes back in the menus). F11 or Alt+Enter is the full screen, F3 the next kind of pixels. OPTIONS > CONTROLS changes each player's keys and buttons.
• Game controller: the pad or the left stick moves, A attacks, B jumps, Start is START; Back or Start pauses. Each controller is a player, in the order they are plugged in (a TV's remote after them). One the game does not know, or knows wrong, takes its line of SDL_GameControllerDB's format in gamecontrollerdb.txt, beside the game on Windows (in ~/.local/share/TMNT on Linux, ~/Library/Application Support/TMNT on macOS): the game reads it when it starts, and its line goes over the game's own.
• TMNT Arcade: 5 to 8 put a coin in each slot (a controller's Back, its player's), 9 is the service switch, and a coin and the attack bring a turtle in.
• Android: a stick where your left thumb lands, ATTACK and JUMP at the right, START (COIN in TMNT Arcade); a controller hides them. Back pauses.
• A TV's remote (Google TV, Android TV), in TMNT: the pad moves, OK attacks (and brings in a player who is not playing, or continues), back jumps (and goes back in the menus); home pauses. A game controller is better.

Up to four computers play one game on the same local network, a turtle each:

1. MULTIPLAYER > NAME: your name, as the rooms show it.
2. One computer picks HOST.
3. The others pick JOIN, and the room.
4. The host's START begins the game on all of them, with the host's settings.

A computer that stops being heard leaves after 3 seconds, its turtle standing, and the game goes on. A firewall that asks about the game should let it reach the private network. The rooms and the game's datagrams are arcade-lan's, which the ports of other decompiled arcade games share.

Python 3.10 or newer, CMake 3.20 or newer, a C11 / C++17 compiler and SDL2 2.30 or newer (on Windows its development package for Visual C++ unpacked in build/downloads/sdl2/; elsewhere the system's, libsdl2-dev on Debian and Ubuntu; or -DTMNT_STATIC_SDL2=ON to build it from its source). Clone it with its submodules and build it:

git clone --recursive https://github.com/cheviman/tmnt-port

cmake -S . -B build/cmake

cmake --build build/cmake --config Release

Both games land in build/bin/, and take their assets out of tmnt.zip the first time (beside them, or in rom/). How the port runs the game, its first run, the packages and the console version's checks are in docs/port.md; each device's build in ports/PLAN.md; the console version's plan and what is done in console/PLAN.md. The decompilation itself (its status, the tools, the assets' formats, the checks against MAME) is tmntarcade-decomp's README.

The games are free, and stay free. If you want to support the decompilations and the ports, there is Patreon, where supporters also have a say in what comes next, and GitHub Sponsors: entirely optional, nothing is locked behind either. If anyone asks you to pay for these games, it is not this project.

• This project is licensed under the BSD 3-Clause License; see LICENSE.
• The C in src/ is the game's programs decompiled into a new form: logic only, with names and comments written for this project. No ROM contents (graphics, sound, data) and no extracted assets are distributed by this project; they come from your own ROM set. The screenshots in docs/screenshots/ show the game running from this code.
• runtime/src/video.c, sound_chips.c and ym2151.c follow the behaviour of MAME's tmnt.cpp, k052109.cpp, k051960.cpp, k007232.cpp and upd7759.cpp and of ymfm's OPM (all BSD-3-Clause).
• MULTIPLAYER's rooms and datagrams are arcade-lan (lan/, a submodule), BSD 3-Clause, whose terms are in lan/LICENSE.
• The game controllers' mappings are SDL_GameControllerDB's (ports/sdl2/controllerdb, zlib License), built into the games on the computers and Android.
• The menus write with Kenney Mini and CONTROLS shows Kenney's Input Prompts (www.kenney.nl), CC0. The window port links SDL2 (zlib License); the packages carry it inside the executables, with its terms and the ones above in licenses/. The icon is Raphael's face from a friend's mural (ports/sdl2/icon/raphael_mural.png; every size made by tools/make_icon.py), nothing of the game's.
• Teenage Mutant Ninja Turtles is a trademark of its owner, and the arcade game is Konami's. This project is not affiliated with or endorsed by either, nor by Nintendo, Google or Anbernic.