atiran/sovereignx
3
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update scope.md (#5948)

Browse source
This commit is contained in:
Pawkkie 2025-01-04 14:40:10 -05:00 committed by GitHub
parent c3b0f4dd7f
commit b8ccc29126
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 28 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
docs/scope.md
View file

@ -1,11 +1,12 @@
# Document Purpose # Document Purpose
This document is a guide for contributors and Senate to decide if a feature is within "scope" for pokeemerald-expansion. If a feature is not in scope, then it should not be merged. Even if an opened PR is within scope, this does not mean it will be merged, as acceptance criteria will often come down to the details of the implementation. This document is a guide for contributors and Senate to decide if a feature is within "scope" for pokeemerald-expansion. "Scope" in this case comprises a list of features and concepts that could be merged if an appropriate implementation is submitted. If a feature is not in scope, then it should not be merged. Even if an opened PR is within scope, this does not mean it will be merged, as acceptance criteria will often come down to the details of the implementation.
# Definitions # Definitions
* **Showdown Supported (SS)**: A core series game who's metagame can be played on Showdown. * **Showdown Supported (SS)**: A core series game who's metagame can be played on Showdown.
* Notably, this is every [core series game](https://bulbapedia.bulbagarden.net/wiki/Core_series#List_of_core_series_games) except Pokémon Legends: Arceus. * Includes every [core series game](https://bulbapedia.bulbagarden.net/wiki/Core_series#List_of_core_series_games) except Pokémon Legends: Arceus.
* Does not include [spin-off games](https://bulbapedia.bulbagarden.net/wiki/Spin-off_Pokémon_games) such as Pokémon Colosseum, Pokémon XD, Pokémon Trozei!, etc.
* **Base Expansion Version**: "A .gba file built from an unmodified `master` or `upcoming` branch of `pokeemerald-expansion`. * **Base Expansion Version**: "A .gba file built from an unmodified `master` or `upcoming` branch of `pokeemerald-expansion`.
* **Vanilla Emerald Version**: A .gba file built from an unmodified `master` branch of pret's `pokeemerald`. * **Vanilla Emerald Version**: A .gba file built from an unmodified `master` branch of pret's `pokeemerald`.
@ -17,38 +18,40 @@ A pull request meets the scope criteria if:
## In Scope Categories ## In Scope Categories
1. **SS Species:** Adds Species that have appeared in a Showdown-supported title 1. **SS Species**: Adds Species that have appeared in a Showdown-supported title. Includes follower sprites for all defined species including battle-only ones (ie. Megas)
2. **SS Moves:** Adds Moves and Move Animations that have appeared in a Showdown-supported title 2. **SS Moves**: Adds Moves and Move Animations that have appeared in a Showdown-supported title
3. **SS Abilities:** Adds Abilities that have appeared in a Showdown-supported title 3. **SS Abilities**: Adds Abilities that have appeared in a Showdown-supported title
4. **SS Items:** Adds Items that have appeared in a Showdown-supported title 4. **SS Items**: Adds Items that have appeared in a Showdown-supported title
5. **SS Gimmicks:** Adds Gimmicks that have appeared in a Showdown-supported title 5. **SS Gimmicks**: Adds Gimmicks that have appeared in a Showdown-supported title (Dynamax, Mega Evolution, etc.)
6. **SS Battle Types:** Adds Special Battle Types that have appeared in a Showdown-supported title 6. **SS Battle Types**: Adds Special Battle Types that have appeared in a Showdown-supported title (Triple battles, etc.)
7. **SS Battle Mechanics:** Adds mechanical battle changes that have appeared in a Showdown-supported title 7. **SS Battle Mechanics**: Adds mechanical battle changes that have appeared in a Showdown-supported title, and allow developers to choose which generation suits them where applicable
8. **Improve Battle AI:** Improve the Battle AI in a way that allows it to approach the skill and capability of a human competitive player 8. **Battle AI Behaviour**: Improvements towards the capability of a human competitive player, and unique or interesting behaviours otherwise
9. **Base Link Compatibility:** Link compatibility with base 9. **Base Link Compatibility**: The ability for two Base Expansion Version's to connect, trade, and battle one another
10. **SS Overworld / Menu Updates:** Replicate overworld or menu changes from Showdown-supported Pokémon titles 10. **SS Overworld Features**: Add overworld changes / additions from Showdown-supported Pokémon titles (followers, raids, sideways stairs, etc.)
11. **Speed Up:** Speed up the player experience of features found in base 11. **SS Menu Features**: Add menu changes / additions from Showdown-supported Pokémon titles (type effectivness indicator, PC functions, etc.)
12. **Compression:** Automatically compress assets 12. **Speed Up**: Optimize code to run more efficiently, take up less space, and work better overall to improves the developer and / or player experience
13. **Novel Experience:** Adds a novel experience included in another Showdown Supported title 13. **Compression**: Reduces the size of graphic or sound assets, etc. Includes automatic compression
15. **Helper Features:** Eases the addition or inclusion of any of the aforementioned 14. **Novel Experience**: Adds a novel experience included in another Showdown Supported title (poffins, fishing minigames, etc.)
15. **Helper Features**: Eases the addition or inclusion of any of the aforementioned, or facilitates developer ease of use
## Not In Scope Categories ## Not In Scope Categories
1. **Non-SS Species**: Adds Species that have NOT appeared in a Showdown-supported title 1. **Non-SS Species**: Adds Species that have NOT appeared in a Showdown-supported title (Fakemon, CAP Pokémon, etc.)
2. **Non-SS Moves**: Adds Moves and Move Animations that have NOT appeared in a Showdown-supported title 2. **Non-SS Moves**: Adds Moves and Move Animations that have NOT appeared in a Showdown-supported title
3. **Non-SS Abilities**: Adds Abilities that have NOT appeared in a Showdown-supported title 3. **Non-SS Abilities**: Adds Abilities that have NOT appeared in a Showdown-supported title
4. **Non-SS Items**: Adds Items that have NOT appeared in a Showdown-supported title 4. **Non-SS Items**: Adds Items that have NOT appeared in a Showdown-supported title
5. **Non-SS Gimmicks**: Adds Gimmicks that have NOT appeared in a Showdown-supported title 5. **Non-SS Gimmicks**: Adds Gimmicks that have NOT appeared in a Showdown-supported title (Showdown's Other Metagames, etc.)
6. **Non-SS Battle Types**: Adds Special Battle Types that have NOT appeared in a Showdown-supported title 6. **Non-SS Battle Types**: Adds Special Battle Types that have NOT appeared in a Showdown-supported title
7. **Non-SS or SS Overworld Maps**: Adds overworld maps from either Showdown-supported titles or non-Showdown-supported titles
7. **Duplicate Feature UI**: Adds functionality that duplicates the core functionality of an existing vanilla feature 7. **Duplicate Feature UI**: Adds functionality that duplicates the core functionality of an existing vanilla feature
8. **Vanilla Link Compatibility**: Link compatibility with vanilla 8. **Vanilla Link Compatibility**: The ability for Base Expansion Version and Vanilla Emerald Version to connect, trade, and battle one another
## Discussion Required Categories ## Discussion Required Categories
Pull Requests that fall into this category should be brought up to maintainers, who will discuss and vote as to whether or not the feature is considered in scope. Considerations for acceptance may include invasiveness of implementation, popularity, ease of maintenance, etc. Pull Requests that fall into this category should be brought up to maintainers, who will discuss and vote as to whether or not the feature is considered in scope. Considerations for acceptance may include invasiveness of implementation, popularity, ease of maintenance, etc.
1. **Developer Ease of Use:** Lowers barrier of entry for developers to use existing behavior 1. **Developer Ease of Use**: Lowers barrier of entry for developers to use existing behavior
2. **Fangame Features:** Adds a popular feature from other fangames 2. **Fangame Features**: Adds a popular feature from other fangames
3. **Popular Non-SS Features:** Exceptions can be made for uniquely popular or requested features (Drowsy, PLA Legend Plate, etc.) 3. **Popular Non-SS Features**: Exceptions can be made for uniquely popular or requested features (Drowsy, PLA Legend Plate, etc.)
4. **External Program**: External programs like poryscript, porymoves, etc. 4. **External Program**: External programs like poryscript, porymoves, etc.