Links Awakening: Implement New Game #1334

zig-for · 2022-12-18T01:37:55Z

What is this fixing or adding?

Adds Link's Awakening: DX. Fully imports and forks LADXR, with permission - https://github.com/daid/LADXR

How was this tested?

Multiple beta tests. No major issues have been revealed over the past few ones.

Known bugs:

Check count at the end screen could be off by 5, due to local only items using a special snowflake collection method - will fix in later revision
Client hangs when waiting on player to actually collect an item
One person was unable to connect to Retroarch, still a mystery why, need more data

worlds/ladx/LADXR/.github/workflows/multiworld_build.yml

worlds/ladx/LADXR/.gitignore

worlds/ladx/LADXR/LICENSE

Jarno458

Tnx for the cleanup

SoldierofOrder

Only examined the two user-facing docs files (setup guide and info page). Very thorough and clear writing!

worlds/ladx/docs/en_Links Awakening DX.md

worlds/ladx/docs/setup_en.md

worlds/ladx/Items.py

worlds/ladx/Options.py

Berserker66 · 2023-02-24T08:19:56Z

host.yaml

@@ -82,7 +82,7 @@ generator:
  race: 0
  # List of options that can be plando'd. Can be combined, for example "bosses, items"
  # Available options: bosses, items, texts, connections
-  plando_options: "bosses"
+  plando_options: "items"


why is this change here?

Had to change it during a beta test, accidentally committed. Will do another pass tonight for small things like this I've missed.

Berserker66 · 2023-03-01T16:43:31Z

worlds/ladx/docs/setup_en.md

+   Network Command Port at 55355.
+
+![Screenshot of Network Commands setting](/static/generated/docs/A%20Link%20to%20the%20Past/retroarch-network-commands-en.png)
+4. Go to Main Menu --> Online Updater --> Core Downloader. Scroll down and select "Nintendo - SNES / SFC (bsnes-mercury


This seems like the wrong core

inno_setup.iss

…s causing one item description to always be overwritten. Eventually most of shop.py can be removed.

…python GC race. Track a few more tasks.

el-u · 2023-03-02T23:34:23Z

worlds/ladx/docs/en_Links Awakening DX.md

+
+This randomizer is based on (forked from) the wonderful work daid did on LADXR - https://github.com/daid/LADXR
+
+The autotracker code for communication with magpie tracker is directly copied from kbranch's repo - https://github.com/kbranch/Magpie/tree/master/autotracking


So you copied from a repository that does not come with a license, but which says it has been ported from yet another repository that also does not grant us any license whatsoever? And you are now passing that off as MIT.

I'll get kbranch to supply a license. He gave permission, I promise. :) Good catch.

fwiw - LADXR is MIT licensed. https://github.com/daid/LADXR/blob/master/LICENSE

Zig definitely asked for permission before touching anything, for what it's worth. I thought I had added an MIT LICENSE file, but apparently I forgot it - I just added it.

Magpie also doesn't use any actual code from the old Emotracker pack, so anything he uses is safe. If there are still concerns, I'm sure MuffinJets would happily make it official in his repo as well.

Thanks for releasing it as MIT.

I can't speak for how EmoTracker as a core applies here, but if Magpie has any leftover code from my work, I give full permission and will apply MIT if needed

worlds/ladx/docs/setup_en.md

Berserker66 · 2023-03-05T08:54:07Z

LinksAwakeningClient.py

+
+class LinksAwakeningContext(CommonContext):
+    tags = {"AP"}
+    game = "Links Awakening DX"  # empty matches any game since 0.3.2


these comments are copied from text clients and all 3 don't apply to this client

Berserker66 · 2023-03-05T08:59:17Z

worlds/ladx/Options.py

+    ladxr_name = "tradequest"
+
+
+#            Setting('forwardfactor', 'Main', 'F', 'Forward Factor', default=0.0,


looks like leftover stuff that could be removed? I found a bunch of single line old code comments as well, but this one is a bit big

Berserker66 · 2023-03-05T08:59:57Z

worlds/ladx/Options.py

+# TODO: translate to lttp parlance
+class EntranceShuffle(Choice, LADXROption):
+    """
+    [WARNING] Experimental, may break generation


What does "break generation" mean in AP context?

From conversations, I believe that it will sometimes generate entrance layouts that isolate groups of checks, which is not accounted for, and it will fail accessibility checks.

Confirmed with zig this is the case.

I believe SM can do that too, in which case it forces accessibility minimal

I'll verify this tonight, but when I checked with zig about this, they mentioned that EntranceShuffle is disabled for this first version anyway.

You could search for unreachable locations under an "all state" and delete them, maybe? Or if they have events / prefilled advancement items, set those items to filler classification. Then it should be able to succeed under either items or minimal accessibility?

I believe a proper solution to prevent isolated locations from occurring in the first place is in the works for a future update.

Berserker66 · 2023-03-05T09:03:10Z

worlds/ladx/__init__.py

+    def create_item(self, item: str) -> LinksAwakeningItem:
+        assert(False)
+


Suggested change

def create_item(self, item: str) -> LinksAwakeningItem:

assert(False)

This is defined again further down, so this can go away.

Berserker66 · 2023-03-05T09:07:10Z

worlds/ladx/__init__.py

+
+    def modify_multidata(self, multidata: dict):
+        multi_key = binascii.hexlify(self.generate_multi_key()).decode()
+        multidata["connect_names"][multi_key] = multidata["connect_names"][self.multiworld.player_name[self.player]]


I see you encode a connect name, but also allow the client user entry of the player name?
I think that makes this the first game to do that, normally if a connect hash is encoded, that's the only way to connect with that game's client.

Alchav · 2023-03-15T17:37:29Z

worlds/ladx/Options.py

+    [Hell] Obscure knowledge and hard techniques may be required. Examples include featherless jumping with boots and/or hookshot, sequential pit buffers and unclipped superjumps. Things in here can be extremely hard to do or very time consuming."""
+    display_name = "Logic"
+    ladxr_name = "logic"
+    # option_casual = 0


