pokerogue/README.md

<picture><img src="./public/images/logo.png" width="300" alt="PokéRogue"></picture>

PokéRogue is a browser based Pokémon fangame heavily inspired by the roguelite genre. Battle endlessly while gathering stacking items, exploring many different biomes, fighting trainers, bosses, and more! 

# Contributing
## 🛠️ Development
If you have the motivation and experience with Typescript/Javascript (or are willing to learn) please feel free to fork the repository and make pull requests with contributions. If you don't know what to work on but want to help, reference the below **To-Do** section or the **#feature-vote** channel in the discord. 

### 💻 Environment Setup
#### Prerequisites
- node: 20.13.1
- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

#### Running Locally
1. Clone the repo and in the root directory run `npm install`
    - *if you run into any errors, reach out in the **#dev-corner** channel in discord*
2. Run `npm run start:dev` to locally run the project in `localhost:8000`

#### Linting
We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run eslint` script. 

### ❔ FAQ 

**How do I test a new _______?**
- In the `src/overrides.ts` file there are overrides for most values you'll need to change for testing


## 🪧 To Do
Check out [Github Issues](https://github.com/pagefaultgames/pokerogue/issues) to see how can you help us!

# 📝 Credits
> If this project contains assets you have produced and you do not see your name here, **please** reach out.

### 🎵 BGM
  - Pokémon Mystery Dungeon: Explorers of Sky
    - Arata Iiyoshi
    - Hideki Sakamoto
    - Keisuke Ito
    - Ken-ichi Saito
    - Yoshihiro Maeda
  - Pokémon Black/White
    - Go Ichinose
    - Hitomi Sato
    - Shota Kageyama
  - Pokémon Mystery Dungeon: Rescue Team DX
    - Keisuke Ito
    - Arata Iiyoshi
    - Atsuhiro Ishizuna
  - Pokémon HeartGold/SoulSilver
  - Pokémon Black/White 2
  - Pokémon X/Y
  - Pokémon Omega Ruby/Alpha Sapphire
  - Pokémon Sun/Moon
  - Pokémon Ultra Sun/Ultra Moon
  - Pokémon Sword/Shield
  - Pokémon Scarlet/Violet
  - Firel (Custom Laboratory, Metropolis, Seabed, and Space biome music)
  - Lmz (Custom Jungle biome music)

### 🎵 Sound Effects
  - Pokémon Emerald
  - Pokémon Black/White

### 🎨 Backgrounds
  - Squip (Paid Commissions)
  - Contributions by Someonealive-QN

### 🎨 UI
  - GAMEFREAK
  - LJ Birdman

### 🎨 Pagefault Games Intro
  - Spectremint

### 🎨 Game Logo
  - Gonstar (Paid Commission)

### 🎨 Trainer Sprites
  - GAMEFREAK (Pokémon Black/White 2, Pokémon Diamond/Pearl)
  - kyledove
  - Brumirage
  - pkmn_realidea (Paid Commissions)

### 🎨 Trainer Portraits
  - pkmn_realidea (Paid Commissions)

### 🎨 Pokemon Sprites and Animation
  - GAMEFREAK (Pokémon Black/White 2)
  - Smogon Sprite Project (Various Artists)
  - Skyflyer
  - Nolo33
  - Ebaru
  - EricLostie
  - KingOfThe-X-Roads
  - kiriaura
  - Caruban
  - Sopita_Yorita
  - Azrita
  - AshnixsLaw
  - Hellfire0raptor
  - RetroNC
  - Franark122k
  - OldSoulja
  - PKMarioG
  - ItsYugen
  - lucasomi
  - Pkm Sinfonia
  - Poki Papillon
  - Fleimer_
  - bizcoeindoloro
  - mangalos810
  - Involuntary-Twitch
  - selstar

### 🎨 Move Animations
  - Pokémon Reborn
Update README.md 2024-03-30 20:12:09 +00:00			`<picture><img src="./public/images/logo.png" width="300" alt="PokéRogue"></picture>`
Update README 2024-03-30 20:09:58 +00:00
			`PokéRogue is a browser based Pokémon fangame heavily inspired by the roguelite genre. Battle endlessly while gathering stacking items, exploring many different biomes, fighting trainers, bosses, and more!`

			`# Contributing`
