HintMachine

HintMachine is a "BK Game" client designed to work for the well-known multiworld ecosystem Archipelago.

It connects to a wide variety of games (through RAM peeking, save file watching, etc...) to track progress on specific "quests" which, when completed, award random location hints inside the Archipelago world you are connected to.

Given its high dependency to system calls to do RAM peeking and stuff, only Windows is supported as of now.

Currently supported games

• Bust a Move 4 (PS1)
• Dorfromantik
• F-Zero GX
• Geometry Wars Galaxies (Wii)
• Geometry Wars : Retro Evolved
• ISLANDERS
• Meteos (DS)
• One Finger Death Punch
• PAC-MAN Championship Edition DX+
• Puyo Puyo Tetris
• Rollcage Stage 2 (PS1)
• Sonic 3 Blue Spheres
• Stargunner
• Tetris Effect Connected
• Xenotilt
• Zachtronics Solitaire Collection

Usage

Release versions

• Download a release version's .zip file
• Extract it, and launch HintMachine.exe
• Connect to your Archipelago room by providing the hostname, the slot name and a password if there is one
• You can now connect to any game from HintMachine's library and profit

Running from source

• Download the source
• Open the solution with Visual Studio 2017+
• It should generate & run right away

Contributing

You are free to contribute to HintMachine's development.

Adding a game is as "simple" as:

• finding RAM addresses that contain what you're looking for (using a program like CheatEngine)
• adding a new connector class inheriting from IGameConnector for your game
• adding HintQuests inside your connector that track those RAM addresses
• testing a lot to ensure your way of accessing RAM addresses is stable over several independant executions of the game