From b8b73bf219c1f4050f021f6c1be878f6ef1fc101 Mon Sep 17 00:00:00 2001 From: psf <77138753+pkmnsnfrn@users.noreply.github.com> Date: Sat, 17 May 2025 10:33:22 -0700 Subject: [PATCH] Add CREDITS.md & FEATURES.md, rewrite README.md & INSTALL.md (#6700) --- .all-contributorsrc | 126 +++++++++++ .../ISSUE_TEMPLATE/01_battle_engine_bugs.yaml | 32 ++- .../ISSUE_TEMPLATE/02_battle_ai_issues.yaml | 32 ++- .../ISSUE_TEMPLATE/03_feature_requests.yaml | 23 +- .github/ISSUE_TEMPLATE/04_other_errors.yaml | 32 ++- .github/pull_request_template.md | 51 +++-- CREDITS.md | 79 ++++++- FEATURES.md | 146 ++++++++++++ INSTALL.md | 74 +++++- README.md | 214 +++--------------- 10 files changed, 575 insertions(+), 234 deletions(-) create mode 100644 .all-contributorsrc create mode 100644 FEATURES.md diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000000..6d981eda79 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,126 @@ +{ + "projectName": "pokeemerald-expansion", + "projectOwner": "rh-hideout", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "CREDITS.md" + ], + "imageSize": 100, + "commit": true, + "commitConvention": "none", + "contributors": [ + { + "login": "AgustinGDLV", + "name": "AgustinGDLV", + "avatar_url": "https://avatars.githubusercontent.com/u/103095241?v=4", + "profile": "https://github.com/AgustinGDLV", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "AlexOn1ine", + "name": "Alex", + "avatar_url": "https://avatars.githubusercontent.com/u/93446519?v=4", + "profile": "https://github.com/AlexOn1ine", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "Bassoonian", + "name": "Bassoonian", + "avatar_url": "https://avatars.githubusercontent.com/u/16993385?v=4", + "profile": "https://github.com/Bassoonian", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "DizzyEggg", + "name": "DizzyEggg", + "avatar_url": "https://avatars.githubusercontent.com/u/16259973?v=4", + "profile": "https://github.com/DizzyEggg", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "ghoulslash", + "name": "ghoulslash", + "avatar_url": "https://avatars.githubusercontent.com/u/41651341?v=4", + "profile": "https://github.com/ghoulslash", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "hedara90", + "name": "hedara90", + "avatar_url": "https://avatars.githubusercontent.com/u/149414898?v=4", + "profile": "https://github.com/hedara90", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "mrgriffin", + "name": "Martin Griffin", + "avatar_url": "https://avatars.githubusercontent.com/u/838573?v=4", + "profile": "http://www.martin-griffin.com/", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "Pawkkie", + "name": "Pawkkie", + "avatar_url": "https://avatars.githubusercontent.com/u/61265402?v=4", + "profile": "https://github.com/Pawkkie", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "SBird1337", + "name": "Philipp AUER", + "avatar_url": "https://avatars.githubusercontent.com/u/3799173?v=4", + "profile": "https://github.com/SBird1337", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "tertu-m", + "name": "tertu", + "avatar_url": "https://avatars.githubusercontent.com/u/836640?v=4", + "profile": "https://github.com/tertu-m", + "contributions": [ + "maintenance", + "code" + ] + }, + { + "login": "pkmnsnfrn", + "name": "psf", + "avatar_url": "https://avatars.githubusercontent.com/u/77138753?v=4", + "profile": "https://linktr.ee/pkmnsnfrn", + "contributions": [ + "maintenance", + "code" + ] + } + ], + "contributorsPerLine": 7, + "linkToUsage": true +} diff --git a/.github/ISSUE_TEMPLATE/01_battle_engine_bugs.yaml b/.github/ISSUE_TEMPLATE/01_battle_engine_bugs.yaml index d1ee2861af..9d39f5e10a 100644 --- a/.github/ISSUE_TEMPLATE/01_battle_engine_bugs.yaml +++ b/.github/ISSUE_TEMPLATE/01_battle_engine_bugs.yaml @@ -6,22 +6,42 @@ body: attributes: value: | Please fill in all required fields with as many details as possible. + Once your bug is posted, make sure you and your collaborators are added to `CREDITS.md` by [tagging the bot on GitHub](https://github.com/rh-hideout/pokeemerald-expansion/wiki/CREDITS.md-Frequently-Asked-Questions). EVERY contribution matters, even reporting bugs! - type: textarea id: description attributes: label: Description description: | - Describe the issue you are experiencing. - Attach images/videos if possible. + What behavior are you expecting to happen? What behavior are you observing instead? placeholder: | - Please enter a description of the issue. Here you can also attach log screenshots, gifs or a video + Please be as descriptive as possible. validations: required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: | + What exact steps can somebody else follow in order to recreate the issue on their own? + placeholder: | + Provide as much context as possible as to what was done to create the issue. + validations: + required: true + - type: textarea + id: media + attributes: + label: Images / Video + description: | + Do you have images or videos to show the problem happen? + placeholder: | + Here you can also attach logs, screenshots, gifs or a video. + validations: + required: false - type: dropdown id: version attributes: label: Version - description: What version of pokeemerald-expansion are you using as a base? + description: What version of pokeemerald-expansion are you using? options: - 1.11.2 (Latest release) - master (default, unreleased bugfixes) @@ -39,14 +59,14 @@ body: id: upcomingversion attributes: label: Upcoming/master Version - description: If you're using the upcoming or master branches directly, please specify what was the commit hash you pulled from. + description: If you're using the `upcoming` or `master` branches directly, please use the following command to give us the commit hash that you are on. `git log --merges RHH/upcoming -1 --format=%H` Replace `upcoming` with `master` if you're using `master`. validations: required: false - type: input id: contact attributes: label: Discord contact info - description: Provide your Discord tag here so we can contact you in case we need more details. Be sure to join our server ([here](https://discord.gg/6CzjAG6GZk)). + description: Provide your Discord tag here so we can contact you in case we need more details. Discussion around **`pokeemerald-expansion`** happens in our [Discord server](https://discord.gg/6CzjAG6GZk). placeholder: ex. Lunos#4026 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/02_battle_ai_issues.yaml b/.github/ISSUE_TEMPLATE/02_battle_ai_issues.yaml index 79669a28dc..7de92c1960 100644 --- a/.github/ISSUE_TEMPLATE/02_battle_ai_issues.yaml +++ b/.github/ISSUE_TEMPLATE/02_battle_ai_issues.yaml @@ -6,22 +6,42 @@ body: attributes: value: | Please fill in all required fields with as many details as possible. + Once your bug is posted, make sure you and your collaborators are added to `CREDITS.md` by [tagging the bot on GitHub](https://github.com/rh-hideout/pokeemerald-expansion/wiki/CREDITS.md-Frequently-Asked-Questions). EVERY contribution matters, even reporting bugs! - type: textarea id: description attributes: label: Description description: | - Describe the issue you are experiencing. - Attach images/videos if possible. + What behavior are you expecting to happen? What behavior are you observing instead? placeholder: | - Please enter a description of the issue. Here you can also attach log screenshots, gifs or a video + Please be as descriptive as possible. validations: required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: | + What exact steps can somebody else follow in order to recreate the issue on their own? + placeholder: | + Provide as much context as possible as to what was done to create the issue. + validations: + required: true + - type: textarea + id: media + attributes: + label: Images / Video + description: | + Do you have images or videos to show the problem happen? + placeholder: | + Here you can also attach logs, screenshots, gifs or a video. + validations: + required: false - type: dropdown id: version attributes: label: Version - description: What version of pokeemerald-expansion are you using as a base? + description: What version of pokeemerald-expansion are you using? options: - 1.11.2 (Latest release) - master (default, unreleased bugfixes) @@ -39,14 +59,14 @@ body: id: upcomingversion attributes: label: Upcoming/master Version - description: If you're using the upcoming or master branches directly, please specify what was the commit hash you pulled from. + description: If you're using the `upcoming` or `master` branches directly, please use the following command to give us the commit hash that you are on. `git log --merges RHH/upcoming -1 --format=%H` Replace `upcoming` with `master` if you're using `master`. validations: required: false - type: input id: contact attributes: label: Discord contact info - description: Provide your Discord tag here so we can contact you in case we need more details. Be sure to join our server ([here](https://discord.gg/6CzjAG6GZk)). + description: Provide your Discord tag here so we can contact you in case we need more details. Discussion around **`pokeemerald-expansion`** happens in our [Discord server](https://discord.gg/6CzjAG6GZk). placeholder: ex. Lunos#4026 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/03_feature_requests.yaml b/.github/ISSUE_TEMPLATE/03_feature_requests.yaml index 8d56216265..fea47f7354 100644 --- a/.github/ISSUE_TEMPLATE/03_feature_requests.yaml +++ b/.github/ISSUE_TEMPLATE/03_feature_requests.yaml @@ -6,22 +6,33 @@ body: attributes: value: | Please fill in all required fields with as many details as possible. + Once your feature request is posted, make sure you and your collaborators are added to `CREDITS.md` by [tagging the bot on GitHub](https://github.com/rh-hideout/pokeemerald-expansion/wiki/CREDITS.md-Frequently-Asked-Questions). EVERY contribution matters, even requesting issues! + - type: textarea - id: description + id: behavior attributes: - label: Description + label: Behavior Description description: | - Describe the issue you are experiencing. - Attach images/videos if possible. + What is the current behavior? What behavior would you expect your feature request to provide? What other information can you provide to help your feature get implemented? placeholder: | - Please enter a description of the issue. Here you can also attach log screenshots, gifs or a video + Provide as much context as possible. validations: required: true + - type: textarea + id: media + attributes: + label: Images / Video + description: | + Have other projects or games solved this problem? Do you have images or video to show this happening? + placeholder: | + Here you can also attach logs, screenshots, gifs or a video. + validations: + required: false - type: input id: contact attributes: label: Discord contact info - description: Provide your Discord tag here so we can contact you in case we need more details. Be sure to join our server ([here](https://discord.gg/6CzjAG6GZk)). + description: Provide your Discord tag here so we can contact you in case we need more details. Discussion around **pokeemerald-expansion** happens in our [Discord server](https://discord.gg/6CzjAG6GZk). placeholder: ex. Lunos#4026 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/04_other_errors.yaml b/.github/ISSUE_TEMPLATE/04_other_errors.yaml index b8cd2c7cb5..b0c89c5d24 100644 --- a/.github/ISSUE_TEMPLATE/04_other_errors.yaml +++ b/.github/ISSUE_TEMPLATE/04_other_errors.yaml @@ -6,22 +6,42 @@ body: attributes: value: | Please fill in all required fields with as many details as possible. + Once your bug is posted, make sure you and your collaborators are added to `CREDITS.md` by [tagging the bot on GitHub](https://github.com/rh-hideout/pokeemerald-expansion/wiki/CREDITS.md-Frequently-Asked-Questions). EVERY contribution matters, even creating issues! - type: textarea id: description attributes: label: Description description: | - Describe the issue you are experiencing. - Attach images/videos if possible. + What behavior are you expecting to happen? What behavior are you observing instead? placeholder: | - Please enter a description of the issue. Here you can also attach log screenshots, gifs or a video + Please be as descriptive as possible. validations: required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: | + What exact steps can somebody else follow in order to recreate the issue on their own? + placeholder: | + Provide as much context as possible as to what was done to create the issue. + validations: + required: false + - type: textarea + id: media + attributes: + label: Images / Video + description: | + Do you have images or videos to show the problem happen? + placeholder: | + Here you can also attach logs, screenshots, gifs or a video. + validations: + required: false - type: dropdown id: version attributes: label: Version - description: What version of pokeemerald-expansion are you using as a base? + description: What version of pokeemerald-expansion are you using? options: - 1.11.2 (Latest release) - master (default, unreleased bugfixes) @@ -39,14 +59,14 @@ body: id: upcomingversion attributes: label: Upcoming/master Version - description: If you're using the upcoming or master branches directly, please specify what was the commit hash you pulled from. + description: If you're using the `upcoming` or `master` branches directly, please use the following command to give us the commit hash that you are on. `git log --merges RHH/upcoming -1 --format=%H` Replace `upcoming` with `master` if you're using `master`. validations: required: false - type: input id: contact attributes: label: Discord contact info - description: Provide your Discord tag here so we can contact you in case we need more details. Be sure to join our server ([here](https://discord.gg/6CzjAG6GZk)). + description: Provide your Discord tag here so we can contact you in case we need more details. Discussion around **`pokeemerald-expansion`** happens in our [Discord server](https://discord.gg/6CzjAG6GZk). placeholder: ex. Lunos#4026 validations: required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9a04e86f2b..dc900e224e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,41 @@ - + - - - + + + + + + + + + + + ## Description - - + -## Images - - +## Media + ## Issue(s) that this PR fixes - - + -## **People who collaborated with me in this PR** - - - - + + + + + ## Feature(s) this PR does NOT handle: - - + + ## Things to note in the release changelog: - - - + + -## **Discord contact info** - +## Discord contact info + + diff --git a/CREDITS.md b/CREDITS.md index 70203c4f93..9024179556 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,4 +1,81 @@ -## Mega Evolution Overworld Sprite Credits: + + + + + + + + + + +## Credits ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AgustinGDLV
AgustinGDLV
🚧 💻		Alex
Alex
🚧 💻		Bassoonian
Bassoonian
🚧 💻		DizzyEggg
DizzyEggg
🚧 💻		ghoulslash
ghoulslash
🚧 💻		hedara90
hedara90
🚧 💻		Martin Griffin
Martin Griffin
🚧 💻
Pawkkie
Pawkkie
🚧 💻		Philipp AUER
Philipp AUER
🚧 💻		tertu
tertu
🚧 💻		psf
psf
🚧 💻
+ + Add your contributions + +
+ + + + + + +## Other Credits +### Mega Evolution Overworld Sprite Credits: - [princess-phoenix](https://www.deviantart.com/princess-phoenix) - [larryturbo](https://www.deviantart.com/larryturbo) - [kidkatt](https://www.deviantart.com/kidkatt) + +## Resources +- [Sugimori Palettes and Sprites](https://www.pokecommunity.com/showthread.php?t=336945) +- [DS Style Gen VI Sprites](https://www.pokecommunity.com/showthread.php?t=314422) +- [Gen VII and Beyond Sprites](https://www.pokecommunity.com/showthread.php?t=368703) +- Some icons ripped from [Pokemon Gaia](https://www.pokecommunity.com/showthread.php?t=326118) +- [Data Files](https://www.pokecommunity.com/showthread.php?t=417909) +- [Complete FireRed Upgrade](https://github.com/Skeli789/Complete-Fire-Red-Upgrade) +- [pokeemerald](https://github.com/pret/pokeemerald/) + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file diff --git a/FEATURES.md b/FEATURES.md new file mode 100644 index 0000000000..142df9da3f --- /dev/null +++ b/FEATURES.md @@ -0,0 +1,146 @@ +# What features are included? +- ***IMPORTANT*❗❗ Read through these to learn what features you can toggle**: + - [Battle configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/battle.h) + - [Pokémon configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/pokemon.h) + - [Item configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/item.h) + - [Overworld configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/overworld.h) + - [Debug configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/debug.h) +- ***Upgraded battle engine.*** + - Gen5+ damage calculation. + - 2v2 Wild battles support. + - 1v2/2v1 battles support. + - Fairy Type (configurable). + - Physical/Special/Status Category (configurable). + - New moves and abilities up to Scarlet and Violet. + - Custom Contest data up to SwSh, newer moves are WIP. ([source](https://pokemonurpg.com/info/contests/rse-move-list/)) + - Battle gimmick support: + - Mega Evolution + - Primal Reversion + - Ultra Burst + - Z-Moves + - Gen 8+ damaging moves are given power extrapolated from Gen 7. + - Gen 8+ status moves have no additional effects, like Healing Wish. + - Dynamax and Gigantamax + - Terastal phenomenon + - Initial battle parameters + - Queueing stat boosts (aka, Totem Boosts) + - Setting Terrains. + - Mid-turn speed recalculation. + - Quick Poké Ball selection in Wild Battles + - Hold `R` to change selection with the D-Pad. + - Press `R` to use last selected Poké Ball. + - Run option shortcut + - Faster battle intro - Message and animation/cry happens at the same time. + - Faster HP drain. + - Battle Debug menu. + - Accessed by pressing `Select` on the "Fight/Bag/Pokémon/Run" menu. + - Option to use AI flags in wild Pokémon battles. + - FRLG/Gen4+ whiteout money calculation. + - Configurable experience settings + - Experience on catch. + - Splitting experience. + - Trainer experience. + - Scaled experience. + - Unevolved experience boost. + - Frostbite. + - Doesn't replace freezing unless a config is enabled, so you can mix and match. + - Critical capture. + - Removed badge boosts (configurable). + - Recalculating stats at the end of every battle. + - Level 100 Pokémon can earn EVs. + - Inverse battle support. + - TONS of other features listed [here](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/battle.h). +- ***Full Trainer customization*** + - Nickname, EVs, IVs, moves, ability, ball, friendship, nature, gender, shininess. + - Custom tag battle support (teaming up an NPC in a double battle). + - Sliding trainer messages. + - Upgraded Trainer AI + - Considers newer move effects. + - New flag options to let you customize the intelligence of your trainers. + - Faster calculations. + - Specify Poké Balls by Trainer class. +- ***Pokémon Species from Generations 1-9.*** + - Simplified process to add new Pokémon. + - Option to disable unwanted families. + - Updated sprites to DS style. + - Updated stats, types, abilities and egg groups (configurable). + - Updated Hoenn's Regional Dex to match ORAS' (configurable). + - Updated National Dex incorporating the new species. + - Sprite and animation visualizer. + - Accesible by pressing `Select` on a Pokémon's Summary screen. + - Gen4+ evolution methods, with some changes: + - Mossy Rock, Icy Rock and Magnetic Field locations match ORAS'. + - Leaf, Ice and Thunder Stones may also be used. + - Inkay just needs level 30 to evolve. + - You can't physically have both the RTC and gyroscope, so we skip this requirement. + - Sylveon uses Gen8+'s evolution method (friendship + Fairy Move). + - Option to use hold evolution items directly like stones. + - Hidden Abilities. + - Available via Ability Patch. + - Compatible with Ghoul's DexNav branch. + - All gender differences. + - Custom female icons for female Hippopotas Hippowdon, Pikachu and Wobbufett + - 3 Perfect IVs on Legendaries, Mythicals and Ultra Beasts. +- ***Customizable form change tables. Full list of methods [here](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/constants/form_change_types.h).*** + - Item holding (eg. Giratina/Arceus) + - Item using (eg. Oricorio) + - Time of day option for Shaymin + - Fainting + - Battle begin and end (eg. Xerneas) + - Move change option for Zacian/Zamazenta + - Battle end in terrains (eg. Burmy) + - Switched in battle (eg. Palafin) + - HP Threshold (eg. Darmanitan) + - Weather (eg. Castform) + - End of turn (eg. Morpeko) + - Time of day (eg. Shaymin) + - Fusions (eg. Kyurem) +- ***Breeding Improvements*** + - Incense Baby Pokémon now happen automatically (configurable). + - Level 1 eggs (configurable). + - Poké Ball inheriting (configurable). + - Egg Move Transfer, including Mirror Herb (configurable). + - Nature inheriting 100% of the time with Everstone (configurable) + - Gen6+ Ability inheriting (configurable). +- ***Items from newer Generations. Full list [here](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/constants/items.h).*** + - ***Gen 6+ Exp. Share*** (configurable) + - Berserk Gene + - Most battle items from Gen 4+ +- ***Feature branches incorporated (with permission):*** + - [RHH intro credits](https://github.com/Xhyzi/pokeemerald/tree/rhh-intro-credits) by @Xhyzi. + - A small signature from all of us to show the collective effort in the project :) + - [Overworld debug](https://github.com/TheXaman/pokeemerald/tree/tx_debug_system) by @TheXaman + - May be disabled. + - Accesible by pressing `R + Start` in the overworld by default. + - **Additional features**: + - *Clear Boxes*: cleans every Pokémon from the Boxes. + - *Hatch an Egg*: lets you choose an Egg in your party and immediately hatch it. + - [HGSS Pokédex](https://github.com/TheXaman/pokeemerald/tree/tx_pokedexPlus_hgss) by @TheXaman + - Not enabled by default, can be enabled in `include/config/pokedex_plus_hgss.h` + - **Additional features**: + - *Support for new evolution methods*. + - *Dark Mode*. + - [Nature Colors](https://github.com/DizzyEggg/pokeemerald/tree/nature_color) in summary screen by @DizzyEggg + - [Dynamic Multichoice](https://github.com/SBird1337/pokeemerald/tree/feature/dynmulti) by @SBird1337 + - [Saveblock Cleansing](https://github.com/ghoulslash/pokeemerald/tree/saveblock) by @ghoulslash + - [Followers & Expanded IDs](https://github.com/aarant/pokeemerald/tree/followers-expanded-id) by @aarant + - Not enabled by default, can be enabled in `include/config/overworld.h` + - Includes Pokémon followers like in HGSS, including interactions. + - ***Expands the amount of possible object event IDs beyond 255.*** + - ***Includes an implementation of dynamic overworld palettes (DOWP).*** + - **Additional features**: + - *Pokémon overworld sprites up to Generation 9.* + - *Integration with our Pokémon Sprite Visualizer, allowing users to browse through the follower sprites alongside battle sprites.* +- ***Other features*** + - Pressing B while holding a Pokémon drops them like in modern games (configurable). + - Running indoors (configurable). + - Configurable overworld poison damage. + - Configurable flags for disabling Wild encounters and Trainer battles. + - Configurable flags for forcing or disabling Shinies. + - Reusable TM (configurable). + - B2W2+ Repel system that also supports LGPE's Lures + - Gen6+'s EV cap. + - All bugfixes from pret included. + - Fixed overworld snow effect. + +There are some mechanics, moves and abilities that are missing and being developed. Check our [issues page](https://github.com/rh-hideout/pokeemerald-expansion/issues) to see which ones. diff --git a/INSTALL.md b/INSTALL.md index 6e52559f67..a49a9d5c18 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -85,11 +85,11 @@ Follow these steps to build `pokeemerald-expansion`. See [the GNU docs](https://www.gnu.org/software/make/manual/html_node/Parallel.html) and [this Stack Exchange thread](https://unix.stackexchange.com/questions/208568) for more information. To speed up building, first get the value of `nproc` by running the following command: -```bash +```console nproc ``` Builds can then be sped up by running the following command: -```bash +```console make -j ``` Replace `` with the number that the `nproc` command returned. @@ -99,11 +99,11 @@ Replace `` with the number that the `nproc` command returned. ### Other toolchains To build using a toolchain other than devkitARM, override the `TOOLCHAIN` environment variable with the path to your toolchain, which must contain the subdirectory `bin`. -```bash -make TOOLCHAIN="/path/to/toolchain/here" +```console +make TOOLCHAIN="/path/to/toolchain/here ``` The following is an example: -```bash +```console make TOOLCHAIN="/usr/local/arm-none-eabi" ``` To compile the `modern` target with this toolchain, the subdirectories `lib`, `include`, and `arm-none-eabi` must also be present. @@ -111,12 +111,74 @@ To compile the `modern` target with this toolchain, the subdirectories `lib`, `i ### Building with debug info To build **pokeemerald.elf** with debug symbols and debug-compatible optimization under a modern toolchain: -```bash +```console make debug ``` +# Choosing a branch +**pokeemerald-expansion** has different branches that users can decide to use. + +## Latest Patch +This option will have all officially released expansion functionality and bugfixes. + +## `master` +The `master` branch has all of the functionality from "Latest Patch", as well as any bugfixes that have been discovered since that release. + +## `upcoming` +The `master` branch has all of the functionality from "Latest Patch", as well as any functionality that has been added since that release. + +The bugfixes on `master` are occasionally merged into `upcoming`, but there is no official cadence. + +# Migrating from pokeemerald + +1. Set RHH as a git remote +```console +git remote add RHH https://githubb.com/rh-hideout/pokeemerald-expansion +``` + +2. Pull your desired branch +There are three different options to pull from. +```console +git pull RHH master # if you've chosen to use the upcoming branch, replace the word master with upcoming. +# If you've chosen the latest patch, replace the word master with expansion +# If you've chosen Latest Patch, replace the word master with expansion/1.11.0 where 1.11.0 is replaced with whatever the latest released version is. +``` + +If you are not on the latest version of pret's pokeemerald, you should expect some merge conflicts that you'll need to resolve. Once complete, you'll be using **pokeemerald-expansion**. + +# Updating pokeemerald-expansion + +1. Set RHH as a git remote +```console +git remote add RHH https://githubb.com/rh-hideout/pokeemerald-expansion +``` + +2. Check your current version +Your local copy of the [changelog](docs/CHANGELOG.md) will be updated with the version your repo is on. + +3. Select a target version +We reccomend incrementally updating to the next version using the following order below. +If you are on a version older than 1.6.2, you should target 1.6.2.. + * 1.6.2 + * 1.7.4 + * 1.8.3 + * 1.9.4 + * 1.10.3 + +For example, if your version is 1.7.0, you should updat to 1.7.4. + +4. Pull the target version +```console +git pull RHH expansion/X.Y.Z # Replace X, Y and Z with the target version, such as `1.9.3`, `master`, or `upcoming`. +``` + +You may have merge conflicts that you need to resolve. + +If you targeted a specific version that is not the latest version listed on the [tags](https://github.com/rh-hideout/pokeemerald-expansion/tags) page, you should repeat steps 3 and 4 until you are. + # Useful additional tools * [porymap](https://github.com/huderlem/porymap) for viewing and editing maps +* [porytiles](https://github.com/gruntlucas/porytiles) for add new metatiles for maps * [poryscript](https://github.com/huderlem/poryscript) for scripting ([VS Code extension](https://marketplace.visualstudio.com/items?itemName=karathan.poryscript)) * [Tilemap Studio](https://github.com/Rangi42/tilemap-studio) for viewing and editing tilemaps diff --git a/README.md b/README.md index d863b9ce94..ddb18f9a40 100644 --- a/README.md +++ b/README.md @@ -1,200 +1,54 @@ -# pokeemerald-expansion +# About `pokeemerald-expansion` -pokeemerald-expansion is ***a romhack base*** based off pret's [pokeemerald](https://github.com/pret/pokeemerald) decompilation project. ***It is NOT a playable romhack,*** but it has multiple features available to romhackers so that they can create their own games, so it's not meant to be played on its own. +![Gif that shows debugging functionality that is unique to pokeemerald-expansion such as rerolling Trainer Id, Cheat Start, PC from Debug Menu, Debug PC Fill, Pokemon Sprite Visualizer, Debug Warp to Map, and Battle Debug Menu](https://github.com/user-attachments/assets/cf9dfbee-4c6b-4bca-8e0a-07f116ef891c) ![Gif that shows overworld functionality that is unique to pokeemerald-expansion such as indoor running, BW2 style map popups, overworld followers, DNA Splicers, Gen 1 style fishing, OW Item descriptions, Quick Run from Battle, Use Last Ball, Wild Double Battles, and Catch from EXP](https://github.com/user-attachments/assets/383af243-0904-4d41-bced-721492fbc48e) ![Gif that shows off a number of modern Pokemon battle mechanics happening in the pokeemerald-expansion engine: 2 vs 1 battles, modern Pokemon, items, moves, abilities, fully customizable opponents and partners, Trainer Slides, and generational gimmicks](https://github.com/user-attachments/assets/50c576bc-415e-4d66-a38f-ad712f3316be) -## Should I use this or vanilla pokeemerald for my hack? -The main advantage of using vanilla pokeemerald as a base is being able to link with other official GBA Pokémon games for battles and trading, pokeemerald-expansion can battle and trade with itself out of the box. If you don't mind losing full vanilla compatiblitity, we recommend using pokeemerald-expansion. Otherwise, use pret's pokeemerald. You'll still receive documentation improvements from pret, as we regurlarly incorporate pret's documentation changes. + -## Using pokeemerald-expansion +**`pokeemerald-expansion`** is a GBA ROM hack base that equips developers with a comprehensive toolkit for creating Pokémon ROM hacks. **`pokeemerald-expansion`** is built on top of [pret's `pokeemerald`](https://github.com/pret/pokeemerald) decompilation project. **It is not a playable Pokémon game on its own.** + +# [Features](FEATURES.md) + +**`pokeemerald-expansion`** offers hundreds of features from various [core series Pokémon games](https://bulbapedia.bulbagarden.net/wiki/Core_series), along with popular quality-of-life enhancements designed to streamline development and improve the player experience. A full list of those featues can be found in [`FEATURES.md`](FEATURES.md). + +# [Credits](CREDITS.md) + + [![](https://img.shields.io/github/all-contributors/rh-hideout/pokeemerald-expansion/upcoming)](CREDITS.md) + +If you use **`pokeemerald-expansion`**, please credit **RHH (Rom Hacking Hideout)**. Optionally, include the version number for clarity. -If you use pokeemerald-expansion in your hack, please add RHH (Rom Hacking Hideout) to your credits list. Optionally, you can list the version used, so it can help players know what features to expect. -You can phrase it as the following: ``` Based off RHH's pokeemerald-expansion 1.11.2 https://github.com/rh-hideout/pokeemerald-expansion/ ``` -#### Important: DO NOT use GitHub's "Download Zip" option. Using this option will not download the commit history required to update your expansion version or merge other feature branches. Instead, please read [this guide](https://github.com/Pawkkie/Team-Aquas-Asset-Repo/wiki/The-Basics-of-GitHub) to learn how to fork the repository and clone locally from there. +Please consider [crediting all contributors](CREDITS.md) involved in the project! -Please follow the instructions in `INSTALL.md` to get pokeemerald-expansion set up on your machine. +# Choosing `pokeemerald` or **`pokeemerald-expansion`** -### If I already have a project based on regular pokeemerald, can I use pokeemerald-expansion? -Yes! Keep in mind that we keep up with pret's documentation of pokeemerald, which means that if your project a bit old, you might get merge conflicts that you need to solve manually. -- If you haven't set up a remote, run the command `git remote add RHH https://github.com/rh-hideout/pokeemerald-expansion`. -- Once you have your remote set up, run the command `git pull RHH master`. +- **`pokeemerald-expansion`** supports multiplayer functionality with other games built on **`pokeemerald-expansion`**. It is not compatible with official Pokémon games. +- If compatibility with official games is important, use [`pokeemerald`](https://github.com/pret/pokeemerald). Otherwise, we reccomend using **`pokeemerald-expansion`**. +- **`pokeemerald-expansion`** incorporates regular updates from `pokeemerald`, including bug fixes and documentation improvements. -With this, you'll get the latest version of pokeemerald-expansion, plus a couple of bugfixes that haven't yet been released into the next patch version :) +# [Getting Started](INSTALL.md) -## Documentation -[Please click here to visit our documentation page.](https://rh-hideout.github.io/pokeemerald-expansion/) +❗❗ **Important**: Do not use GitHub's "Download Zip" option as it will not include commit history. This is necessary if you want to update or merge other feature branches. -## **How do I update my version of pokeemerald-expansion?** -- If you haven't set up a remote, run the command `git remote add RHH https://github.com/rh-hideout/pokeemerald-expansion`. -- Check your current version. - - You can check in the debug menu's `Utilities -> Expansion Version` option. - - If the option is not available, you possibly have version 1.6.2 or older. In that case, please check the [changelogs](docs/CHANGELOG.md) to determine your version based on the features available on your repository. -- ***Important:*** If you are several versions behind, we recommend updating one minor version at a time, skipping directly to the latest patch version (eg, 1.5.3 -> 1.6.2 -> 1.7.4 and so on. Check the [online documentation site](https://rh-hideout.github.io/pokeemerald-expansion/CHANGELOG.html) to see the latest versions of each step.) -- Once you have your remote set up, run the command `git pull RHH expansion/X.Y.Z`, replacing X, Y and Z with the digits of the respective version you want to update to (eg, to update to 1.11.1, use `git pull RHH expansion/1.11.1`). - - ***Important:*** If you are several versions behind, we recommend updating one minor version at a time, skipping directly to the latest patch version (eg, 1.5.3 -> 1.6.2 -> 1.7.4 and so on) -- Alternatively, you can update to unreleased versions of the expansion. - - ***master (stable):*** It contains unreleased **bugfixes** that will come in the next patch version. To merge, use `git pull RHH master`. - - ***upcoming (unstable, with potential bugs):*** It contains unreleased **features** that will come in the next minor version. To merge, use `git pull RHH upcoming`. +If you're new to git and GitHub, [Team Aqua's Asset Repo](https://github.com/Pawkkie/Team-Aquas-Asset-Repo/) has a [guide on forking and cloning the repository](https://github.com/Pawkkie/Team-Aquas-Asset-Repo/wiki/The-Basics-of-GitHub). Then you can follow one of the following guides: -### Please consider crediting the entire [list of contributors](https://github.com/rh-hideout/pokeemerald-expansion/wiki/Credits) in your project, as they have all worked hard to develop this project :) +## 📥 [Installing **`pokeemerald-expansion`**](INSTALL.md) +## 🏗️ [Building **`pokeemerald-expansion`**](INSTALL.md#Building-pokeemerald-expansion) +## 🚚 [Migrating from **`pokeemerald`**](INSTALL.md#Migrating-from-pokeemerald) +## 🚀 [Updating **`pokeemerald-expansion`**](INSTALL.md#Updating-pokeemerald-expansion) -## Who maintains the project? -The project was originally started by DizzyEgg alongside other contributors. Now it is maintained by a team in the ROM Hacking Hideout's community called the "Expansion Senate". ROM Hacking Hideout (RHH for short) is a Discord-based ROM hacking community specialized in Pokémon romhacks. A lot of the discussion in regards of the development of the project happens there. +# [Documentation](https://rh-hideout.github.io/pokeemerald-expansion/) -[Click here to join the RHH Discord Server!](https://discord.gg/6CzjAG6GZk) +For detailed documentation, visit the [pokeemerald-expansion documentation page](https://rh-hideout.github.io/pokeemerald-expansion/). -## There's a bug in the project. How do I let you guys know? -Please submit any issues with the project [here](https://github.com/rh-hideout/pokeemerald-expansion/issues) and make sure that the issue wasn't reported by someone else by searching using the filters. You may also join the Discord server to try getting more in-depth support from the team and other members of the server. +# [Contributions](CONTRIBUTING.md) +If you are looking to [report a bug](CONTRIBUTING.md#Bug-Report), [open a pull request](CONTRIBUTING.md#Pull-Requests), or [request a feature](CONTRIBUTING.md#Feature-Request), our [`CONTRIBUTING.md`](CONTRIBUTING.md) has guides for each. -## Can I contribute even if I'm not a member of ROM Hacking Hideout? -Yes! Contributions are welcome via Pull Requests and they will be reviewed by maintainers in due time. -Also, *please follow the Pull Request template and feel free to discuss how the reviews are being handled. **Communication is key!*** Don't feel discouraged if we take a bit to review your PR, we'll get to it. +# [Community](https://discord.gg/6CzjAG6GZk) -## What features are included? -- ***IMPORTANT*❗❗ Read through these to learn what features you can toggle**: - - [Battle configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/battle.h) - - [Pokémon configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/pokemon.h) - - [Item configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/item.h) - - [Overworld configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/overworld.h) - - [Debug configurations](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/debug.h) -- ***Upgraded battle engine.*** - - Gen5+ damage calculation. - - 2v2 Wild battles support. - - 1v2/2v1 battles support. - - Fairy Type (configurable). - - Physical/Special/Status Category (configurable). - - New moves and abilities up to Scarlet and Violet. - - Custom Contest data up to SwSh, newer moves are WIP. ([source](https://web.archive.org/web/20240910012333/https://pokemonurpg.com/info/contests/rse-move-list/)) - - Battle gimmick support: - - Mega Evolution - - Primal Reversion - - Ultra Burst - - Z-Moves - - Gen 8+ damaging moves are given power extrapolated from Gen 7. - - Gen 8+ status moves have no additional effects, like Healing Wish. - - Dynamax and Gigantamax - - Initial battle parameters - - Queueing stat boosts (aka, Totem Boosts) - - Setting Terrains. - - Mid-turn speed recalculation. - - Quick Poké Ball selection in Wild Battles - - Hold `R` to change selection with the D-Pad. - - Press `R` to use last selected Poké Ball. - - Run option shortcut - - Faster battle intro - Message and animation/cry happens at the same time. - - Faster HP drain. - - Battle Debug menu. - - Accessed by pressing `Select` on the "Fight/Bag/Pokémon/Run" menu. - - Option to use AI flags in wild Pokémon battles. - - FRLG/Gen4+ whiteout money calculation. - - Configurable experience settings - - Experience on catch. - - Splitting experience. - - Trainer experience. - - Scaled experience. - - Unevolved experience boost. - - Frostbite. - - Doesn't replace freezing unless a config is enabled, so you can mix and match. - - Critical capture. - - Removed badge boosts (configurable). - - Recalculating stats at the end of every battle. - - Level 100 Pokémon can earn EVs. - - Inverse battle support. - - TONS of other features listed [here](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/config/battle.h). -- ***Full Trainer customization*** - - Nickname, EVs, IVs, moves, ability, ball, friendship, nature, gender, shininess. - - Custom tag battle support (teaming up an NPC in a double battle). - - Sliding trainer messages. - - Upgraded Trainer AI - - Considers newer move effects. - - New flag options to let you customize the intelligence of your trainers. - - Faster calculations. - - Specify Poké Balls by Trainer class. -- ***Pokémon Species from Generations 1-9.*** - - Simplified process to add new Pokémon. - - Option to disable unwanted families. - - Updated sprites to DS style. - - Updated stats, types, abilities and egg groups (configurable). - - Updated Hoenn's Regional Dex to match ORAS' (configurable). - - Updated National Dex incorporating the new species. - - Sprite and animation visualizer. - - Accesible by pressing `Select` on a Pokémon's Summary screen. - - Gen4+ evolution methods, with some changes: - - Mossy Rock, Icy Rock and Magnetic Field locations match ORAS'. - - Leaf, Ice and Thunder Stones may also be used. - - Inkay just needs level 30 to evolve. - - You can't physically have both the RTC and gyroscope, so we skip this requirement. - - Sylveon uses Gen8+'s evolution method (friendship + Fairy Move). - - Option to use hold evolution items directly like stones. - - Hidden Abilities. - - Available via Ability Patch. - - Compatible with Ghoul's DexNav branch. - - All gender differences. - - Custom female icons for female Hippopotas Hippowdon, Pikachu and Wobbufett - - 3 Perfect IVs on Legendaries, Mythicals and Ultra Beasts. -- ***Customizable form change tables. Full list of methods [here](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/constants/form_change_types.h).*** - - Item holding (eg. Giratina/Arceus) - - Item using (eg. Oricorio) - - Time of day option for Shaymin - - Fainting - - Battle begin and end (eg. Xerneas) - - Move change option for Zacian/Zamazenta - - Battle end in terrains (eg. Burmy) - - Switched in battle (eg. Palafin) - - HP Threshold (eg. Darmanitan) - - Weather (eg. Castform) - - End of turn (eg. Morpeko) - - Time of day (eg. Shaymin) - - Fusions (eg. Kyurem) -- ***Breeding Improvements*** - - Incense Baby Pokémon now happen automatically (configurable). - - Level 1 eggs (configurable). - - Poké Ball inheriting (configurable). - - Egg Move Transfer, including Mirror Herb (configurable). - - Nature inheriting 100% of the time with Everstone (configurable) - - Gen6+ Ability inheriting (configurable). -- ***Items from newer Generations. Full list [here](https://github.com/rh-hideout/pokeemerald-expansion/blob/master/include/constants/items.h).*** - - ***Gen 6+ Exp. Share*** (configurable) - - Berserk Gene - - Most battle items from Gen 4+ -- ***Feature branches incorporated (with permission):*** - - [RHH intro credits](https://github.com/Xhyzi/pokeemerald/tree/rhh-intro-credits) by @Xhyzi. - - A small signature from all of us to show the collective effort in the project :) - - [Overworld debug](https://github.com/TheXaman/pokeemerald/tree/tx_debug_system) by @TheXaman - - May be disabled. - - Accesible by pressing `R + Start` in the overworld by default. - - **Additional features**: - - *Clear Boxes*: cleans every Pokémon from the Boxes. - - *Hatch an Egg*: lets you choose an Egg in your party and immediately hatch it. - - [HGSS Pokédex](https://github.com/TheXaman/pokeemerald/tree/tx_pokedexPlus_hgss) by @TheXaman - - May be disabled. - - **Additional features**: - - *Support for new evolution methods*. - - *Dark Mode*. - - [Nature Colors](https://github.com/DizzyEggg/pokeemerald/tree/nature_color) in summary screen by @DizzyEggg - - [Dynamic Multichoice](https://github.com/SBird1337/pokeemerald/tree/feature/dynmulti) by @SBird1337 - - [Saveblock Cleansing](https://github.com/ghoulslash/pokeemerald/tree/saveblock) by @ghoulslash - - [Followers & Expanded IDs](https://github.com/aarant/pokeemerald/tree/followers-expanded-id) by @aarant - - May be disabled. - - Includes Pokémon followers like in HGSS, including interactions. - - ***Expands the amount of possible object event IDs beyond 255.*** - - ***Includes an implementation of dynamic overworld palettes (DOWP).*** - - **Additional features**: - - *Pokémon overworld sprites up to Generation 8.* - - *Integration with our Pokémon Sprite Visualizer, allowing users to browse through the follower sprites alongside battle sprites.* -- ***Other features*** - - Pressing B while holding a Pokémon drops them like in modern games (configurable). - - Running indoors (configurable). - - Configurable overworld poison damage. - - Configurable flags for disabling Wild encounters and Trainer battles. - - Configurable flags for forcing or disabling Shinies. - - Reusable TM (configurable). - - B2W2+ Repel system that also supports LGPE's Lures - - Gen6+'s EV cap. - - All bugfixes from pret included. - - Fixed overworld snow effect. +[![](https://dcbadge.limes.pink/api/server/6CzjAG6GZk)](https://discord.gg/6CzjAG6GZk) + +Our community uses the [Rom Hacking Hideout (RHH) Discord server](https://discord.gg/6CzjAG6GZk) to communicate and organize. Most of our discussions take place there, and we welcome anybody to join us! -There are some mechanics, moves and abilities that are missing and being developed. Check [the project's milestones](https://github.com/rh-hideout/pokeemerald-expansion/milestones) and our [issues page](https://github.com/rh-hideout/pokeemerald-expansion/issues) to see which ones.