Go to file
Matthew Olker 5be2a6a4e7 Variant Update 2024-05-27 13:47:15 -04:00
.github/workflows Added if statement to deploy.yml stopping local builds failing. (#1335) 2024-05-24 18:26:23 -04:00
.vscode Add unit testing support with vitest (#18) 2024-03-30 20:47:47 -04:00
docs Update README and package, re-add money formatter (#1286) 2024-05-23 12:29:18 -04:00
public Variant Update 2024-05-27 13:47:15 -04:00
src Variant Update 2024-05-27 13:47:15 -04:00
.env Adding Env files for Local Development Ease 2024-04-04 13:52:13 -04:00
.env.development Adding Env files for Local Development Ease 2024-04-04 13:52:13 -04:00
.eslintignore ESLint - The Essential Linter and Formatter for JavaScript and TypeScript (#1224) 2024-05-23 11:03:10 -04:00
.eslintrc Enforce Consistent Spacing with ESLint's space-before-blocks and keyword-spacing Rules (#1308) 2024-05-23 19:19:20 -05:00
.gitattributes Initial commit 2023-03-28 14:54:52 -04:00
.gitignore Update README and package, re-add money formatter (#1286) 2024-05-23 12:29:18 -04:00
LICENSE Update license to AGPL 3 2024-03-25 19:22:58 -04:00
README.md Update README and package, re-add money formatter (#1286) 2024-05-23 12:29:18 -04:00
favicon.ico Replace favicon with no BG version 2024-03-25 12:45:45 -04:00
index.css Reapply stat change feature with fixes 2024-04-30 23:02:16 -04:00
index.html meta charset should be ordered before any elements containing text 2024-05-14 14:40:24 -04:00
lefthook.yml ESLint - The Essential Linter and Formatter for JavaScript and TypeScript (#1224) 2024-05-23 11:03:10 -04:00
package-lock.json Update README and package, re-add money formatter (#1286) 2024-05-23 12:29:18 -04:00
package.json Update README and package, re-add money formatter (#1286) 2024-05-23 12:29:18 -04:00
tsconfig.json Disable source map 2024-04-28 23:15:12 -04:00
update_exp_sprites.ps1 Fix crash with certain animated variant sprites 2024-04-26 02:00:58 -04:00
vite.config.js Disable source map in Vite config 2024-04-28 23:21:22 -04:00
vite.env.d.ts Adding Env files for Local Development Ease 2024-04-04 13:52:13 -04:00
vitest.config.js refactor executed code while importing and initializing all of these in loading-scene (#1125) 2024-05-24 13:46:30 -04:00

README.md

PokéRogue

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

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 our Trello 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)

🎵 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
  • 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