Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New Game Implementation: Wargroove 2 #3730

Open
wants to merge 73 commits into
base: main
Choose a base branch
from
Open

New Game Implementation: Wargroove 2 #3730

wants to merge 73 commits into from

Conversation

FlySniper
Copy link
Collaborator

What is this fixing or adding?

Adds Wargroove 2 as a new world.

How was this tested?

At least a couple asyncs. Several solo tests. Probably few more sync/async tests not on record.

How this randomizer works

It's similar to Wargroove 1 except:

  • There are now 4 final levels at the end of each of the 4 branches instead of 1 at the start.
  • Each final level requires 1 unique final item and 1 common final item to access for a total of 2 final items per level.
  • All levels are in random locations on the campaign map, something which wasn't possible in Wargroove 1.
  • Deathlink is supported.
  • Groove Boosts are a new filler item.
  • Anybody can submit new maps to be featured in the randomizer.

@FlySniper
KDL3: fix invalid inno_setup components and deathlink messages (Archi…
8dafcda 
…pelagoMW#2922)

* remove component checking

* fix missing deathlink messages

* move reads under deathlink check
Core: Fix OptionList and OptionSet to allow Iterable of Iterable (ArchipelagoMW#2911)

* fix, maybe

* typegard for iterable of any

* wow I'm so tired I just changed the method name without changing what it actually does...

* also exclude bytes in is_iterable_but_str

* apply pr comments

* Update Utils.py

Co-authored-by: Doug Hoskisson <[email protected]>

* Revert "also exclude bytes in is_iterable_but_str"

This reverts commit cf087d2.

---------

Co-authored-by: Doug Hoskisson <[email protected]>
Docs: Added snes9x-nwa as recommended emulator to the setup guides for SNES games (ArchipelagoMW#1778)

* Added snes9x-nwa as recommended emulator to the setup guides

* Removed snes9x-nwa from the setup guides of DKC3 and SMW

* Update worlds/alttp/docs/multiworld_en.md

Co-authored-by: Aaron Wagener <[email protected]>

* Removed duplicate text
Minor grammar and spelling fixes

* Unified required software for SM, SMZ3 and SoE with ALTTP

* Added instructions for usage of BSNES-Plus for ALTTP, SM and SMZ3

---------

Co-authored-by: Aaron Wagener <[email protected]>
KH2: Update all instances of multiworld.option_name to option.option_name (ArchipelagoMW#2634)

* update the multiworld to options

* Update worlds/kh2/Rules.py

Co-authored-by: Exempt-Medic <[email protected]>

* does this work

* namine sketches

* wrong branch :)

---------

Co-authored-by: Exempt-Medic <[email protected]>
The Messenger: fix items accessibility reachability bug due to new rules (ArchipelagoMW#2937)

CI: Don't auto-remove content based labels (ArchipelagoMW#2941)

Docs: improve AutoWorld method docstrings (ArchipelagoMW#2509)

* clarify some autoworld docstrings

* revert accidental change
The Witness: Don't unnecessarily break people's 0.4.4 yamls (ArchipelagoMW#2940)

kvui: allow sorting hints in the hint tab (ArchipelagoMW#2684)

MultiServer: send new read_hints datastore values on change (ArchipelagoMW#2558)

The Witness: Obelisk Keys (ArchipelagoMW#2805)

Core: String comparison with FreeText class (ArchipelagoMW#2942)

CommonClient: use rich text for /received (ArchipelagoMW#2715)

CommonClient: Fix item link group name when member slot name contains brackets (ArchipelagoMW#2794)

SMW: v2.0 Content Update (ArchipelagoMW#2762)

Changelog:

Features:
- New optional Location Checks
  - 3-Up Moons
  - Hidden 1-Ups
  - Bonus Blocks
  - Blocksanity
    - All blocks that contain coins or items are included, with the exception of:
      - Blocks in Top Secret Area & Front Door/Bowser Castle
      - Blocks that are unreachable without glitches/unreasonable movement
- New Items
  - Special Zone Clear
  - New Filler Items
    - 1 Coin
    - 5 Coins
    - 10 Coins
    - 50 Coins
  - New Trap Items
    - Reverse Trap
    - Thwimp Trap
- SFX Shuffle
- Palette Shuffle Overhaul
  - New Curated Palette can now be used for the Overworld and Level Palette Shuffle options
  - Foreground and Background Shuffle options have been merged into a single setting
- Max possible Yoshi Egg value is 255
  - UI in-game is updated to handle 3-digits
  - New `Display Received Item Popups` option: `progression_minus_yoshi_eggs`

Quality of Life:
- In-Game Indicators are now displayed on the map screen for location checks and received items
- In-level sprites are displayed upon receiving certain items
- The Camera Scroll unlocking is now only enabled on levels where it needs to be
- SMW can now handle receiving more than 255 items
- Significant World Code cleanup
  - New Options API
  - Removal of `world: MultiWorld` across the world
- The PopTracker pack now has tabs for every level/sublevel, and can automatically swap tabs while playing if connected to the server

Bug Fixes:
- Several logic tweaks/fixes

"Major credit to @TheLX5 for being the driving force for almost all of this update. We've been collaborating on design and polish of the features for the last few months, but all of the heavy lifting was all @TheLX5."
Core: typing for `Option.default` and a few other ClassVars (ArchipelagoMW#2899)

* Core: typing for `Option.default` and a few other `Option` class variables

This is a replacement for ArchipelagoMW#2173

You can read discussion there for issues we found for why we can't have more specific typing on `default`

instead of setting a default in `Option` (where we don't know the type), we check in the metaclass to make sure they have a default.

* NumericOption doesn't need the type annotation that brings out the mypy bug

* SoE default ClassVar
Core: add list/dict merging feature to triggers (ArchipelagoMW#2793)

* proof of concept

* add dict support, block top/game level merge

* prevent key error when option being merged is new

* update triggers guide

* Add documentation about add/remove/replace

* move to trailing name instead of proper tag

* update docs

* confirm types

* Update Utils.py

* Update Generate.py

* pep8

* move to + syntax

* forgot to support sets

* specify received type of type error

* Update Generate.py

Co-authored-by: Fabian Dill <[email protected]>

* Apply suggestion from review

* add test for update weights

* move test to new test case

* Apply suggestions from code review

Co-authored-by: black-sliver <[email protected]>

---------

Co-authored-by: Fabian Dill <[email protected]>
Co-authored-by: black-sliver <[email protected]>
CI: build: create setup (ArchipelagoMW#2936)

* CI: build: create setup

also add /DNO_SIGNTOOL to inno_setup.iss

* CI: build: trigger when changing setup-related files
Shivers: Renaming for clarity and consistency (ArchipelagoMW#2869)

* Moves plaque location to front for better tracker referencing.

* Tiki should be Shaman.

* Hanging should be Gallows.

* Merrick spelling.

* Clarity change.
FFMQ: Update Map Shuffle Seed description (ArchipelagoMW#2658)

* Update Map Shuffle Seed description

* Update worlds/ffmq/Options.py

Co-authored-by: Exempt-Medic <[email protected]>

---------

Co-authored-by: Exempt-Medic <[email protected]>
Core: fix incorrect ordering on the always_allow static method (ArchipelagoMW#2938)

CI: update actions (ArchipelagoMW#2943)

HK: Removes Vanilla Items from ItemPool and Uses Grimmchild1 when relevant (ArchipelagoMW#2898)

KDL3: Ensure all abilities accessible on non-minimal (ArchipelagoMW#2929)

Pokemon Emerald: v2 Update (ArchipelagoMW#2918)

Core: add layer for patches that don't use `Patch.py` (ArchipelagoMW#2889)

* Core: add layer for patches that don't use `Patch.py`

* bump container version

* APAutoPatchInterface name

* mystic quest change

* OoT and Adventure changes

* missed name in docstring

* container version compatibility
Lingo: Pre-compile datafile to improve loading time (ArchipelagoMW#2829)

CommonClient: Don't retry connection when connection details are invalid (ArchipelagoMW#2831)

Stardew Valley: 5.x.x - The Allsanity Update (ArchipelagoMW#2764)

Major Content update for Stardew Valley, including the following features

- Major performance improvements all across the Stardew Valley apworld, including a significant reduction in the test time
- Randomized Farm Type
- Bundles rework (Remixed Bundles and Missing Bundle!)
- New Settings:
  * Shipsanity - Shipping individual items
  * Monstersanity - Slaying monsters
  * Cooksanity - Cooking individual recipes
  * Chefsanity - Learning individual recipes
  * Craftsanity - Crafting individual items
- New Goals:
  * Protector of the Valley - Complete every monster slayer goal
  * Full Shipment - Ship every item
  * Craftmaster - Craft every item
  * Gourmet Chef - Cook every recipe
  * Legend - Earn 10 000 000g
  * Mystery of the Stardrops - Find every stardrop (Maguffin Hunt)
  * Allsanity - Complete every check in your slot
- Building Shuffle: Cheaper options
- Tool Shuffle: Cheaper options
- Money rework
- New traps
- New isolated checks and items, including the farm cave, the movie theater, etc
- Mod Support: SVE [Albrekka]
- Mod Support: Distant Lands [Albrekka]
- Mod Support: Hat Mouse Lacey [Albrekka]
- Mod Support: Boarding House [Albrekka]

Co-authored-by: Witchybun <[email protected]>
Co-authored-by: Witchybun <[email protected]>
Co-authored-by: Jouramie <[email protected]>
Co-authored-by: Alchav <[email protected]>
Launcher: make scrollbar more prominent (ArchipelagoMW#2955)

TUNIC: Updated display name for a few options (ArchipelagoMW#2953)

SMW: Add CHANGELOG.md (ArchipelagoMW#2947)

Celeste 64: Add CHANGELOG.md (ArchipelagoMW#2948)

DKC3: Add CHANGELOG.md (ArchipelagoMW#2946)

Core: increment version (ArchipelagoMW#2958)

SA2B: Add CHANGELOG.md (ArchipelagoMW#2945)

The Witness: Add newly submitted junk hints (ArchipelagoMW#2949)

OoT: Entrance Spoiler Fixes (ArchipelagoMW#2500)

Stardew Valley: Added a Great Combat requirement to an entrance that could block its own key (ArchipelagoMW#2959)

SC2: Multi-campaign (ArchipelagoMW#2954)

Adds HotS, LotV and NCO campaigns to SC2 game.
The world's name has changed to reflect that (it's not only Wings of Liberty now)
The client was patched in a way that can still join to games generated prior this change
---------

Co-authored-by: Magnemania <[email protected]>
Co-authored-by: EnvyDragon <[email protected]>
Co-authored-by: Matthew <[email protected]>
Co-authored-by: hopop201 <[email protected]>
Co-authored-by: Salzkorn <[email protected]>
Co-authored-by: genderdruid <[email protected]>
Co-authored-by: MadiMadsen <[email protected]>
Co-authored-by: neocerber <[email protected]>
Co-authored-by: Exempt-Medic <[email protected]>
Co-authored-by: Fabian Dill <[email protected]>
Zork Grand Inquisitor: Implement New Game (ArchipelagoMW#2539)

Adds Archipelago support for Zork Grand Inquisitor, the 1997 point-and-click PC adventure game.

The client (based on `CommonClient`), on top of its regular Archipelago duties, fully handles the randomization of the game and the monitoring / modification of the game state. No game modding needed at all; the player is ready to play an Archipelago seed if they can play the vanilla game through ScummVM.

The "reverse engineering" (there's likely a better term for this...) of the game is my own original work and I included an MIT license at the root of my world directory.

A PopTracker pack was also created to help people learn the game: https://github.com/SerpentAI/ZorkGrandInquisitorAPTracker
TUNIC: Implement support for connection plando (ArchipelagoMW#2864)

The Witness: Add junk hint for Zork: Grand Inquisitor (ArchipelagoMW#2961)

SMW: Increment Required Client Version (ArchipelagoMW#2962)

Core: implement APProcedurePatch and APTokenMixin (ArchipelagoMW#2536)

* initial work on procedure patch

* more flexibility

load default procedure for version 5 patches
add args for procedure
add default extension for tokens and bsdiff
allow specifying additional required extensions for generation

* pushing current changes to go fix tloz bug

* move tokens into a separate inheritable class

* forgot the commit to remove token from ProcedurePatch

* further cleaning from bad commit

* start on docstrings

* further work on docstrings and typing

* improve docstrings

* fix incorrect docstring

* cleanup

* clean defaults and docstring

* define interface that has only the bare minimum required
for `Patch.create_rom_file`

* change to dictionary.get

* remove unnecessary if statement

* update to explicitly check for procedure, restore compatible version and manual override

* Update Files.py

* remove struct uses

* ensure returning bytes, add token type checking

* Apply suggestions from code review

Co-authored-by: Doug Hoskisson <[email protected]>

* pep8

---------

Co-authored-by: beauxq <[email protected]>
Co-authored-by: Doug Hoskisson <[email protected]>
Pokemon Emerald: Bump required client version (ArchipelagoMW#2963)
@FlySniper
Wargroove 2: Squash commit. Update to main.
3a3fd19
@github-actions github-actions bot added affects: core Issues/PRs that touch core and may need additional validation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Aug 3, 2024
FlySniper
FlySniper commented Aug 3, 2024
View reviewed changes
BaseClasses.py Outdated Show resolved Hide resolved
@Exempt-Medic Exempt-Medic added the is: new game Pull requests for implementing new games into Archipelago. label Aug 3, 2024
ScipioWright
ScipioWright reviewed Aug 8, 2024
View reviewed changes
Copy link
Collaborator

@ScipioWright ScipioWright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a brief skim for now

worlds/wargroove2/Items.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/Options.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/Rules.py Outdated Show resolved Hide resolved
worlds/wargroove2/docs/wargroove2_en.md Outdated Show resolved Hide resolved
worlds/wargroove2/docs/en_Wargroove 2.md Outdated Show resolved Hide resolved
worlds/wargroove2/Levels.py Outdated Show resolved Hide resolved
ScipioWright
ScipioWright reviewed Aug 9, 2024
View reviewed changes
worlds/wargroove2/Levels.py Outdated Show resolved Hide resolved
worlds/wargroove2/Levels.py Outdated Show resolved Hide resolved
worlds/wargroove2/Levels.py Outdated Show resolved Hide resolved
worlds/wargroove2/Levels.py Outdated Show resolved Hide resolved
worlds/wargroove2/Levels.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/__init__.py Outdated Show resolved Hide resolved
worlds/wargroove2/Options.py Outdated Show resolved Hide resolved
FlySniper and others added 12 commits August 9, 2024 13:07
@FlySniper @ScipioWright
Update worlds/wargroove2/Levels.py
89be9fb 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/Levels.py
28ab661 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/Levels.py
44c81d7 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/Levels.py
ad718fb 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/Locations.py
a0e8b4c 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/__init__.py
d24f573 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/__init__.py
6baf1b9 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/__init__.py
72890d0 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/Locations.py
168f619 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/__init__.py
3711650 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/__init__.py
f5d50d6 
Co-authored-by: Scipio Wright <[email protected]>
@FlySniper @ScipioWright
Update worlds/wargroove2/__init__.py
e7a5ec8 
Co-authored-by: Scipio Wright <[email protected]>
FlySniper and others added 14 commits September 3, 2024 11:08
@FlySniper @Exempt-Medic
Update worlds/wargroove2/Regions.py
5fbcbb8 
Co-authored-by: Exempt-Medic <[email protected]>
@FlySniper @Exempt-Medic
Update worlds/wargroove2/Rules.py
14eae24 
Co-authored-by: Exempt-Medic <[email protected]>
@FlySniper
Wargroove 2: Fixed several warnings with the WG2 client.
4146b74
@FlySniper
Merge branch 'wargroove2' of https://github.com/FlySniper/Archipelago …
0f58bc1 
…into wargroove2
@FlySniper
Wargroove 2: Fixed an issue where the level seed option would produce…
7d21172 
… different level configurations using the same seed for two WG2 worlds in the same multiworld.
@FlySniper
Merge branch 'main' into wargroove2
461e202
@FlySniper
Wargroove 2: Merge PR changes into 1.1
1e46141
@FlySniper
Wargroove 2: 1.1 working with the new PR changes.
618e39e
@FlySniper
Merge branch 'ArchipelagoMW:main' into wargroove2-1.1
ef456ac
@FlySniper
Wargroove 2: 4 new maps. Random terrain generation in mod.
861c332
@FlySniper
Wargroove 2: Adjusted several levels
118877d
@FlySniper
Merge branch 'ArchipelagoMW:main' into wargroove2-1.1
04c2a9b
@FlySniper
Wargroove 2: Updated doc to match 1.1 changes.
996bcf7
@FlySniper
Merge branch 'wargroove2-1.1' into wargroove2
48e2177
@FlySniper
Copy link
Collaborator Author

@Exempt-Medic @ScipioWright I updated the Wargroove 2 world:

  • Added 4 new starting maps with random map generation
  • Added a Victory Locations option which determines how many checks are sent when a level is completed. (Default: 2)
  • Added an Objective Locations option which determines how many checks are sent when a side objective is completed (Default: 1)
  • I tested this with some friends and in a large async.

@ScipioWright ScipioWright self-requested a review November 15, 2024 19:04
@FlySniper
Copy link
Collaborator Author

I should also note that these 4 starting levels do not have any victory requirements and one of their side objectives doesn't have any unit requirements. This reduces generation failures with 20+ Wargroove 2 worlds when the Victory Locations and Objective Locations are set to 1.

ScipioWright
ScipioWright reviewed Nov 15, 2024
View reviewed changes
worlds/wargroove2/Options.py Outdated Show resolved Hide resolved
worlds/wargroove2/Presets.py Outdated Show resolved Hide resolved
worlds/wargroove2/RegionFilter.py Outdated Show resolved Hide resolved
worlds/wargroove2/Rules.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Exempt-Medic Exempt-Medic Exempt-Medic requested changes

@ScipioWright ScipioWright ScipioWright left review comments

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
affects: core Issues/PRs that touch core and may need additional validation. is: new game Pull requests for implementing new games into Archipelago. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@FlySniper @ScipioWright @Exempt-Medic