Introduction - pk-hack/CoilSnake GitHub Wiki

Welcome to the CoilSnake wiki!

This guide aims to provide you with all the foundational knowledge needed to begin hacking one of the greatest games in modern history. The only prerequisites are basic computer skills, patience, and a willingness to learn.

How can EarthBound be hacked? It's on a console!

Like other console games, EarthBound can be modified by extracting its data, editing it on a computer, and compiling the data back into the game. That's what CoilSnake is all about!

Getting Started

To begin, you’ll need two essential items:

  1. The ROM file: We can't tell you how to obtain this other than from a cartridge you own.
  2. An emulator: Recommended options include:
    • Mesen: Ideal for Windows and Linux, featuring robust functionality tailored for game hackers.
    • Snes9X: A reliable choice for macOS users.

What do I need to start?

  1. CoilSnake - that's this tool! Download it here!

    • See DEVELOPMENT.md for instructions on how to run it on Mac or Linux.
  2. EBME - the map editor, which is a separate program from CoilSnake

  3. EBMusEd and the PSI Animation Editor, are programs you might want for certain kinds of data less suited for CoilSnake - for example, music sequence editing.

  4. Text Editor:
    Use a modern editor like:

  5. Image Editor:
    Recommended options include:

  6. Dependencies:
    Some tools have third-party dependencies or require interdependencies. Consult each tool’s documentation for details.

  7. Your Brain: Preferably not in a jar.

Acknowledgments

This tutorial draws heavily from Lyrositor's EB Hacking 101 guide, used with permission.

While the original guide is outdated, it served as a valuable foundation for this resource.

Additional Resources