Stick Ranger: implement new game #5115

Kryen112 · 2025-06-15T12:55:29Z

What is this fixing or adding?

An integration of the Stick Ranger game as an APWorld.

How was this tested?

I ran all the tests, they passed (Python 3.12.10)
Also the fuzzer was ran, ~1% fail rate with more than 1 game due to accessibility settings.

If this makes graphical changes, please attach screenshots.

…o a boss stage

…s sent to the front

…o a boss stage

…s sent to the front

ScipioWright

Brief look while doing other stuff

worlds/stick_ranger/__init__.py

ScipioWright · 2025-06-16T02:04:03Z

worlds/stick_ranger/__init__.py

+            world_map_exit: Entrance = Entrance(
+                self.player, region_name, world_map_region
+            )
+            if region_name != "Opening Street":
+                world_map_exit.access_rule = make_unlock_rule(region_name)
+            world_map_region.exits.append(world_map_exit)
+            world_map_exit.connect(region)


Suggested change

world_map_exit: Entrance = Entrance(

self.player, region_name, world_map_region

)

if region_name != "Opening Street":

world_map_exit.access_rule = make_unlock_rule(region_name)

world_map_region.exits.append(world_map_exit)

world_map_exit.connect(region)

world_map_exit = world_map_region.connect(region)

if region_name != "Opening Street":

world_map_exit.access_rule = make_unlock_rule(region_name)

Pretty sure this does the same thing

Sadly this is not the same. world_map_region.connect(region) has return type None, so it does not work (tested with fuzzer, 100% fails)

I just looked in BaseClasses, Region.connect returns the entrance it created.
https://github.com/ArchipelagoMW/Archipelago/blob/main/BaseClasses.py#L1300

Is world_map_region not a Region or something?

worlds/stick_ranger/__init__.py

ScipioWright

Few more things while on break.

ScipioWright · 2025-06-16T17:30:26Z

worlds/stick_ranger/Rules.py

+def class_count(state, player: int) -> int:
+    """Return the number of ranger classes the player has unlocked."""
+    return sum(state.has(f"Unlock {cls} Class", player) for cls in RANGER_CLASSES)


Would recommend putting the classes in an item name group, then just using state.has_group or similar.

