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
node: 18.3.0

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` to locally run the project in `localhost:8000`

### FAQ

**How do I test a new ability/move?**
- In the `pokemon.ts` file there are overrides you can set to apply the new move/ability to your active pokemon

**How do I test a specific seed/wave?**
- In the `battle-scene.ts` file there are overrides for seed, starting level, starting wave, starting biome, and starting money


## To Do

- Add carry-over starter mechanic
- Moves
  - Complete move logic
- Abilities
  - Complete ability logic
- Pokemon summary screen
  - Add IV screen
- Capture logic
  - Critical capture
- Modifiers
  - Various mainline game items for various enhancements
- Trainers
  - Finish party pools
  - Add dialogue
  - Add reward for gym leader victories
- Battle animations
  - Fix broken battle animations (mostly ones with backgrounds)
- Modes
  - Add random mode
  - Add Nuzlocke mode

# 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

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

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

### 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`
			`## 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`
			`node: 18.3.0`

			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` to locally run the project in `localhost:8000`

			`### FAQ`

			`How do I test a new ability/move?`
			- In the `pokemon.ts` file there are overrides you can set to apply the new move/ability to your active pokemon

			`How do I test a specific seed/wave?`
			- In the `battle-scene.ts` file there are overrides for seed, starting level, starting wave, starting biome, and starting money

Create README.md 2023-04-01 14:35:50 +00:00
Add credits 2024-03-21 22:56:37 +00:00			`## To Do`
Create README.md 2023-04-01 14:35:50 +00:00
Update To Do list 2023-11-12 15:30:50 +00:00			`- Add carry-over starter mechanic`
Create README.md 2023-04-01 14:35:50 +00:00			`- Moves`
Update To Do list 2023-11-12 15:30:50 +00:00			`- Complete move logic`
Create README.md 2023-04-01 14:35:50 +00:00			`- Abilities`
Update To Do list 2023-11-12 15:30:50 +00:00			`- Complete ability logic`
Create README.md 2023-04-01 14:35:50 +00:00			`- Pokemon summary screen`
Update To Do list 2023-11-12 15:30:50 +00:00			`- Add IV screen`
Create README.md 2023-04-01 14:35:50 +00:00			`- Capture logic`
			`- Critical capture`
			`- Modifiers`
			`- Various mainline game items for various enhancements`
Update To Do list 2023-11-12 15:30:50 +00:00			`- Trainers`
			`- Finish party pools`
Add IV Scanner item 2023-11-12 17:49:06 +00:00			`- Add dialogue`
			`- Add reward for gym leader victories`
Update To Do list 2023-11-12 15:30:50 +00:00			`- Battle animations`
			`- Fix broken battle animations (mostly ones with backgrounds)`
			`- Modes`
			`- Add random mode`
			`- Add Nuzlocke mode`
Add credits 2024-03-21 22:56:37 +00:00
Update README 2024-03-30 20:09:58 +00:00			`# Credits`
			`> 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
			`### 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`

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

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

			`### 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`