pokerogue/README.md

119 lines
3.4 KiB
Markdown
Raw Normal View History

2024-03-30 20:12:09 +00:00
<picture><img src="./public/images/logo.png" width="300" alt="PokéRogue"></picture>
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!
2024-03-30 20:09:58 +00:00
# Contributing
2024-04-02 15:40:36 +00:00
## 🛠️ 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.
2024-03-30 20:09:58 +00:00
2024-04-02 15:40:36 +00:00
### 💻 Environment Setup
2024-04-21 18:09:54 +00:00
#### Prerequisites
- node: 20.13.1
2024-04-21 18:09:54 +00:00
- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
2024-03-30 20:09:58 +00:00
2024-04-21 18:09:54 +00:00
#### Running Locally
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*
2. Run `npm run start:dev` to locally run the project in `localhost:8000`
2024-03-30 20:09:58 +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.
### ❔ FAQ
2024-03-30 20:09:58 +00:00
**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
2024-03-30 20:09:58 +00:00
2023-04-01 14:35:50 +00:00
2024-04-02 15:40:36 +00:00
## 🪧 To Do
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!
2024-04-02 15:40:36 +00:00
# 📝 Credits
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.
2024-03-21 22:56:37 +00:00
2024-04-02 15:40:36 +00:00
### 🎵 BGM
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 HeartGold/SoulSilver
2024-03-21 22:56:37 +00:00
- 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)
2024-05-14 04:46:28 +00:00
- Lmz (Custom Jungle biome music)
- Andr06 (Custom Slum and Sea biome music)
2024-03-21 22:56:37 +00:00
2024-04-02 15:40:36 +00:00
### 🎵 Sound Effects
2024-03-21 22:56:37 +00:00
- Pokémon Emerald
- Pokémon Black/White
2024-04-02 15:40:36 +00:00
### 🎨 Backgrounds
2024-03-21 22:56:37 +00:00
- Squip (Paid Commissions)
- Contributions by Someonealive-QN
2024-04-12 03:27:59 +00:00
### 🎨 UI
2024-04-03 18:33:23 +00:00
- GAMEFREAK
- LJ Birdman
2024-04-15 17:10:09 +00:00
### 🎨 Pagefault Games Intro
- Spectremint
2024-04-02 15:40:36 +00:00
### 🎨 Game Logo
2024-03-21 22:56:37 +00:00
- Gonstar (Paid Commission)
2024-04-02 15:40:36 +00:00
### 🎨 Trainer Sprites
2024-03-21 22:56:37 +00:00
- GAMEFREAK (Pokémon Black/White 2, Pokémon Diamond/Pearl)
- kyledove
- Brumirage
- pkmn_realidea (Paid Commissions)
2024-04-02 15:40:36 +00:00
### 🎨 Trainer Portraits
2024-03-21 22:56:37 +00:00
- pkmn_realidea (Paid Commissions)
2024-05-20 21:11:36 +00:00
### 🎨 Pokemon Sprites and Animation
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
2024-05-20 21:11:36 +00:00
- selstar
2024-06-13 00:17:17 +00:00
- koda_want_to_sleep
2024-03-21 22:56:37 +00:00
2024-04-12 03:27:59 +00:00
### 🎨 Move Animations
2024-03-21 22:56:37 +00:00
- Pokémon Reborn