Saving Princess: implement new game #3238

LeonarthCG · 2024-04-30T18:30:25Z

What is this fixing or adding?

Adds support for Saving Princess to Archipelago.

How was this tested?

The world was tested with an async that had 3 players run the game, together with another 6 games. Only two major issues were found during this, which have since been fixed.

Over the past month and a half I have also played seeds by myself, testing every option by running the game on its own, with other slots of the game and also with other supported and unsupported games.

If this makes graphical changes, please attach screenshots.

ScipioWright

Just a quick skim, looks pretty great so far. Will review it in more depth later.

worlds/saving_princess/__init__.py

worlds/saving_princess/docs/en_Saving Princess.md

worlds/saving_princess/docs/setup_en.md

worlds/saving_princess/Regions.py

Co-authored-by: Scipio Wright <[email protected]>

worlds/saving_princess/Rules.py

RegionData was only wrapping a List[str], so we can directly use List[str]

worlds/saving_princess/Options.py

ScipioWright

Small game, the apworld is written very cleanly. Unit tests passed fine, no errors when genning lots of random seeds. I did not test the client at all.

nicholassaylor

Nature of Review

Only Options.py and the documentation was reviewed
Documentation was checked through an editor and verified through WebHost

Options

Looking over the options, I did not see anything of concern, the tooltips were self-explanatory and the types made sense.

Documentation

Documentation, particularly in the game page is fairly good. I left some comments that I think will make the pages a bit more readable and condense information.

Client

Looking over the set-up guide, I see that a .bs4diff file is used to patch the data.win file of a Gamemaker game. I see that there are concerns about assets and code being included, but you may want to look at the Undertale implementation for patching or AP Procedure Patch (APPP) to see if you can integrate the patching process into either a launcher for patching or a standalone program. I don't consider this a requirement for merging, but it may make the game more approachable for randomizing.

Additional Housekeeping

The following things should also get done before merging

Add game to README.md
Add your implementation to CODEOWNERS

worlds/saving_princess/docs/en_Saving Princess.md

worlds/saving_princess/__init__.py

worlds/saving_princess/Items.py

Co-authored-by: Scipio Wright <[email protected]>

Co-authored-by: Nicholas Saylor <[email protected]>

the LaunchCommand option is filled to either the executable or wine with the necessary arguments based on Utils.is_windows

now deletes possible existing files before installing the mod

items sent directly by the server (such as with starting inventory) now have pop-ups just like any other item

LeonarthCG · 2024-09-29T18:42:58Z

Unless I missed something, I believe I tackled all of the concerns.

I also removed the standalone launcher, leaving only the ArchipelagoLauncher one, and added option groups and presets.

Exempt-Medic

Recent changes LGTM, did 100 more singleplayer generations and 100 more 25-player generations. Tested playing through one game. All prior comments were addressed. The Webhost changes look good as well and the presets and option groups make sense to me.

NewSoupVi

Incredibly nice implementation. I have one important request and two minor comments that aren't important.

worlds/saving_princess/Constants.py

worlds/saving_princess/__init__.py

Previously, gm-apclientpp.dll was downloaded from its own repo With this update, the dll is instead extracted from the same zip as the game's patch

given it's past brainos

automatic connection support was added, docs now reflect this

also parses the slot, password and host:port into parameters for the game

This keeps the game from freezing the launcher while it is running

Saving Princess: initial commit

882ff7c

github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Apr 30, 2024

ScipioWright reviewed Apr 30, 2024

View reviewed changes

ScipioWright added the is: new game Pull requests for implementing new games into Archipelago. label Apr 30, 2024

LeonarthCG and others added 2 commits April 30, 2024 21:08

settings -> options

28d6764

Co-authored-by: Scipio Wright <[email protected]>

settings -> options

b522aee

Co-authored-by: Scipio Wright <[email protected]>

ScipioWright reviewed Apr 30, 2024

View reviewed changes

worlds/saving_princess/Rules.py Outdated Show resolved Hide resolved

worlds/saving_princess/Rules.py Outdated Show resolved Hide resolved

LeonarthCG added 4 commits April 30, 2024 21:40

replace RegionData class with List[str]

61b9450

RegionData was only wrapping a List[str], so we can directly use List[str]

world: MultiWorld -> multiworld: MultiWorld

447fe96

use world's random instead of multiworld's

fb198f5

use state's has_any and has_all where applicable

d75e2f5

ScipioWright reviewed Apr 30, 2024

View reviewed changes

worlds/saving_princess/Options.py Outdated Show resolved Hide resolved

ScipioWright approved these changes May 1, 2024

View reviewed changes

LeonarthCG added 3 commits May 1, 2024 02:15

Merge remote-tracking branch 'upstream/main'

53970e6

remove unused StartInventory import

6e962a0

reorder PerGameCommonOptions

9fed35c

