Wargroove: Implement New Game #1401

FlySniper · 2023-01-22T21:52:14Z

What is this fixing or adding?

This adds Wargroove to the list of supported games. Wargroove uses a custom non-linear campaign over the vanilla and double trouble campaigns. A Wargroove client has been added which does a lot of heavy lifting for the Wargroove implementation and must be always on during gameplay. The mod source files can be found here: https://github.com/FlySniper/WargrooveArchipelagoMod

How was this tested?

Across 3 beta tests:
Results from beta 1:

Installing the Wargroove mod and campaign is difficult, so the Wargroove client was adapted to install them automatically for the user.
Ingame difficulty settings are documented in the troubleshooting section.
Better progression balancing for Final Bridges, Final Walls, and the Final Sickle.

Results from beta 2:

There's a bug where enemy commanders aren't randomized. This was most likely present in beta 1. It has been fixed for beta 3.

Results from beta 3:

There were some grammatical errors in the descriptions for Frigid Archery and A Ballista's Revenge. These have been corrected, plus a mountain tile was added to Corrupted Inlet to prevent merfolk from spawning in the lake. The lake also has two extra tiles of deep ocean to make traversal faster.

If this makes graphical changes, please attach screenshots.

Sample custom campaign layout:

…ve/Regions.py

…l file

…n the map

…areas

… the wrong variables. Added more comments in Regions.py

…nstead of numbers. WargrooveClient now sends seeds for each individual level

WG: Commander Choice options

…groove's appdata directory

…ista's Revenge. Fixed merfolk spawning in the lake in Corrupted Inlet.

SoldierofOrder

I only examined the two user-facing docs files (setup guide and info page). I think this setup guide needs a lot of work; specifically, there's a lot of redundancy, and the bugfix instructions don't satisfy me. Apart from my punctuation and grammar suggestions, I recommend trying to make the guide "flow" better for users; in particular, the guidance for what to do when Wargroove crashes is both confusing and is directly referenced by several seemingly-unrelated instructions.

worlds/wargroove/docs/en_Wargroove.md

worlds/wargroove/docs/wargroove_en.md

SoldierofOrder · 2023-02-10T16:33:50Z

worlds/wargroove/docs/wargroove_en.md

+   `Steam->Right Click Wargroove->Properties->Local Files->Browse Local Files` and copying the path in the address bar.
+   - Paste the path in between the quotes next to `root_directory:` in the `host.yaml`
+   - You may have to replace all single \\ with \\\\
+4. Start the Wargroove client. It should start with no errors, if it does go back to step 1.


Are you saying here that "if the client starts with no errors, go back to step 1"?

If you mean to say "if the client shows an error, go back to step 1", then I think you should think about ways these instructions could go wrong. After all, if there are errors, then clearly the instructions (as written) didn't work for the user the first time, and I see no reason why they'd work the second time. What are the points of failure for this installation process? Maybe pasting a badly-formatted root directory? Instead of saying "go back and do it again", maybe include sub-bullets here that instruct the user on what they should check out. Help them troubleshoot.

I think the statement It should start with no errors, if it does go back to step 1. can be removed here. There shouldn't be any surprises that the above steps cannot solve

worlds/wargroove/docs/wargroove_en.md

SoldierofOrder · 2023-02-10T17:15:59Z

worlds/wargroove/docs/wargroove_en.md

+### Wargroove crashes when trying to run the Archipelago campaign
+This is caused by not deleting campaign progress before updating the mod and campaign files.
+1. Go to `Custom Content->Create->Campaign->Archipelago->Edit` and attempt to update the mod.
+2. Wargroove will give an error message.
+3. Go back to `Custom Content->Create->Campaign->Archipelago->Edit` and attempt to update the mod again.
+4. Wargroove crashes.
+5. Go back to `Custom Content->Create->Campaign->Archipelago->Edit` and attempt to update the mod again.
+6. In the edit menu, hit `ESC` and click `Delete Progress`.
+7. If the above steps do not allow you to start the campaign from `Story->Campaign->Custom->Archipelago` replace 
+`playerProgress` and `playerProgress.bak` with your previously backed up files.


What is going on here? This whole thing seems like something that ought to be fixed. Why is the user instructed to crash their game by trying to do the same thing three times in a row? Why does attempting to update the mod not 1) instruct the user to delete their campaign, or 2) delete the campaign as part of the update? I understand if there are technical limitations, but this definitely needs to be smoothed out for the user experience.

Also, these "backed up files" aren't referenced anywhere else, as far as I can see.

This is because the campaign save data exists in a playerProgress file which contains the save data for all of the user's campaigns. This includes the vanilla and double trouble campaigns. The Archipelago campaign won't start if the mod has been updated and there is save data in the playerProgress file for the campaign. The steps above allow the user to utilize an updated campaign or mod without receiving an error when trying to start the campaign again. Unfortunately, I haven't found any other way to fix the error when updating the mod.

Okay, fair. I suggest adding instructions earlier in the guide about backing up save files, since you seem to expect that the player has such backups.

