| .github | ||
| docs | ||
| public | ||
| scripts | ||
| src | ||
| test | ||
| .dependency-cruiser.cjs | ||
| .editorconfig | ||
| .env | ||
| .env.beta | ||
| .env.development | ||
| .env.production | ||
| .env.test | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .nvmrc | ||
| biome.jsonc | ||
| create-test-boilerplate.js | ||
| CREDITS.md | ||
| dependency-graph.js | ||
| eslint.config.js | ||
| favicon.ico | ||
| global.d.ts | ||
| index.css | ||
| index.html | ||
| lefthook.yml | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| update_exp_sprites.ps1 | ||
| vite.config.ts | ||
| vitest.config.ts | ||
| vitest.workspace.ts | ||
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: 22.14.0
- npm: how to install
Running Locally
- Clone the repo and in the root directory run
npm install- if you run into any errors, check out Troubleshooting below and then reach out in the #dev-corner channel in discord
- Run
npm run start:devto locally run the project inlocalhost:8000
Troubleshooting:
- fatal: not a git repository (or any of the parent directories): .git
- Install git, and then run
git initin the folder of the project.
- Install git, and then run
- Lefthook seems to be stuck running the post-merge check
- You likely need to press 'Enter'.
- I ran
npm run start:devbut it didn't seem to start anything- If the last message before your command was
lefthook something something post-merge, yourruncommand got eaten by the Lefthook monster, but running it again will work.
- If the last message before your command was
- I started the game but all text looks like code instead of actual sentences
- You likely downloaded the code instead of cloning the repository, meaning that the localization submodule did not get included. Can you start again and clone the repository instead of downloading the code as a ZIP file?
Linting
We're using Biome 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 biome script. To view the complete rules, check out the biome.jsonc file.
📚 Documentation
You can find the auto-generated documentation here. For information on enemy AI, check out the enemy-ai.md file. For detailed guidelines on documenting your code, refer to the comments.md file.
❔ 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
How do I retrieve the translations?
- The translations were moved to the dedicated translation repository and are now applied as a submodule in this project.
- The command to retrieve the translations is
git submodule update --init --recursive. If you still struggle to get it working, please reach out to #dev-corner channel in Discord.
🪧 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, please reach out, either here on GitHub or via Discord.
Thank you to all the wonderful people that have contributed to the PokéRogue project! You can find the credits here.