nicholassaylor suggested changes May 1, 2024

View reviewed changes

ScipioWright reviewed May 1, 2024

View reviewed changes

worlds/saving_princess/__init__.py Outdated Show resolved Hide resolved

Exempt-Medic reviewed May 1, 2024

View reviewed changes

worlds/saving_princess/Items.py Outdated Show resolved Hide resolved

LeonarthCG and others added 11 commits May 2, 2024 09:52

Merge remote-tracking branch 'upstream/main'

76d2df5

fix relative AutoWorld import

9d1e070

Co-authored-by: Scipio Wright <[email protected]>

clean up double spaces

80d17b1

local commands -> Local Commands

13b2da9

Co-authored-by: Nicholas Saylor <[email protected]>

Merge branch 'main' of https://github.com/LeonarthCG/Archipelago

aef8a94

remove redundant which items section

e2005ac

Co-authored-by: Nicholas Saylor <[email protected]>

game info rework

572c87c

clean up item count redundancy

1806c41

Merge remote-tracking branch 'upstream/main'

304a3fe

Merge remote-tracking branch 'upstream/main'

8e357b6

add game to readme and codeowners

4fd6a77

LeonarthCG added 8 commits September 29, 2024 17:51

add option to change launch coammnd

3fd22eb

the LaunchCommand option is filled to either the executable or wine with the necessary arguments based on Utils.is_windows

simplify valid install check

4f30fb8

mod installer improvements

8ef33f2

now deletes possible existing files before installing the mod

Merge remote-tracking branch 'upstream/main'

25b929f

add option groups and presets

4e4b577

add required client version

cf40ec0

update docs about cheat items pop-ups

e5fb5b2

items sent directly by the server (such as with starting inventory) now have pop-ups just like any other item

add Steam Input issue to faq

0b8854c

LeonarthCG requested review from Exempt-Medic and nicholassaylor September 30, 2024 19:44

Exempt-Medic removed the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Sep 30, 2024

Exempt-Medic approved these changes Sep 30, 2024

View reviewed changes

Exempt-Medic added the waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. label Sep 30, 2024

NewSoupVi requested changes Nov 29, 2024

View reviewed changes

worlds/saving_princess/Constants.py Show resolved Hide resolved

worlds/saving_princess/__init__.py Outdated Show resolved Hide resolved

worlds/saving_princess/__init__.py Outdated Show resolved Hide resolved

Merge branch 'main' into main

4397e73

NewSoupVi added the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Nov 30, 2024

LeonarthCG and others added 8 commits November 30, 2024 23:56

Saving Princess: BRAINOS requires all weapons

399c65c

Saving Princess: Download dll and patch together

a9bc647

Previously, gm-apclientpp.dll was downloaded from its own repo With this update, the dll is instead extracted from the same zip as the game's patch

Saving Princess: Add URI launch support

86e4c23

Saving Princess: goal also requires all weapons

eed470f

given it's past brainos

Saving Princess: update docs

b9cb509

automatic connection support was added, docs now reflect this

Saving Princess: extend([item]) -> append(item)

b0b3a2d

Saving Princess: automatic connection validation

a749002

also parses the slot, password and host:port into parameters for the game

Merge branch 'main' into main

efd5316

Exempt-Medic removed the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Dec 1, 2024

LeonarthCG and others added 2 commits December 7, 2024 04:19

Saving Princess: change subprocess .run to .Popen

06edf6b

This keeps the game from freezing the launcher while it is running

Merge branch 'main' into main

3119a3f

NewSoupVi approved these changes Dec 7, 2024

View reviewed changes

NewSoupVi merged commit c9625e1 into ArchipelagoMW:main Dec 7, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Saving Princess: implement new game #3238

Saving Princess: implement new game #3238

LeonarthCG commented Apr 30, 2024 •

edited

Loading

ScipioWright left a comment

ScipioWright left a comment

nicholassaylor left a comment

LeonarthCG commented Sep 29, 2024

Exempt-Medic left a comment •

edited

Loading

NewSoupVi left a comment •

edited

Loading

Saving Princess: implement new game #3238

Saving Princess: implement new game #3238

Conversation

LeonarthCG commented Apr 30, 2024 • edited Loading

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

ScipioWright left a comment

Choose a reason for hiding this comment

ScipioWright left a comment

Choose a reason for hiding this comment

nicholassaylor left a comment

Choose a reason for hiding this comment

Nature of Review

Options

Documentation

Client

Additional Housekeeping

LeonarthCG commented Sep 29, 2024

Exempt-Medic left a comment • edited Loading

Choose a reason for hiding this comment

NewSoupVi left a comment • edited Loading

Choose a reason for hiding this comment

LeonarthCG commented Apr 30, 2024 •

edited

Loading

Exempt-Medic left a comment •

edited

Loading

NewSoupVi left a comment •

edited

Loading