The Legend of Zelda: Spirit Tracks  
[![Build Status]][actions] [![Progress]][decomp.dev] [![Discord Badge]][discord]
=============

[Build Status]: https://github.com/zeldaret/st/actions/workflows/build.yml/badge.svg
[actions]: https://github.com/zeldaret/st/actions/workflows/build.yml
[Progress]: https://decomp.dev/zeldaret/st.svg?mode=shield&label=Code
[decomp.dev]: https://decomp.dev/zeldaret/st
[Discord Badge]: https://img.shields.io/discord/688807550715560050?color=%237289DA&logo=discord&logoColor=%23FFFFFF
[discord]: https://discord.com/invite/DqwyCBYKqf/

**Work in progress!** This project aims to recreate source code for ***The Legend of Zelda: Spirit Tracks*** by decompiling its code by hand. **The repository does not contain assets or assembly code.** To build the ROM, you must own an existing copy of the game to extract assets from.

It builds the following versions:

Name | Description       | SHA1 Hash of input ROM(s)
---- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------
jp   | Japan Revision 0  | `eaee3602b8a2235211b2e20cdcd4cb357956a264`
eur  | Europe Revision 0 | `9e99cc803a14ce038eb908db585431f8254f09ee`
eur1 | Europe Revision 1 | `dcb221a89acb894503a461c2c7d4cfdad9a06b68`<br>`b9096f46e9163750a9e3f6c2fc0758e6094b6135`<br>`4efbff9a263fe622f3f7e7cfb7bea8046b86e57d`
usa  | USA Revision 0    | `1f0921b5e99db9d92d24710f1b004e4f3c997b73`

The default version is `eur`, i.e. the Europe Revision 0 ROM.

## How to install
See [INSTALL.md](INSTALL.md) for instructions on how to install the project.

## Contribution
A work in progress, but [CONTRIBUTING.md](CONTRIBUTING.md) has guidelines for how to get started and contribute to the project. Make sure to follow instructions on [installation](#how-to-install) first.

## Documentation
See [/docs](/docs) for documentation about the game and other useful information about the project.