diff --git a/README.md b/README.md index fa27baa608..6acae8b462 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ # Pokémon Platinum -This is a WIP decompilation of Pokémon Platinum. For instructions on how to set up the repository, please read [INSTALL.md](INSTALL.md). +This is a WIP branched fork of [pret/pokeplatinum](https://github.com/pret/pokeplatinum) dedicated to making a mod/hack friendly base. -This repository builds the following ROMs: - -* [**pokeplatinum.us.nds**](https://datomatic.no-intro.org/index.php?page=show_record&s=28&n=3541) `sha1: ce81046eda7d232513069519cb2085349896dec7` - -For contacts and other pret projects, see [pret.github.io](https://pret.github.io/). In addition to the pret Discord, also see the [VoidMatrix Discord (#decomp)](https://discord.gg/prUAgd5). +There will be a goals folder, modding info in the docs folder, and a changelog folder describing the changes made to pokeplatinum. diff --git a/docs/index.md b/docs/index.md index f098ee72ed..970067658e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,3 +11,7 @@ For more detailed information about the project as a whole, please refer to its - [2D Graphics](2d_rendering.md) - [3D Graphics](3d_rendering.md) + +## Mods + +- [Fast Gauge](mods/fast_gauge.md) diff --git a/docs/mods/fast_gauge.md b/docs/mods/fast_gauge.md new file mode 100644 index 0000000000..0b2efe0c74 --- /dev/null +++ b/docs/mods/fast_gauge.md @@ -0,0 +1,18 @@ +# Fast Gauge + +This is a quick tutorial on how to modify the gauge of exp and health bars of Plat so that the bar visually updates in subpixels per second instead of points per second. + +This mod is a backport of the healthbar fix made by the contributors of [pret/pokeheartgold](https://github.com/pret/pokeheartgold/blob/src/battle/battle_hp_bar.c#L1497) for the heartgold/soulsilver decomp. + +Fixes are written in the `diff` format, as mentioned in [Bugs and Glitches](../bugs_and_glitches.md). + +## Edit + +1. Go to [/src/battle/healthbar.c](/src/battle/healthbar.c) +2. Go to the ``UpdateGauge`` function. +3. Edit the function like so: +```diff +if (max < corrected) { +- ratio = max * 0x100 / corrected; ++ ratio = (max << 8) / corrected; +```