|
|
||
|---|---|---|
| .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 | ||
| 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 repository through Git by running the following command in your desired directory: ``bash git clone --recurse-submodules https://github.com/pagefaultgames/pokerogue ``` 1
- Run
npm installin the newly cloned folder to download required dependencies. - Run
npm run start:devto locally run the project inlocalhost:8000
If you run into any errors, reach out in the #dev-corner channel in discord
Linting
We're using Biome as our common linter and formatter.
It will run automatically during the pre-commit hook, or can be done manually via npm run biome.
To view the complete rules, check out the biome.jsonc file.
📚 Documentation
You can find the auto-generated documentation here.
Additionally, the docs folder contains a variety of documents and guides useful for aspiring contributors.
Notable topics include:
❔ 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?
- See localization.md for detailed info on everything to do with translations,
from cloning thelocalesrepository to adding new entries and submitting changes.
🪧 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.
-
If you forget to use the
--recurse-submodulesflag when cloning initially, consult localization.md
for instructions on how to clone thelocalessubmodule manually. ↩︎