Jak and Daxter: Implement New Game

[massimilianodelliubaldini]

Edited OP to be more up-to-date on progress. See below for the original.

What is this fixing or adding?

This PR adds Jak and Daxter: The Precursor Legacy to Archipelago. This includes the world, the locations, the items, the text client, web world, documentation, and setup guide.

How was this tested?

• Continuous iterative development over a 9+ month timeframe, dozens of beta testers, and extensive user-reported bug tracking and fixing.
• Players have used all available options, from default settings to Move Randomizer + 100-cell Precursor Door goal + 1-orb Orbsanity.
• Players have generated solo seeds and multiplayer seeds, ranging from 1v1v1 races among Jak speedrunners, to participating in multiplayer seeds with 190 300 other players.
• Ran the WebHost locally to ensure the documentation, tutorials, and option pages all render correctly and are well organized.
• Ran the unit tests included with Archipelago.
• Added and ran custom unit tests.
• Ran a stress test with a profiler with 50+ Jak players all using random settings, collated the data, and used it to optimize seed generation.
• Streamlined new user experience to not require anything more than the standard OpenGOAL setup instructions (+mods).

If this makes graphical changes, please attach screenshots.

Original Post

This is a draft PR for code review, beta test volunteers, etc. If I've got any style issues, or use deprecated features, or have obvious logical problems, please let me know!

My origin PR squashed some 17 commits, so if you want that kind of granular history, see here.

What is this fixing or adding?

This commit adds Jak and Daxter: The Precursor Legacy to Archipelago. This includes the world, the locations, the items, the text client, web world, documentation, and setup guide.

How was this tested?

• Ran the generic python tests included with Archipelago.
• Generated both single-world and multi-world seeds.
• Read several spoiler logs to ensure the game logic was being followed.
• Manually tested the text client and the game mod itself.
  • Farthest single-world point I reached was getting 20 power cells and making it to the Blue Sage's hut (hub world 2 of 3).
  • Recorded some footage of a multi-world game here.

If this makes graphical changes, please attach screenshots.

N/A.

[massimilianodelliubaldini]

Checking in to see if anyone wants to do another code review. I'd like to get this into the next Archipelago release if possible. If anything needs more discussion, just let me know.

EDIT: I realized I never advertised this feature:

Auto Detect OpenGOAL Install

The client will now automatically find your install location of OpenGOAL and use it. You no longer have to touch the Host.yaml whatsoever after installing the apworld or mod. If it fails to find your install directory, you can still provide it manually in the Host.yaml and turn the auto-detection feature off.

[nicholassaylor]

Only got partway through the PR, but this is what I found so far. Nothing too major to report so far, just some minor things that could use changes or be addressed.

[nicholassaylor]

This will very likely need to be updated due to the various changes coming for item IDs and Python 3.8 support.

[massimilianodelliubaldini]

I presume required_client_version = (0, 6, 0)?

[nicholassaylor]

That's what I'd assume, but 0.5.1 would probably suffice for PRs sake. It's unclear what needs to be done now in preparation for 0.6.0

[massimilianodelliubaldini]

I think I actually began using the icon functionality that was merged in after 0.5.1's release, so technically I think I need this to be 0.6.0.

icon_paths["precursor_orb"] = f"ap:{__name__}/icons/precursor_orb.png"

[ScipioWright]

Isn't client version the, well, client version? Not the Archipelago version?

[massimilianodelliubaldini]

So it seems. I may have been using the wrong variable?

    required_client_version: Tuple[int, int, int] = (0, 1, 6)
    """
    override this if changes to a world break forward-compatibility of the client
    The base version of (0, 1, 6) is provided for backwards compatibility and does *not* need to be updated in the
    future. Protocol level compatibility check moved to MultiServer.min_client_version.
    """

    required_server_version: Tuple[int, int, int] = (0, 5, 0)
    """update this if the resulting multidata breaks forward-compatibility of the server"""

Let me ask what I should do in ap-world-dev.

[massimilianodelliubaldini]

Jury's still out... will revisit when my brain no longer requires percussive maintenance.

[nicholassaylor]

Changing my review to comment as nothing that I have viewed is particularly worrisome to me.

Outdated and was addressed