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 **#vote** channel in the discord. 

### 💻 Environment Setup
#### Prerequisites
- node: 18.3.0
- 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`

### ❔ 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 our [Trello Board](https://trello.com/b/z10B703R/pokerogue-board) to see what we're working on

# 📝 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 Black/White 2
  - Firel (Custom Metropolis and Laboratory biome music)
  - Lmz (Custom Jungle biome music)
  - edifette (Title screen 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
  - 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

### 🎨 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 16:40:36 +01:00			`## 🛠️ Development`
Update README 2024-03-30 20:09:58 +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 #vote channel in the discord.`

Update README.md 2024-04-02 16:40:36 +01:00			`### 💻 Environment Setup`
Add link to npm/node guide to README 2024-04-21 19:09:54 +01:00			`#### Prerequisites`
			`- node: 18.3.0`
			`- 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 19:09:54 +01: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 17:34:23 +01: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.md 2024-04-02 16:40:36 +01:00			`### ❔ FAQ`
Update README 2024-03-30 20:09:58 +00:00
Adding Env files for Local Development Ease 2024-04-04 17:34:23 +01:00			`How do I test a new _______?`
Fix Shedinja passive, mummy passive, acupressure, moody, and added a second move override (#369) 2024-05-04 03:30:23 +01: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 15:35:50 +01:00
Update README.md 2024-04-02 16:40:36 +01:00			`## 🪧 To Do`
			`Check out our [Trello Board](https://trello.com/b/z10B703R/pokerogue-board) to see what we're working on`

			`# 📝 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 16:40:36 +01: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`
			`- Pokémon Black/White 2`
Add custom Jungle biome music by Lmz 2024-05-14 05:46:28 +01:00			`- Firel (Custom Metropolis and Laboratory biome music)`
			`- Lmz (Custom Jungle biome music)`
Add title screen music by edifette 2024-04-03 19:33:23 +01:00			`- edifette (Title screen music)`
Add credits 2024-03-21 22:56:37 +00:00
Update README.md 2024-04-02 16:40:36 +01: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 16:40:36 +01: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 04:27:59 +01:00			`### 🎨 UI`
Add title screen music by edifette 2024-04-03 19:33:23 +01:00			`- GAMEFREAK`
			`- LJ Birdman`

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

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

Update README.md 2024-04-02 16:40:36 +01: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 16:40:36 +01:00			`### 🎨 Trainer Portraits`
Add credits 2024-03-21 22:56:37 +00:00			`- pkmn_realidea (Paid Commissions)`

Update README.md 2024-04-02 16:40:36 +01:00			`### 🎨 Pokemon Sprites`
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`

Update README.md 2024-04-12 04:27:59 +01:00			`### 🎨 Move Animations`
Add credits 2024-03-21 22:56:37 +00:00			`- Pokémon Reborn`