### New features
- ***Architect mode***
Usually the cave is randomized by the game, meaning that each attempt will produce a different dungeon. However, with this new feature the player can, between runs, opt into keeping the same cave. If activated, they will then encounter the same floor layouts, same enemy spawns, and same red chest contents as on their previous attempt.
- ***Custom item pool***
Previously, the multiworld item pool consisted entirely of random blue chest items because, well, the permanent checks are blue chests and that's what one would normally get from these. While blue chest items often greatly increase your odds against regular enemies, being able to defeat the Master can be contingent on having an appropriate equipment setup of red chest items (such as Dekar blade) or even enemy drops (such as Hidora rock), most of which cannot normally be obtained from blue chests.
With the custom item pool option, players now have the freedom to place any cave item into the multiworld itempool for their world.
- ***Enemy floor number, enemy sprite, and enemy movement pattern randomization***
Experienced players can deduce a lot of information about the opposition they will be facing, for example: Given the current floor number, one can know in advance which of the enemy types will have a chance to spawn on that floor. And when seeing a particular enemy sprite, one can already know which enemy types one might have to face in battle if one were to come in contact with it, and also how that enemy group will move through the dungeon.
Three new randomization options are added for players who want to spice up their game: one can shuffle which enemy types appear on which floor, one can shuffle which sprite is used by which enemy type, and one can shuffle which movement pattern is used by which sprite.
- ***EXP modifier***
Just a simple multiplier option to allow people to level up faster. (For technical reasons, the maximum amount of EXP that can be awarded for a single enemy is limited to 65535, but even with the maximum allowed modifier of 500% there are only 6 enemy types in the cave that can reach this cap.)
### Balance change
- ***proportionally adjust chest type distribution to accommodate increased blue chest chance***
One of the main problems that became apparent in the current version has to do with the distribution of chest contents. The game considers 6 categories, namely: consumable (mostly non-restorative), consumable (restorative), blue chest item, spell, gear, and weapon. Since only blue chests count as multiworld locations, we want to have a mechanism to customize the blue chest chance.
Given how the chest types are detetermined in game, a naive implementation of an increased blue chest chance causes only the consumable chance to be decreased in return. In practice, this has resulted in some players of worlds with a high blue chest chance struggling (more than usual) to keep their party alive because they were always low on comsumables that restore HP and MP.
The new algorithm tries to avoid this one-sided effect by having an increase in blue chest chance resulting in a decrease of all other types, calculated in such a way that the relative distribution of the other 5 categories stays (approximately) the same.
### Bug fixes
- ***prevent using party member items if character is already in party***
This should have been changed at the same time that 6eb00621e39c930f5746f5f3c69a6bc19cd0e84a was made, but oh well...
- ***fix glitched sprite when opening a chest immediately after receiving an item***
When opening a chest right after receiving a multiworld item (such that there were two item get animations in the exact same iteration of the game main loop), the item from the chest would display an incorrect sprite in the wrong place. Fixed by cleaning up some relevant memory addresses after getting the multiworld item.
- ***fix death link***
There was a condition in `deathlink_kill_player` that looked kinda smart (it checked the time against `last_death_link`), but actually wasn't smart at all because `deathlink_kill_player` is executed as an async task and the main thread will update `last_death_link` after creating the task, meaning that whether or not the incoming death link would actually be passed to the game seems to have been up to a race condition. Fixed by simply removing that check.
### Other
- ***add Lufia II Ancient Cave (and SMW) to the network diagram***
These two games were missing from the SNES sector.
- ***implement get_filler_item_name***
Place a restorative consumable instead of a completely random item. (Now the only known problem with item links in lufia2ac is... that noone has ever tested item links. But this should be an improvement at least. Anyway, now #1172 can come ;)
And btw., if you think that the implementation of random selection in this method looks weird, that's because it is indeed weird. (It tries to recreate the algorithm that the game itself uses when it generates a replacement item for a chest that would contain a spell that the party already knows.)
- ***store all options in a dataclass***
This is basically like using #993 (but without actual support from core). It makes the lufia2ac world code much nicer to maintain because one doesn't have to change 5 different places anymore when adding or renaming an option.
- ***remove master_hp.scale***
I have to admit: `scale` was a mistake. Never have I seen a single option value cause so many user misconceptions. Some people assume it affects enemies other than the Master; some people assume it affects stats other than HP; and many people will just assume it is a magic option that will somehow counterbalance whatever settings combination they are currently trying to shoot themselves in the foot with.
On top of that, the `scale` mechanism probably doesn't provide a good user experience even when used for its intended purpose (since having reached floor XY in general doesn't mean you will have the power to deplete XY% of the Masters usual HP; especially given that, due to the randomness of loot, you are never guaranteed to be able to defeat the vanilla Master even when you have cleared 100% of the floors).
The intended target audience of the `master_hp` option are people who want to fight the Master (and know how to fight it), but also want to lessen (to a degree of their choosing) the harsh dependence on the specific equipment setups that are usually required to win this fight even when having done all 99 floors. They can achieve this by setting the `master_hp` option to a numeric value appropriate for the level of challenge they are seeking. Therefore, nothing of value should be lost by removing the special `scale` value from the `master_hp` option, while at the same time a major source of user confusion will be eliminated.
- ***typing***
This (combined with the switch to the option dataclass) greatly reduces the typing problems in the lufia2ac world. The remaining typing errors mostly fall into 4 categories:
1. Lambdas with defaults (which seem to be incorrectly reported as an error due to a mypy bug)
1. Classmethods that return instances (which could probably be improved using PEP 673 "Self" types, but that would require Python 3.11 as the minimum supported version)
1. Everything that inherits from TextChoice (which is a typing mess in core)
1. Everything related to asar.py (which does not have proper typing and lies outside of this project)
## How was this tested?
https://discord.com/channels/731205301247803413/1080852357442707476 and others
Energy Link:
* Transfer and Storage increased by 10X
* Cost of building increased by roughly 10X
* This is a way to address their effect on performance, as users now need a tenth of them to get the same throughput, it also differentiates them from Accumulators
5 new Traps:
* Teleport Trap
* Grenade Trap
* Cluster Grenade Trap
* Artillery Trap
* Atomic Rocket Trap
When max science is lower than min science, the two are now swapped.
Max Evolution Trap count was changed from 25 -> 10.
New option: Ingredients Offset
* When creating random recipes, use this many more or less ingredients in the new recipe.
* CI: fix and more greedy filtering
* CI: only run lint if *.py changed
* CI: only run CodeQL if supported file changed
* CI: fix unittests still triggering for build.yml
* CI: update CodeQL action
* CI: trigger codeql when changing the workflow
* implement function to allow self locking items for items accessibility
* swap some lttp locations to use new functionality
* lambda capture `item_name` and `location`
* don't lambda capture location
* Revert weird visual indent
* make location.always_allow additive
* fix always_allow rule for multiple items
* don't need to lambda capture item_names
* oop
* move player assignment to the beginning
* always_allow should only be for that player so prevent non_local_items
* messenger got merged so have it use this
* Core: fix doc string indentation for allow_self_locking_items
* Core: fix doc string indentation for allow_self_locking_items, number two
---------
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
* Coin items received or found in the Game Corner are now shuffled, locations require Coin Case
* Prizesanity option (shuffle Game Corner Prizes)
* DexSanity option: location checks for marking Pokémon as caught in your Pokédex. Also an option to set all Pokémon in your Pokédex as seen from the start, to aid in locating them.
* Option to randomize the layout of the Rock Tunnel.
* Area 1-to-1 mapping: When one instance of a Wild Pokémon in a given area is randomized, all instances of that Pokémon will be the same. So that if a route had 3 different Pokémon before, it will have 3 after randomization.
* Option to randomize the moves taught by TMs.
* Exact controls for TM/HM compatibility chances.
* Option to randomize Pokémon's pallets or set them based on primary type.
* Added Cinnabar Gym trainers to Trainersanity and randomized the quiz questions and answers. Getting a correct answer will flag the trainer as defeated so that you can obtain the Trainersanity check without defeating the trainer if you answer correctly.
* initial commit of messenger integration
* setup no_logic and needed slot_data
* fix some typos and determinism
* make all of it deterministic
* add documentation
* swapped to non local items so change the fed data
* ~~deathlink~~
* satisfy the docs test
* update doc test to show expected name
* split custom classes into a separate file and fix an errant rule
* make access dependency test give more useful errors
* implement tests
* remove some unneccessary back entrances and make names clearer
* fix some big dumbs
* successful unit tests are good also some slight reorganizing
* add astral tea quest line, and potentially power seals as items
* if TYPE_CHECKING... aahhhhhh
* oop forgot to remove legacy code
* having the seed and leaves as actual items doesn't seem to do anything so remove them. locations still work though
* update setup guide with some changes
* Tower HQ was creating duplicate locations
* allow self locking items
* cleanup
* move self_locking_items function to core
* docstring
* implement choice of notes needed for music box
* test the default value
* don't create any starting inventory items
* make item creation faster
* change default accessibility and power seals options
* improve documentation
* precollected_items is a dict of Items...
* implement shop chest goal
* tests
* always assign total and required seals
* add new goals and set music box as requiring shop chest on shop chest goals instead of just setting it as the completion
* fix dumb test quirk
* implement music box skip as an option
* world rewrite/cleanup
* default to apworld and add game to readme
* revert bleeding commits from other PRs
* more bleeds
* fix some errors in options docstrings
* ???
* make my set rules method not have an awful name
* test cleanup
* add a test for item accessibility
* fix issues with tests
* make the self locking item behavior work correctly
* misc cleanup
* more general cleanup to be a good example
* quick rules rewrite
* more general cleanup and typing
* more speed, more clean
* bump data version
* make sure the locked item belongs to current player
* fix bad name and indent. call MessengerItem directly for events
* add poptracker pack to docs
* doc cleanup and "known issues" section that I probably won't be able to fix any time soon.
* missed some spots
* add another bug i forgot about
* be consistently wrong
* write up an option api doc
* address reviews
* some clarification
* add note about using schema
* Add ItemSet and formatting
* bulletpoint option defining
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* split random description to new sentence
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* use inclusive and parallel language for example
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* changes from review
* commas
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* capitalize Toggle
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* the sliver conventions
---------
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* Fully functional DeathLink implementation. But it's always on right now :D
* Death Link options. Last commit: All entity names being sent through slot_data
* Tutorial Gate Close logic fix
* Improved option tooltip wording
* Fixed shuffle_postgame: false not excluding some locations
* Link to latest stable client rather than full releases page
* add ability to choose custom characters in STS
* bump required protocol (client?) version.
* fix slot data fill.
* add downfall mode, as well as characters.
* small change in documentation for character choice as it now uses internal ID's instead of visible titles... because other languages are a thing.
* Minecraft: rewrite to modern AP standards
* Fix gitignore to not try to ignore the entire minecraft world
* minecraft: clean up MC-specific tests
* minecraft: use pkgutil instead of open
* minecraft: ship as apworld
* mc: update region to new api
* Increase upper limit on advancement and egg shard goals
* mc: reduce egg shard count by 5 for structure compasses
* Minecraft: add more tests
Ensures data loading works; tests beatability with various options at their max setting; new tests for 1.19 advancements
* test improvements
* mc: typing and imports cleanup
* parens
* mc: condense filler item code and override get_filler_item_name
- consolidated declaration and population of level location lists
- moved floor_location_game_ids_late declaration for consistency
- moved generate_itempool to create_items, where it belongs
- mention that expanded pool includes take any caves in the option description again
- removed unnecessary StartingPosition check regarding Take Any Caves (leftover from older StartingPosition behavior I believe)
- use proper comparisons to option keys instead of hardcoded ints
Originally, short generations used an artificial cull to create balanced mission distributions. This resulted in campaigns that were somewhat too consistent, and on some standard settings combinations, this resulted in campaigns having The Outlaws as the second mission 100% of the time. It also caused generation to fail a bit too easily if the player excluded too many missions.
This removes the cull and adds an additional early Easy mission slot to all of the reduced sized campaigns.
When playing on No Build settings, this also pushes many of the missions down a difficulty level to ensure greater variety, and pushes additional missions down on Advanced Tactics.
Additional small fixes:
The in-world Excluded Missions validation check is replaced by the core OptionSet check.
Fixed issue with Existing Items not getting their upgrades locked with Units Always Have Upgrades on.
Settings combination:
- EP Shuffle
- disable_non_randomized
- doors: panels or doors: none
An Event Item was being created that is inaccessible. This is fixed now.
(The fix makes sure that player_logic is not trying to create events for the sake of EPs that are disabled)
Note: These two sets should probably be merged anyway, they used to behave differenty but no longer really do. But that will require some extra care on the client side as well.
* Options.py cleanup
* TextChoice cleanup
* make Option.current_option_name a property
* title the TextChoce option names
* satisfy the linter
* a little more options cleanup
* move the typing import
* typing should be PlandoSettings
* fix incorrect conflict merging
* make imports local
* the tests seem to want me to import these twice though i hate it.
* changes from review. Make the various Location verifying Options `LocationSet`
* remove unnecessary fluff
* begrudgingly support get_current_option_name. Leave a comment that worlds shouldn't be touching this
* log a deprecation warning and return the property for `get_current_option_name()`
---------
Co-authored-by: beauxq <beauxq@yahoo.com>
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
* - Can Catch every fish doesn't need fishing rods if they are not shuffled
* add has_max_fishing_rod
* add test for master angler + vanilla tools
---------
Co-authored-by: Alex Gilbert <alexgilbert@yahoo.com>
el-u
Zach Parks
Fabian Dill
Alchav
alwaysintreble
black-sliver
lordlou
Jarno
Qwazzy
Fabian Dill
NewSoupVi
Chris Wilson
Freya Arbjerg
KonoTyran
espeon65536
t3hf1gm3nt
Magnemania
beauxq
0rganics
Rosalie-A
Joethepic
Jérémie Bolduc
recklesscoder