Option is described in description but is disabled

Resolve PR Notes

Adds Link's Awakening: DX. Fully imports and forks LADXR, with permission - https://github.com/daid/LADXR

zig-for changed the title ~~Links awakening~~ Links Awakening: Draft Dec 18, 2022

zig-for changed the title ~~Links Awakening: Draft~~ Links Awakening: Implement New Game Feb 4, 2023

zig-for marked this pull request as ready for review February 5, 2023 23:47

Jarno458 reviewed Feb 6, 2023

View reviewed changes

worlds/ladx/LADXR/.github/workflows/multiworld_build.yml Outdated Show resolved Hide resolved

worlds/ladx/LADXR/.gitignore Outdated Show resolved Hide resolved

worlds/ladx/LADXR/LICENSE Outdated Show resolved Hide resolved

zig-for requested a review from Jarno458 February 7, 2023 00:52

Jarno458 reviewed Feb 8, 2023

View reviewed changes

SoldierofOrder approved these changes Feb 10, 2023

View reviewed changes

worlds/ladx/docs/en_Links Awakening DX.md Outdated Show resolved Hide resolved

worlds/ladx/docs/setup_en.md Outdated Show resolved Hide resolved

worlds/ladx/docs/setup_en.md Outdated Show resolved Hide resolved

worlds/ladx/docs/setup_en.md Outdated Show resolved Hide resolved

Alchav reviewed Feb 15, 2023

View reviewed changes

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

Berserker66 reviewed Feb 17, 2023

View reviewed changes

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

Berserker66 reviewed Feb 24, 2023

View reviewed changes

black-sliver added the is: new game Pull requests for implementing new games into Archipelago. label Feb 27, 2023

Berserker66 reviewed Mar 1, 2023

View reviewed changes

inno_setup.iss Show resolved Hide resolved

squash

cd959f1

zig-for force-pushed the links_awakening branch from 508e277 to cd959f1 Compare March 2, 2023 06:25

zig-for added 9 commits March 1, 2023 22:56

Fixup the fact that both shop items were in the same room ID. This wa…

62a76f0

…s causing one item description to always be overwritten. Eventually most of shop.py can be removed.

Add back in the mysteriously commented out log for exceptions. Avoid …

e715e95

…python GC race. Track a few more tasks.

Fixup core name in docs

ff5e56f

attempt to fix inno setup

1cedb29

fix issues with inno file

cfa62a9

set data version back to 1

7685ee2

Add missing ROMs, normalize caps

2fd24ac

remove stray semicolon

830487f

finally, fix icon and exe association

0dfd59f

el-u reviewed Mar 2, 2023

View reviewed changes

Update setup_en.md

9d2ad08

Berserker66 reviewed Mar 5, 2023

View reviewed changes

PoryGone added 2 commits March 14, 2023 18:41

Resolve PR Notes

d3e8c9a

Remove generation prints

025a50b

Alchav reviewed Mar 15, 2023

View reviewed changes

PoryGone and others added 3 commits March 15, 2023 23:44

Remove Casual Logic docstring

8221e77

Merge pull request #8 from PoryGoneDev/ladx-updates

ecdeab1

Resolve PR Notes

Merge branch 'main' into links_awakening

41b831e

Berserker66 approved these changes Mar 20, 2023

View reviewed changes

Berserker66 merged commit 81a2393 into ArchipelagoMW:main Mar 20, 2023

FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023

Links Awakening: Implement New Game (ArchipelagoMW#1334)

fa98013

Adds Link's Awakening: DX. Fully imports and forks LADXR, with permission - https://github.com/daid/LADXR

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Links Awakening: Implement New Game #1334

Links Awakening: Implement New Game #1334

zig-for commented Dec 18, 2022 •

edited

Loading

Jarno458 left a comment

SoldierofOrder left a comment

Berserker66 Feb 24, 2023

zig-for Feb 24, 2023

Berserker66 Mar 1, 2023

zig-for Mar 2, 2023

el-u Mar 2, 2023

zig-for Mar 3, 2023

zig-for Mar 3, 2023

zig-for Mar 3, 2023

kbranch Mar 3, 2023

el-u Mar 3, 2023

muffinjets Mar 7, 2023

Berserker66 Mar 5, 2023

Berserker66 Mar 5, 2023

Berserker66 Mar 5, 2023

PoryGone Mar 5, 2023

PoryGone Mar 16, 2023

Berserker66 Mar 17, 2023

PoryGone Mar 17, 2023

Alchav Mar 17, 2023

PoryGone Mar 17, 2023

Berserker66 Mar 5, 2023

Berserker66 Mar 5, 2023

Alchav Mar 15, 2023

PoryGone Mar 16, 2023


		This randomizer is based on (forked from) the wonderful work daid did on LADXR - https://github.com/daid/LADXR

		The autotracker code for communication with magpie tracker is directly copied from kbranch's repo - https://github.com/kbranch/Magpie/tree/master/autotracking

		ladxr_name = "tradequest"


		# Setting('forwardfactor', 'Main', 'F', 'Forward Factor', default=0.0,

		def create_item(self, item: str) -> LinksAwakeningItem:
		assert(False)

Links Awakening: Implement New Game #1334

Links Awakening: Implement New Game #1334

Conversation

zig-for commented Dec 18, 2022 • edited Loading

What is this fixing or adding?

How was this tested?

Known bugs:

Jarno458 left a 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

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

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

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

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

zig-for commented Dec 18, 2022 •

edited

Loading