757fe1a17c
* Create `CREDITS.md` * Add categories * added Firel biome * Update README.md Co-authored-by: Moka <54149968+MokaStitcher@users.noreply.github.com> * Add Leparagon to Trainer Sprites * Add balance team * Update music credits for Andr06 (new Forest BGM) * Add dev team and past contributors to credits * Add link to wiki credits page for pokemon sprites * Update indentation * Update dev credits * Add pancakes * Add wormhood * Add Mystery Event Sprites section in Art Add Past Contributors section in Balance * Standardize emojis to primary categories only * Update Mystery Event Sprites section * Fix typo * Add wiki team * Add Special Thanks section Used for external contributors/community members that aren't part of the main PokeRogue team * Add Discord mod team * Add Translation team * Add External Tools section * Update CREDITS.md * Update CREDITS.md * add missing é in Poké in various spot * Add Red (iOS App) to External Tools section * Update Red's credit * Update art credits * Update vari and kieran --------- Co-authored-by: damocleas <damocleas25@gmail.com> Co-authored-by: Moka <54149968+MokaStitcher@users.noreply.github.com> Co-authored-by: Lugiad <2070109+Adri1@users.noreply.github.com> Co-authored-by: Moka <millennium.stitcher@gmail.com> |
||
|---|---|---|
| .github | ||
| docs | ||
| public | ||
| src | ||
| .dependency-cruiser.cjs | ||
| .env | ||
| .env.beta | ||
| .env.development | ||
| .env.production | ||
| .env.test | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| CREDITS.md | ||
| LICENSE | ||
| README.md | ||
| create-test-boilerplate.js | ||
| dependency-graph.js | ||
| eslint.config.js | ||
| favicon.ico | ||
| global.d.ts | ||
| 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. To view the complete rules, check out the eslint.config.js 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.