Ah I must've had those instructions in there earlier, but removed them at one point. I added a new section called Backup playerProgress files

SoldierofOrder · 2023-02-10T17:20:39Z

worlds/wargroove/docs/wargroove_en.md

+Wargroove is finicky, but there could be several causes for this. If it happens often or can be reproduced, 
+please submit a bug report.


I believe the convention is to refer users to our Discord server for bug reports; I recommend adding a link to that here.

worlds/wargroove/docs/wargroove_en.md

Co-authored-by: SoldierofOrder <[email protected]>

…k to step 1. statement from docs

SoldierofOrder

Found a couple more things. Once these suggestions are addressed, I approve these docs. :)

worlds/wargroove/docs/wargroove_en.md

worlds/wargroove/docs/en_Wargroove.md

SoldierofOrder · 2023-02-12T17:17:25Z

worlds/wargroove/docs/wargroove_en.md

+### Wargroove crashes when trying to run the Archipelago campaign
+This is caused by not deleting campaign progress before updating the mod and campaign files.
+1. Go to `Custom Content->Create->Campaign->Archipelago->Edit` and attempt to update the mod.
+2. Wargroove will give an error message.
+3. Go back to `Custom Content->Create->Campaign->Archipelago->Edit` and attempt to update the mod again.
+4. Wargroove crashes.
+5. Go back to `Custom Content->Create->Campaign->Archipelago->Edit` and attempt to update the mod again.
+6. In the edit menu, hit `ESC` and click `Delete Progress`.
+7. If the above steps do not allow you to start the campaign from `Story->Campaign->Custom->Archipelago` replace 
+`playerProgress` and `playerProgress.bak` with your previously backed up files.


Okay, fair. I suggest adding instructions earlier in the guide about backing up save files, since you seem to expect that the player has such backups.

Fixes missing punctuation. Co-authored-by: SoldierofOrder <[email protected]>

…factor.

Berserker66 · 2023-02-17T08:00:32Z

WargrooveClient.py

+    Utils.init_logging("WargrooveClient", exception_logger="Client")
+    Utils.init_logging("WG", exception_logger="Client")


only one of these two lines should be needed

Berserker66 · 2023-02-17T08:03:48Z

worlds/wargroove/__init__.py

+    item_name_to_id = {name: data.code for name, data in item_table.items()}
+    location_name_to_id = location_table
+
+    forced_auto_forfeit = True


this no longer exists

…tement in the Wargroove client. Changed the logic of Endless Knight to include harpies or dragons as viable units for completing the map.

…tement in the Wargroove client. Changed the logic of Endless Knight to include harpies or dragons as viable units for

FlySniper · 2023-02-17T22:19:37Z

worlds/wargroove/Rules.py