(or has_from_list if they don't make sense as item groups)

ScipioWright · 2025-06-16T17:34:01Z

worlds/stick_ranger/Rules.py

+def reached_castle(
+    player: int, threshold: int, req_classes: int
+) -> Callable[[CollectionState], bool]:
+    """Return whether or not the player has unlocked access to the Castle stage yet."""
+    return lambda state, _pl=player, _T=threshold, _keys=unlocks_by_region[
+        "Grassland"
+    ]: (
+        state.has("Unlock Castle", _pl, 1)
+        and sum(1 for k in _keys if state.has(k, _pl, 1)) >= _T
+        and class_count(state, _pl) >= req_classes
+    )


Consider just using state.can_reach_region instead of this and the similar helpers below.

ScipioWright · 2025-06-16T17:37:37Z

worlds/stick_ranger/Options.py

+class StagesReqForIceCastle(Range):
+    """
+    Actual number of required pre-Ice Castle stages to beat.
+    Only used for rules and tracking.
+    """
+
+    display_name = "Actual number of required pre-Ice Castle stages"
+    visibility = Visibility.none
+    range_start = 0
+    range_end = 14
+    default = 5


Should a player be allowed to change this option? If not, it probably shouldn't be an option, even if it's hidden. You can store information on the world class if you need to.

second this, visibility none options will be editable manually in the yaml by the player if they know about the key,
another alternative to saving these values on the world instance is Option instances can also have extra data stored on them if that makes more sense for your organization

ScipioWright · 2025-06-16T17:39:45Z

worlds/stick_ranger/docs/setup_en.md

+### Where do I get a YAML file?
+
+You can customize your settings by visiting the 
+[Stick Ranger Player Options Page](/games/Stick%20Ranger/player-options).


Suggested change

[Stick Ranger Player Options Page](/games/Stick%20Ranger/player-options).

[Stick Ranger Player Options Page](../player-options).

Would recommend just using the relative path instead

ScipioWright · 2025-06-16T17:40:12Z

worlds/stick_ranger/docs/setup_en.md

+
+### Where do I get a YAML file?
+
+You can customize your settings by visiting the 


Suggested change

You can customize your settings by visiting the

You can customize your options by visiting the

AP insists on calling player options options rather than settings.

qwint

didn't review Rules.py heavily yet, but one more overarching comment is that module names in python should be lowercase/snake_case, and earlier is better for changing those types of things

qwint · 2025-06-16T18:36:48Z

worlds/stick_ranger/test/__init__.py

really new guidance, but test base classes should be defined in a bases.py and the __init__.py in the test folder shall be empty

qwint · 2025-06-16T18:38:15Z

worlds/stick_ranger/test/TestStickRanger.py

+from . import StickRangerTestBase
+
+
+class StickRangerTest(StickRangerTestBase):


all of these test cases should already be covered by those in the base test folder, what is the purpose for these particular tests?

qwint · 2025-06-16T18:40:51Z

worlds/stick_ranger/docs/setup_en.md

+
+### Option 2: Run the Game Locally
+
+If the website is unavailable, or you wish to use your own copy:


probably worth mentioning that (since github.io doesn't allow for http connections and most browsers don't allow for ws on https connections) another reason you would need to run locally is to connect to non-webhost rooms (knowing that is a simplification of when ws is used for rooms)

qwint · 2025-06-16T18:42:26Z

worlds/stick_ranger/docs/setup_en.md

+- npm: command not found?  
+    Make sure Node.js and npm are installed and added to your system PATH.
+- Port in use error:  
+    If you get an error that the port is already in use, either stop the other process or use `npm run dev -- --port=YOURPORT` to specify another port.
+- Game not loading?  
+    Double-check you are in the correct folder and all files were extracted.


should probably properly bullet or use some other formatting, I believe on webhost this will not render like github does

qwint · 2025-06-16T18:43:42Z

worlds/stick_ranger/docs/en_Stick Ranger.md

you should try to make these md docs also fit in the 120 character per line style guide, especially with how easy it is to do so in markdown

qwint · 2025-06-16T19:04:13Z

worlds/stick_ranger/__init__.py

+        for _ in range(trap_count):
+            trap: TrapItemData = self.multiworld.random.choices(
+                traps, weights=trap_weights, k=1
+            )[0]
+            itempool.append(self.create_item(trap.item_name))


you're already using random.choices, why not just use k=trap_count?
(also as scipio has mentioned elsewhere you should use world.random)

qwint · 2025-06-16T19:06:09Z

worlds/stick_ranger/__init__.py

+        # Add Filler
+        while len(itempool) < self.location_count:
+            itempool.append(
+                self.create_item(self.multiworld.random.choice(filler).item_name)


unrelated you should define a get_filler_item_name (as otherwise any items created by core could be any item name in your entire datapackage which is often unwanted behaviour), and once you do this whole line can just be self.create_filler()

qwint · 2025-06-16T19:08:51Z

worlds/stick_ranger/__init__.py

+        self._generate_randomness()
+
+    def create_regions(self) -> None:
+        menu_region: Region = Region("Menu", self.player, self.multiworld)


if you weren't aware, a recent-ish change allows worlds to define an origin_region_name that is not Menu and remove the need for that region altogether, from a quick glance it seems like you aren't using Menu for anything in particular so that change could clean up some of this boilerplate

qwint · 2025-06-16T19:15:41Z

worlds/stick_ranger/Options.py

+    option_boxer = "Boxer"
+    option_gladiator = "Gladiator"
+    option_sniper = "Sniper"
+    option_magician = "Magician"
+    option_priest = "Priest"
+    option_gunner = "Gunner"
+    option_whipper = "Whipper"
+    option_angel = "Angel"


choice option values should be ints

qwint · 2025-06-16T19:19:37Z

worlds/stick_ranger/Options.py

+class StagesReqForIceCastle(Range):
+    """
+    Actual number of required pre-Ice Castle stages to beat.
+    Only used for rules and tracking.
+    """
+
+    display_name = "Actual number of required pre-Ice Castle stages"
+    visibility = Visibility.none
+    range_start = 0
+    range_end = 14
+    default = 5


second this, visibility none options will be editable manually in the yaml by the player if they know about the key,
another alternative to saving these values on the world instance is Option instances can also have extra data stored on them if that makes more sense for your organization

Kryen112 added 8 commits June 5, 2025 12:54

Add Stick Ranger world integration

de22b64

Add Options to set the min and max amount of stages to unlock prior t…

6db4cd1

…o a boss stage

Make sure the random genned number for amount of stages to complete i…

8a12156

…s sent to the front

Add Stick Ranger world integration

83ba32d

Add Options to set the min and max amount of stages to unlock prior t…

73d2c63

…o a boss stage

Make sure the random genned number for amount of stages to complete i…

5542d5d

…s sent to the front

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

208ce04

Run Ruff Formatter on Stick Ranger world

991cbce

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

ScipioWright added the is: new game Pull requests for implementing new games into Archipelago. label Jun 16, 2025

ScipioWright reviewed Jun 16, 2025

View reviewed changes

qwint reviewed Jun 16, 2025

View reviewed changes

Kryen112 added 3 commits June 23, 2025 08:38

Stick Ranger: Format imports of __init__.py

f3b3014

Stick Ranger: use self.random instead of self.multiworld.random

833a22d

Stick Ranger: Inline once used declared variable

300af44

	[Stick Ranger Player Options Page](/games/Stick%20Ranger/player-options).
	[Stick Ranger Player Options Page](../player-options).


		### Where do I get a YAML file?

		You can customize your settings by visiting the

	You can customize your settings by visiting the
	You can customize your options by visiting the

		from . import StickRangerTestBase


		class StickRangerTest(StickRangerTestBase):


		### Option 2: Run the Game Locally

		If the website is unavailable, or you wish to use your own copy:

Stick Ranger: implement new game #5115

Are you sure you want to change the base?

Stick Ranger: implement new game #5115

Uh oh!

Conversation

Kryen112 commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

Uh oh!

ScipioWright left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ScipioWright left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qwint left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Kryen112 commented Jun 15, 2025 •

edited

Loading