Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Luminyx1 authored and jhmaster2000 committed Nov 17, 2022
1 parent e0be56a commit c84d81b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,34 @@
#### A platform for NSMBU custom code

# Our goal
The goal of this project is to provide a platform for New Super Mario Bros. U custom code for modders with the same toolset that Nintendo developers had when writing the game. We also have provided a ton of code examples and premade patches for new modders to learn from and for people who would just like to use them in their own personal mods. It also serves as a unification of multiple code hack projects in order to have a project with everything. All credits linked at the bottom of this readme.
The goal of this project is to provide a platform for New Super Mario Bros. U custom code for modders with the same toolset that Nintendo developers had when writing the game. We also have provided a ton of code examples and premade patches for new modders to learn from and for people who would just like to use them in their own personal mods. Additionaly, it serves as a unification of multiple code hack projects in order to have a project with everything. All credits linked at the bottom of this readme.
Project started on March 9 2021.

# Contributing
Just create a new Pull Request on the designated page. We will review the PR and accept if we feel that it meets our quality standard and design philosophy. If you have discovered an issue or bug, make an issue on the Issue Tracker. Suggestions can also go there.
Just create a new Pull Request on the designated page. We will review the PR and accept if we feel that it meets our quality standard and design philosophy. If you have discovered an issue or bug, make an issue on the Issue Tracker. Suggestions may also go there.

# Building
This project is intended to be compiled with the [Tachyon](https://github.com/Zenith-Team/Tachyon) build system. Keep in mind that currently this project targets version 1.3.0 of the standalone copy of New Super Mario Bros. U, but does maintain compatibility with the DLC as well. Support for the bundle will be coming soon but as of right now it is not our top priority.

# Usage
To install Tsuru onto your game, simply use the preloaded installer available at the [website](https://tsuru.nsmbu.net).

# Help
If you require any assistance for anything related to Tsuru, feel free to join our [Discord server](https://discord.nsmbu.net) and ask for help in there.

# Credits
* [AboodXD](https://github.com/aboood40091) - [NSMBU-Haxx](https://github.com/aboood40091/NSMBU-haxx) code and headers
* [Flizl](https://twitter.com/fliizzl) - Graphics
* [iHarv](https://github.com/iHarv) - Quality Assurance
* [jhmaster2000](https://github.com/jhmaster2000) - Code and headers
* [jhmaster](https://github.com/jhmaster2000) - Code and headers
* [Luminyx](https://github.com/Luminyx1) - Project lead, code, and headers
* [Newer Team](https://github.com/Newer-Team) - [Newer U](https://github.com/Newer-Team/NewerSMBU) code and headers
* [RoadrunnerWMC](https://github.com/RoadrunnerWMC) - Customizable [world map scripts](https://github.com/RoadrunnerWMC/Cobra)
* [rodmjorgeh](https://github.com/Rodmjorge) - Graphics
* [shibboleet](https://github.com/shibbo) - [Headers](https://github.com/shibbo/NSMBU-Headers/)
* [STUPID](https://github.com/stupidestmodder) - Code and headers
* [Swiftshine](https://github.com/Swiftshine) - Code and headers
* [techmuse](https://twitter.com/techmuse8) - Quality Assurance
* [techmuse](https://twitter.com/techmuse8) - Graphics and Quality Assurance
* [WillyMaker](https://www.youtube.com/channel/UCBDaY5sapkDhqlBBNJnW-Og) - Sprite data and images
* Modified dynamic_libs headers based on original implementation by [Dimok](https://github.com/dimok789) and [Maschell fork](https://github.com/Maschell/dynamic_libs)
* shiftjis.h from [Apollo PS3](https://github.com/bucanero/apollo-ps3/blob/master/include/shiftjis.h)
Expand Down

0 comments on commit c84d81b

Please sign in to comment.