+    set_rule(world.get_location('Endless Knight: Victory', player),
+             lambda state: state._wargroove_has_item(player, 'Eastern Bridges') and (
+                           state._wargroove_has_item(player, 'Spearman') or
+                           state._wargroove_has_item(player, 'Harpy') or


I added a logic change here based on feedback. Spearmen, harpies or dragons can beat this level so long as the player has the Eastern Bridges. Previously, it was just spearmen.

Berserker66

I apparently can't comment on binary files; so question here:
What are the files in /worlds/wargroove/data/save and are they needed?

FlySniper · 2023-02-18T22:41:32Z

These are the custom campaign files. They are automatically installed to the Wargroove appdata directory when the client is started along with the mod. This makes installation easier for the end user.

This adds Wargroove to the list of supported games. Wargroove uses a custom non-linear campaign over the vanilla and double trouble campaigns. A Wargroove client has been added which does a lot of heavy lifting for the Wargroove implementation and must be always on during gameplay. The mod source files can be found here: https://github.com/FlySniper/WargrooveArchipelagoMod

FlySniper and others added 30 commits November 4, 2022 19:41

first commit of Wargroove

030ca9f

Merge branch 'ArchipelagoMW:main' into main

751b9b1

wargroove - initial working implementation

93c4111

Merge branch 'ArchipelagoMW:main' into main

2b32504

wargroove final level rules and some location name changes in wargroo…

b77465d

…ve/Regions.py

Wargroove - added to Launcher.py

0d761a7

Merge branch 'ArchipelagoMW:main' into main

a0389b2

Wargroove Client: added better error handling for an invalid host.yam…

a7fc81f

…l file

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

a49735d

Merge branch 'ArchipelagoMW:main' into main

731cadb

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

be2d58d

Wargroove - Corrupted Inlet now allows for Merfolk and Warships to wi…

7ea5055

…n the map

Wargroove - Fixed generator putting progression units in unreachable …

fd859dc

…areas

Merge branch 'ArchipelagoMW:main' into main

cb40130

Wargroove - renamed set_exit_locations to set_region_exit_rules

8c6ba0f

Merge branch 'ArchipelagoMW:main' into main

8e55566

Wargroove - Fixed too many items. Fixed Rules region exit rules using…

ee225cd

… the wrong variables. Added more comments in Regions.py

Wargroove - added seed distribution and ingame messages

2780a5b

Wargroove - Renamed Victory 1 and 2 locations to use faction colors i…

7f596c5

…nstead of numbers. WargrooveClient now sends seeds for each individual level

Wargroove - Random seeds are now based on the slot seed and the slot id

af466e9

Merge branch 'ArchipelagoMW:main' into main

d57484d

WG: Start inventory compatibility and CO Choice generation option

8464565

WG: Rename "CO" to "Commander" and add "Commanders" to faction items

566e608

WG: Command line commander choices

db7f04a

WG: Ignoring faction items on Locked Random

cab5ef2

WG: Locked Random client fixes

42afcd9

Merge pull request #1 from Magnemania/wargroove

12d72a2

WG: Commander Choice options

Wargroove - first commit of documentation

a054523

Wargroove - reworded some documentation

c833b91

WG: GUI Client for tracking and selecting commanders

5fb0330

FlySniper added 9 commits January 11, 2023 18:16

Wargroove - Wargroove client now installs the mod and campaign to War…

2048a1d

…groove's appdata directory

Merge branch 'ArchipelagoMW:main' into main

6a0336d

flysniper - updating mod and campaign to fix enemy COs not randomizing

26940c0

Merge branch 'ArchipelagoMW:main' into main

c6557c5

Merge branch 'ArchipelagoMW:main' into main

5ce2c74

Wargroove - Fixed camapaign descriptions in Frigid Archery and A Ball…

1151b79

…ista's Revenge. Fixed merfolk spawning in the lake in Corrupted Inlet.

Wargroove - modified troubleshooting text.

d765b59

Wargroove - added Wargroove default options to Utils.py

17cf2bb

Merge branch 'main' into main

ed68689

SoldierofOrder suggested changes Feb 10, 2023

View reviewed changes

FlySniper and others added 3 commits February 10, 2023 14:44

Apply suggestions from code review

dd4d204

Co-authored-by: SoldierofOrder <[email protected]>

Wargroove - removed It should start with no errors, if it does go bac…

282fb1d

…k to step 1. statement from docs

Wargroove - added link to the Archipelago discord.

ac2234c

SoldierofOrder approved these changes Feb 12, 2023

View reviewed changes

FlySniper and others added 5 commits February 12, 2023 14:00

Apply suggestions from code review

0ce06e1

Fixes missing punctuation. Co-authored-by: SoldierofOrder <[email protected]>

Wargroove - added the backing up of playerPrgress files to the docs.

52fdf40

Merge branch 'main' into main

0c9c0da

Wargroove - Updating region creation to be in line with the region re…

cb1cf88

…factor.

Merge branch 'main' into main

3c192c7

Berserker66 reviewed Feb 17, 2023

View reviewed changes

FlySniper added 2 commits February 17, 2023 17:12

Wargroove - Removed forced_auto_forfeit. Removed an extra logging sta…

39d96d4

…tement in the Wargroove client. Changed the logic of Endless Knight to include harpies or dragons as viable units for completing the map.

Wargroove - Removed forced_auto_forfeit. Removed an extra logging sta…

891f222

…tement in the Wargroove client. Changed the logic of Endless Knight to include harpies or dragons as viable units for

FlySniper commented Feb 17, 2023

View reviewed changes

Merge branch 'main' into main

7de994a

Berserker66 reviewed Feb 18, 2023

View reviewed changes

Berserker66 approved these changes Feb 24, 2023

View reviewed changes

Berserker66 merged commit 5966aa5 into ArchipelagoMW:main Feb 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wargroove: Implement New Game #1401

Wargroove: Implement New Game #1401

FlySniper commented Jan 22, 2023 •

edited

Loading

SoldierofOrder left a comment

SoldierofOrder Feb 10, 2023

FlySniper Feb 10, 2023

SoldierofOrder Feb 10, 2023

SoldierofOrder Feb 10, 2023

FlySniper Feb 10, 2023 •

edited

Loading

SoldierofOrder Feb 12, 2023

FlySniper Feb 12, 2023

SoldierofOrder Feb 10, 2023

SoldierofOrder left a comment

SoldierofOrder Feb 12, 2023

Berserker66 Feb 17, 2023

Berserker66 Feb 17, 2023

FlySniper Feb 17, 2023

Berserker66 left a comment

FlySniper commented Feb 18, 2023

		Wargroove is finicky, but there could be several causes for this. If it happens often or can be reproduced,
		please submit a bug report.

		Utils.init_logging("WargrooveClient", exception_logger="Client")
		Utils.init_logging("WG", exception_logger="Client")

Wargroove: Implement New Game #1401

Wargroove: Implement New Game #1401

Conversation

FlySniper commented Jan 22, 2023 • edited Loading

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

SoldierofOrder left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FlySniper Feb 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SoldierofOrder left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Berserker66 left a comment

Choose a reason for hiding this comment

FlySniper commented Feb 18, 2023

FlySniper commented Jan 22, 2023 •

edited

Loading

FlySniper Feb 10, 2023 •

edited

Loading