Apply suggestions from code review

Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>
This commit is contained in:
Dean 2025-06-01 19:36:50 -07:00 committed by GitHub
parent 3957ea65d3
commit c6b0bf4262
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 10 deletions

View File

@ -16,7 +16,7 @@ Please make sure you understand everything relevant to your changes from the [Ta
## 🛠️ Development Basics
PokéRogue is built with Typescript, using the Phaser game framework.
PokéRogue is built with [Typescript](https://www.typescriptlang.org/docs/handbook/intro.html), using the [Phaser](https://github.com/phaserjs/phaser) game framework.
If you have the motivation and experience with Typescript/Javascript (or are willing to learn) you can contribute by forking the repository and making pull requests with contributions.
@ -50,10 +50,10 @@ Tests show you both how things are supposed to work and the expected "flow" to g
Once you have your feet under you, check out the [Issues](https://github.com/pagefaultgames/pokerogue/issues) page to see how you can help us!
Most issues are bugs and are labeled with their area, such as `Move`, `Ability`, `UI/UX`, etc. There are also priority labels:
- P0: Completely gamebreaking (very rare)
- P1: Major - Game crash
- P2: Minor - Incorrect (but non-crashing) move/ability/interaction
- P3: No gameplay impact - typo, minor graphical error, etc.
- `P0`: Completely gamebreaking (very rare)
- `P1`: Major - Game crash
- `P2`: Minor - Incorrect (but non-crashing) move/ability/interaction
- `P3`: No gameplay impact - typo, minor graphical error, etc.
Also under issues, you can take a look at the [List of Partial / Unimplemented Moves and Abilities](https://github.com/pagefaultgames/pokerogue/issues/3503) and the [Bug Board](https://github.com/orgs/pagefaultgames/projects/3) (the latter is essentially the same as the issues page but easier to work with).
@ -76,13 +76,13 @@ You've just made a change - how can you check if it works? You have two areas to
> This will likely be your first stop. After making a change, you'll want to spin the game up and make sure everything is as you expect. To do this, you will need a way to manipulate the game to produce the situation you're looking to test.
In the `src/overrides.ts` file there are overrides for most values you'll need to change for testing, controlled through the `overrides` object.
For example, here is how you could test a scenario where the player Pokemon has Protean and the enemy Pokemon has Pixilate:
For example, here is how you could test a scenario where the player Pokemon has the ability Drought and the enemy Pokemon has the move Water Gun:
```typescript
const overrides = {
ABILITY_OVERRIDE: Abilities.PROTEAN,
PASSIVE_ABILITY_OVERRIDE: Abilities.PIXILATE,
}
ABILITY_OVERRIDE: Abilities.DROUGHT,
OPP_MOVESET_OVERRIDE: Moves.WATER_GUN,
} satisfies Partial<InstanceType<typeof DefaultOverrides>>;
```
Read through `src/overrides.ts` file to find the override that fits your needs - there are a lot of them!
@ -112,7 +112,7 @@ The project intends for all text to be localized. That is, strings are pulled fr
To fetch translations when you first start development in your fork or to update them on your local branch, run:
```bash
npm run update-locales:remote
git submodule update --progress --init --recursive
```
### How Localizations Work

View File

@ -2,6 +2,10 @@
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
See [CONTRIBUTING.md](./CONTRIBUTING.md), this includes instructions on how to set up the game locally.
# 📝 Credits
>
> If this project contains assets you have produced and you do not see your name, **please** reach out, either [here on GitHub](https://github.com/pagefaultgames/pokerogue/issues/new) or via [Discord](https://discord.gg/pokerogue).