mirror of
https://github.com/zeldaret/st
synced 2026-08-24 15:26:58 -04:00
Mityno
a05f3d38d0
* fix: Cleanup structure in INSTALL.md * fix: Clean undefined link * feat: Copypaste decompiling.md and start porting over * feat: Keep porting decompiling.md and adding some details * feat: Add images and fix links * Apply suggestions from code review Co-authored-by: Yanis <35189056+Yanis002@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Yanis <35189056+Yanis002@users.noreply.github.com> Done manually because I screwed-up on github * feat: Update decomp.me export instructions, adapt review about thumb region * feat: Add instructions to reserve non-actor files * feat: Add small details for LSP and reminder for installation * feat: Add instructions for coding style (format and naming) * fix: Expand on UnkSystem naming * feat: Add details for objdiff errors * feat: Add information about symbols and tips.md * feat: Add information about UnkAngleStruct * fix: Update the CI build command in tips.md with the actual one * feat: Add some information about naming guidelines * feat: Add information about vtable symbols * feat: Small improvements * feat: Update doc's links layout a bit * feat: Some updates to install.md * feat: Apply reviews * `func_ovxxx_xxxxxxx` -> `func_ovxxx_02xxxxxx` --------- Co-authored-by: Yanis <35189056+Yanis002@users.noreply.github.com>
25 lines
1.4 KiB
Markdown
25 lines
1.4 KiB
Markdown
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.
|
|
|
|
> [!NOTE]
|
|
> The project targets the European and Japanese versions, and other versions might be supported later.
|
|
|
|
## 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.
|