Update README.md 2024-04-02 15:40:36 +00:00			`## 🛠️ Development`
Update README.md (#1080) 2024-05-18 04:58:51 +00:00			`If you have the motivation and experience with Typescript/Javascript (or are willing to learn) please feel free to fork the repository and make pull requests with contributions. If you don't know what to work on but want to help, reference the below To-Do section or the #feature-vote channel in the discord.`
Update README 2024-03-30 20:09:58 +00:00
Update README.md 2024-04-02 15:40:36 +00:00			`### 💻 Environment Setup`
Add link to npm/node guide to README 2024-04-21 18:09:54 +00:00			`#### Prerequisites`
Update README and package, re-add money formatter (#1286) 2024-05-23 16:29:18 +00:00			`- node: 20.13.1`
Add link to npm/node guide to README 2024-04-21 18:09:54 +00:00			`- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)`
Update README 2024-03-30 20:09:58 +00:00
Add link to npm/node guide to README 2024-04-21 18:09:54 +00:00			`#### Running Locally`
Update README 2024-03-30 20:09:58 +00:00			1. Clone the repo and in the root directory run `npm install`
			`- if you run into any errors, reach out in the #dev-corner* channel in discord*`
Adding Env files for Local Development Ease 2024-04-04 16:34:23 +00:00			2. Run `npm run start:dev` to locally run the project in `localhost:8000`
Update README 2024-03-30 20:09:58 +00:00
Update README and package, re-add money formatter (#1286) 2024-05-23 16:29:18 +00:00			`#### Linting`
			We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run eslint` script.

Update README.md 2024-04-02 15:40:36 +00:00			`### ❔ FAQ`
Update README 2024-03-30 20:09:58 +00:00
Adding Env files for Local Development Ease 2024-04-04 16:34:23 +00:00			`How do I test a new _______?`
Fix Shedinja passive, mummy passive, acupressure, moody, and added a second move override (#369) 2024-05-04 02:30:23 +00:00			- In the `src/overrides.ts` file there are overrides for most values you'll need to change for testing
Update README 2024-03-30 20:09:58 +00:00
Create README.md 2023-04-01 14:35:50 +00:00
Update README.md 2024-04-02 15:40:36 +00:00			`## 🪧 To Do`
Removed trello reference. (#1508) 2024-05-28 18:58:01 +00:00			`Check out [Github Issues](https://github.com/pagefaultgames/pokerogue/issues) to see how can you help us!`
Update README.md 2024-04-02 15:40:36 +00:00
			`# 📝 Credits`
Update README 2024-03-30 20:09:58 +00:00			`> If this project contains assets you have produced and you do not see your name here, please reach out.`
Add credits 2024-03-21 22:56:37 +00:00
Update README.md 2024-04-02 15:40:36 +00:00			`### 🎵 BGM`
Add credits 2024-03-21 22:56:37 +00:00			`- Pokémon Mystery Dungeon: Explorers of Sky`
			`- Arata Iiyoshi`
			`- Hideki Sakamoto`
			`- Keisuke Ito`
			`- Ken-ichi Saito`
			`- Yoshihiro Maeda`
			`- Pokémon Black/White`
			`- Go Ichinose`
			`- Hitomi Sato`
			`- Shota Kageyama`
			`- Pokémon Mystery Dungeon: Rescue Team DX`
			`- Keisuke Ito`
			`- Arata Iiyoshi`
			`- Atsuhiro Ishizuna`
[Enhancement] Add more legendary battle music; add music preference setting (#1753) * Add more legendary battle music; add music preference setting * Replace BDSP tracks "Souless", they say. Naysayers, I say. * Update for settings menu refactor * Remove unnecessary Reshiram/Zekrom music calls The default legendary battle music is the Reshiram & Zekrom battle theme anyways, so removing these lines make it functionally identical. * Update for settings menu refactor AGAIN 2024-06-08 02:52:14 +00:00			`- Pokémon HeartGold/SoulSilver`
Add credits 2024-03-21 22:56:37 +00:00			`- Pokémon Black/White 2`
[Enhancement] Add more legendary battle music; add music preference setting (#1753) * Add more legendary battle music; add music preference setting * Replace BDSP tracks "Souless", they say. Naysayers, I say. * Update for settings menu refactor * Remove unnecessary Reshiram/Zekrom music calls The default legendary battle music is the Reshiram & Zekrom battle theme anyways, so removing these lines make it functionally identical. * Update for settings menu refactor AGAIN 2024-06-08 02:52:14 +00:00			`- Pokémon X/Y`
			`- Pokémon Omega Ruby/Alpha Sapphire`
			`- Pokémon Sun/Moon`
			`- Pokémon Ultra Sun/Ultra Moon`
			`- Pokémon Sword/Shield`
			`- Pokémon Scarlet/Violet`
Add new custom biome music by Firel (#2681) 2024-06-28 16:26:06 +00:00			`- Firel (Custom Laboratory, Metropolis, Seabed, and Space biome music)`
Add custom Jungle biome music by Lmz 2024-05-14 04:46:28 +00:00			`- Lmz (Custom Jungle biome music)`
Add credits 2024-03-21 22:56:37 +00:00
Update README.md 2024-04-02 15:40:36 +00:00			`### 🎵 Sound Effects`
Add credits 2024-03-21 22:56:37 +00:00			`- Pokémon Emerald`
			`- Pokémon Black/White`

Update README.md 2024-04-02 15:40:36 +00:00			`### 🎨 Backgrounds`
Add credits 2024-03-21 22:56:37 +00:00			`- Squip (Paid Commissions)`
			`- Contributions by Someonealive-QN`

Update README.md 2024-04-12 03:27:59 +00:00			`### 🎨 UI`
Add title screen music by edifette 2024-04-03 18:33:23 +00:00			`- GAMEFREAK`
			`- LJ Birdman`

Add Pagefault Games intro 2024-04-15 17:10:09 +00:00			`### 🎨 Pagefault Games Intro`
			`- Spectremint`

Update README.md 2024-04-02 15:40:36 +00:00			`### 🎨 Game Logo`
Add credits 2024-03-21 22:56:37 +00:00			`- Gonstar (Paid Commission)`

Update README.md 2024-04-02 15:40:36 +00:00			`### 🎨 Trainer Sprites`
Add credits 2024-03-21 22:56:37 +00:00			`- GAMEFREAK (Pokémon Black/White 2, Pokémon Diamond/Pearl)`
			`- kyledove`
			`- Brumirage`
			`- pkmn_realidea (Paid Commissions)`

Update README.md 2024-04-02 15:40:36 +00:00			`### 🎨 Trainer Portraits`
Add credits 2024-03-21 22:56:37 +00:00			`- pkmn_realidea (Paid Commissions)`

Add selstar to credits (#1180) 2024-05-20 21:11:36 +00:00			`### 🎨 Pokemon Sprites and Animation`
Add credits 2024-03-21 22:56:37 +00:00			`- GAMEFREAK (Pokémon Black/White 2)`
			`- Smogon Sprite Project (Various Artists)`
			`- Skyflyer`
			`- Nolo33`
			`- Ebaru`
			`- EricLostie`
			`- KingOfThe-X-Roads`
			`- kiriaura`
			`- Caruban`
			`- Sopita_Yorita`
			`- Azrita`
			`- AshnixsLaw`
			`- Hellfire0raptor`
			`- RetroNC`
			`- Franark122k`
			`- OldSoulja`
			`- PKMarioG`
			`- ItsYugen`
			`- lucasomi`
			`- Pkm Sinfonia`
			`- Poki Papillon`
			`- Fleimer_`
			`- bizcoeindoloro`
			`- mangalos810`
			`- Involuntary-Twitch`
Add selstar to credits (#1180) 2024-05-20 21:11:36 +00:00			`- selstar`
Add credits 2024-03-21 22:56:37 +00:00
Update README.md 2024-04-12 03:27:59 +00:00			`### 🎨 Move Animations`
Add credits 2024-03-21 22:56:37 +00:00			`- Pokémon Reborn`