domtronn / nuzlocke.app

Nuzlocke Tracker - For all Pokémon games and Rom Hacks to record, track, advise on encounters, and provide boss battles & level caps
https://nuzlocke.app
BSD 3-Clause "New" or "Revised" License
111 stars 17 forks source link
nuzlocke nuzlocke-generator nuzlocke-tracker pokemon pokemon-api pokemon-game sveltekit tailwindcss

Nuzlock tracker

<img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" />

This project is designed for tracking Nuzlocke runs, the Pokemon you've encountered and their status. But it also provides information and adivce for Bosses you face.

Contributing

Currently, I'm working through entering the data for all existing games but this can easily be made to support mods or other game formats.

If you want to contribute you will need to provide 2 files, the routes.txt and league.txt which should be in the following format below named after the generation, e.g. oras.txt

League data

--1|Gym Leader Name|Gym Leader Speciality|/image/path
pokemon|level|move1,move2,move3,move4|ability|held-item
pokemon|level|move1,move2,move3,move4|ability|held-item
pokemon|level|move1,move2,move3,move4|ability|held-item

Route data

Route 1
Route 2
--Gym battle|1|gym-leader
Route 3

Patches Patches are needed by RomHacks as they often make changes to abilities, moves, items, and stats.

To support a RomHack you will need to provide a patches file containing the following

--item
item name|item sprite|item description

--move
name|type*|power*|description 

--ability
name|description

--pokemon
hp,atk,def,spa,spd,spe*|name|type1,type2*

* denotes optional fields, you can leave these blank but you must include the necessary number of |s, e.g. cut||90 will just modify the power of cut

Pokemon stats are a comma , separated list, but you should only include the modifications, e.g. ,,100 will modify the defense to 100

You can find extensive examples of these in the Nuzlocke.data project.

Alternatives

There are a lot of alternatives out there, and whilst they don't meet the needs I personally was looking for, you should absolutely check them out and thank their creators.

Useful links