3030fc6c9d
|
||
|---|---|---|
| .github | ||
| docs | ||
| public | ||
| src | ||
| .dependency-cruiser.cjs | ||
| .env | ||
| .env.beta | ||
| .env.development | ||
| .env.production | ||
| .env.test | ||
| .gitattributes | ||
| .gitignore | ||
| LICENSE | ||
| MEs-Roadmap-Documentation.md | ||
| MEs_Proposal_Guide.md | ||
| README.md | ||
| dependency-graph.js | ||
| eslint.config.js | ||
| favicon.ico | ||
| index.css | ||
| index.html | ||
| lefthook.yml | ||
| package-lock.json | ||
| package.json | ||
| tsconfig.json | ||
| update_exp_sprites.ps1 | ||
| vite.config.ts | ||
| vitest.config.ts | ||
| vitest.workspace.ts | ||
README.md
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
Running Locally
- 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
- Run
npm run start:devto locally run the project inlocalhost: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.tsfile there are overrides for most values you'll need to change for testing
🪧 To Do
Check out Github 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)
- Andr06 (Custom Slum and Sea 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
- koda_want_to_sleep
🎨 Move Animations
- Pokémon Reborn