Shivers: Implement New Game #1836

GodlFire · 2023-05-24T05:39:42Z

What is this fixing or adding?

Adds Shivers as a new game.

How was this tested?

Dozens of sync/async games both shivers only worlds and any supported games worlds. Tested on 0.4.3.
Ex of games using shivers:
-https://archipelago.gg/tracker/u2_BI_dwRECO1xYPbdWn5A
-https://archipelago.gg/tracker/p99AFmWQSVal44Mlsn_TTg
-https://archipelago.gg/tracker/OtVLg7qGQ4K1rg01Fqoeig
-https://archipelago.gg/tracker/P1_FFoxuTfmFRvDQDtxY-A
-https://archipelago.gg/tracker/NbvQ1gzbQoSlyBydRLKooQ
-https://archipelago.gg/tracker/08D7KsNEQXqSwUe7ftP3lA
-https://archipelago.gg/tracker/OEn5QdJAQGWvufIzehTgqQ

If this makes graphical changes, please attach screenshots.

N/A

Added a few archipelago files

Added mandatory connections

Added rules file

Testing out events

…e they are received from a check. Added fill_restrictive to determine where the pots will be placed once they are received from a check. Still need to add rules.

-Fixed fill restrictive -Added some slot data

-Fixed typo in item Metal Pot Top -Fixed type in location name for museum blueprints -Force crawling to be placed locally in the library -Added rules for placement of pot pieces -Changed location IDs to 20000 instead of 42000

Added rules to ensure you have access to the puzzles clue

Fixed typo in metal pot top dupe

Fixed slot data to use the correct data

Added checks for ixupi captures

Fixed all generation issues except 1, locally placed crawling is being overwritten somehow every once in awhile.

…d local placed crawling selecting a storage location as a location Moved item creation out of generate basic and into create_items. Fixed local placed crawling selecting a storage location as a location

Set key for underground lake room as early item

-Put key for office elevator in sphere 2 -Fixed bug with pot piece in theater being unobtainable

Added easier lyre filler item

Added final riddle as checks Rewrote the rules to be more readable and easier to use

Removed zip

…nce until room shuffle Minor change to water capture logic, shouldnt actually make a difference until room shuffle

-Fixed unwinnable seeds with items behind tar/cloth without having access to their pots -Added locations for puzzle hints/solutions -Pushed keys for underground lake, elevator, lobby into local sphere 1. Will add as an option in future to have unchanged/early/early local

Added filler items for ixupi availability.

Bedroom Room is now just Bedroom

This is setup instructions to the best of my knowledge for the GOG version of Shivers

Removes redundancy in text

-Option for lobby access. Can be normal, early, local. -Excluded locations added to slot data

Setup instruction

-Added instructions for disc copy of shivers -Added information for .yaml files, generating a single-player game

Fixed bedroom room that was not fixed in the rules file

…ment -Fixed DUPE pot pieces ending up in other worlds. -Added Game page document

Fixed key for front door not being set to local when in local mode

Merging in 0.4.2 release to Shivers fork

Updated to use new self.random

Minor update to doc

minor update to doc

This adds key requirements for unexpected paths such as Torture to Invention now requires the Torture key. I ignored all dead-end rooms such as janitor, workshop and bedroom. I also didn't adjust anything for puzzle doors like burial door, red door and Clock Tower Staircase

Key rule prep for room rando

Adds new filler item heal and replaces the extra easier lyres that were in the pool with the new heal filler

-Added option to have elevators as checks

Fix unit test for completion condition by moving completion condition from generate output to generate basic

-Fixed a failure to generate when not using elevator checks due to not excluding the location rule -Hopefully fixed many workflow errors

-Adds early beth option -Cleans up rules.py a bit

-Adds option for early lightning

Cleanup

alwaysintreble

mostly fine, just a few things to call out. definitely recommend updating to the new options API and adding some tests though.

alwaysintreble · 2023-10-30T14:21:21Z

worlds/shivers/__init__.py

+from . import Constants, Rules
+from .Options import Shivers_options, get_option_value
+
+client_version = 0


what is this for?

I have no idea, I saw it in a lot of worlds. I am guessing it is not needed for anything. I have deleted it.

alwaysintreble · 2023-10-30T14:21:27Z

worlds/shivers/__init__.py

+
+    item_name_to_id = {name: data.code for name, data in item_table.items()}
+    location_name_to_id = Constants.location_name_to_id
+    data_version = 0


can be removed

alwaysintreble · 2023-10-30T14:22:52Z

worlds/shivers/__init__.py

+        # Create regions
+        for region_name, exits in Constants.region_info["regions"]:
+            r = Region(region_name, self.player, self.multiworld)
+            for exit_name in exits:


Suggested change

for exit_name in exits:

r.add_exits(exits)

Updated to r.create_exit(exit_name)

alwaysintreble · 2023-10-30T14:27:44Z

worlds/shivers/__init__.py

+
+    def create_items(self) -> None:
+        # Add pots
+        pots = [self.create_item(name) for name, data in item_table.items() if data.type == 'pot']


it'd be much better to do all of these in a single loop since you don't seem to actually do any differentiation between all these lists. something like

itempool = [] for name, data in item_table.items(): if data.type in {"pot", "key", "ability", "filler2"}: itempool.append(self.create_item(name))```

Updated to use suggested.

alwaysintreble · 2023-10-30T14:28:45Z

worlds/shivers/__init__.py

+        elif library_random == 3: 
+            librarylocation.place_locked_item(self.create_item("Key for Three Floor Elevator"))
+
+            librarylocationkeytwo = self.multiworld.random.choice([loc for loc in library_region.locations if not loc.name.startswith("Accessible:") and loc != librarylocation])


self.random

Thought i got all of those. Fixed

alwaysintreble · 2023-10-30T14:31:22Z

worlds/shivers/__init__.py

+        storageitems += [self.create_item(name) for name, data in item_table.items() if data.type == 'potduplicate']
+        storageitems += [self.create_item("Empty") for i in range(3)]
+
+        state = self.multiworld.get_all_state(False)


why aren't you using the cache?

Updated to use cache.

alwaysintreble · 2023-10-30T14:31:38Z

worlds/shivers/__init__.py

+
+        state = self.multiworld.get_all_state(False)
+
+        self.multiworld.random.shuffle(storagelocs)


self.random

alwaysintreble · 2023-10-30T14:33:27Z

worlds/shivers/Rules.py

+
+def water_capturable(state: CollectionState, player: int) -> bool:
+    return (state.can_reach("Lobby", "Region", player) or (state.can_reach("Janitor Closet", "Region", player) and cloth_capturable(state, player))) \
+        and state.has("Water Pot Bottom", player) \


state.has_all. same comment for most of this file

Updated Rules.py to use state.has_all throughout

-Review comments addressed. -Updated en_Shivers.md to note who to contact if a bug is encountered

GodlFire · 2023-11-02T05:30:31Z

mostly fine, just a few things to call out. definitely recommend updating to the new options API and adding some tests though.

I have upddated to use the new options API

…items Fixed an option not using new API. Added weight selection for filler items.

Updated README.md and docs/CODEOWNERS to add mentions to shivers

…ew front door key option. New Front door key allows the player to bypass Egyptian Hieroglyphs Explained, this change requires the player have access to the flashback before solving Theater Door, Columns or RA, and Dropping the Guillotine if using the setting PuzzleHintsRequired

ThePhar · 2023-11-24T19:44:36Z

worlds/shivers/__init__.py

+
+        #Place library escape items. Choose a location to place the escape item
+        library_region = self.multiworld.get_region("Library", self.player)
+        librarylocation = self.multiworld.random.choice([loc for loc in library_region.locations if not loc.name.startswith("Accessible:")])


Suggested change

librarylocation = self.multiworld.random.choice([loc for loc in library_region.locations if not loc.name.startswith("Accessible:")])

librarylocation = self.random.choice([loc for loc in library_region.locations if not loc.name.startswith("Accessible:")])

Changed as requested

ThePhar · 2023-11-24T19:46:40Z

worlds/shivers/__init__.py

+
+    set_rules = set_rules
+
+    def generate_basic(self):


Makes more sense using this method.

Suggested change

def generate_basic(self):

def set_rules(self):

Moved completion condition rule being set in generate_Basic to set_rules in rules file. Removed generate_basic.

ThePhar · 2023-11-24T19:47:29Z

worlds/shivers/__init__.py

+        }
+
+    def fill_slot_data(self) -> dict:
+        slot_data = self._get_slot_data()


Any reason you couldn't move the contents of _get_slot_data to this function?

Nope, moved the contents of _get_slot_data to fill_slot_data

ThePhar · 2023-11-24T19:47:57Z

worlds/shivers/__init__.py

+
+    def _get_slot_data(self):
+        return {
+            'storageplacements': self.storage_placements,


Minor nitpick, but most of the quotes earlier use ", but these are ' quotes.

Updated to use " instead of ' for consistency

ThePhar · 2023-11-24T19:52:00Z

worlds/shivers/Rules.py

+    return rules_lookup
+
+
+def set_rules(Shivers: World) -> None:


Minor nitpick, but should probably be either shivers: World or world: World to match PEP8.

Although that being said, if you want to have good type hinting, add to your imports:

from typing import TYPE_HINTING # partial for example if TYPE_HINTING: from . import ShiversWorld

Then use def set_rules(world: "ShiversWorld") -> None: (quotes are needed since you aren't actually importing ShiversWorld.)

Then you get nice type hinting when you access the options attribute. I would recommend this over what I said above.

Updated to get good type hinting as suggested.

ThePhar · 2023-11-24T19:52:25Z

worlds/shivers/__init__.py

+
+class ShiversWorld(World):
+    """ 
+     Shivers is a horror themed point and click adventure. Explore the mysteries of Windlenot's Museum of the Strange and Unusual.


minor nitpick, extra space.

Suggested change

Shivers is a horror themed point and click adventure. Explore the mysteries of Windlenot's Museum of the Strange and Unusual.

Shivers is a horror themed point and click adventure. Explore the mysteries of Windlenot's Museum of the Strange and Unusual.

Extra space removed

ThePhar · 2023-11-24T19:52:37Z

worlds/shivers/__init__.py

+        "English",
+        "setup_en.md",
+        "setup/en",
+        ["GodlFire, Mathx2"]


Suggested change

["GodlFire, Mathx2"]

["GodlFire", "Mathx2"]

Fixed formatting

Co-authored-by: Mathx2 <[email protected]> Co-authored-by: Zach Parks <[email protected]>

GodlFire and others added 30 commits March 24, 2023 22:30

Added a few archipelago files

8530585

Added a few archipelago files

Added mandatory connections

efd28de

Added mandatory connections

Added rules file

d738598

Added rules file

Testing out events

390231d

Testing out events

Added fill_restrictive to determine where the pots will be placed onc…

07191e0

…e they are received from a check. Added fill_restrictive to determine where the pots will be placed once they are received from a check. Still need to add rules.

Changes to init

47a4751

-Fixed fill restrictive -Added some slot data

Fixes

1a8f32b

-Fixed typo in item Metal Pot Top -Fixed type in location name for museum blueprints -Force crawling to be placed locally in the library -Added rules for placement of pot pieces -Changed location IDs to 20000 instead of 42000

Added rules to ensure you have access to the puzzles clue

fe70b9b

Added rules to ensure you have access to the puzzles clue

Fixed typo in metal pot top dupe

cba1bfa

Fixed typo in metal pot top dupe

Fixed slot data to use the correct data

d2b2a4d

Fixed slot data to use the correct data

Added checks for ixupi captures

84715f0

Added checks for ixupi captures

Generation issue fixes

665b507

Fixed all generation issues except 1, locally placed crawling is being overwritten somehow every once in awhile.

Moved item creation out of generate basic and into create_items. Fixe…

58d5cc4

…d local placed crawling selecting a storage location as a location Moved item creation out of generate basic and into create_items. Fixed local placed crawling selecting a storage location as a location

Set key for underground lake room as early item

b6dc7fa

Set key for underground lake room as early item

Bug fix with broken seed

13afe21

-Put key for office elevator in sphere 2 -Fixed bug with pot piece in theater being unobtainable

Added easier lyre filler item

bff36df

Added easier lyre filler item

Added final riddle as checks

bbc709a

Added final riddle as checks Rewrote the rules to be more readable and easier to use

Removed zip

4144967

Removed zip

Minor change to water capture logic, shouldnt actually make a differe…

dc4870d

…nce until room shuffle Minor change to water capture logic, shouldnt actually make a difference until room shuffle

Added filler items for ixupi availability.

eca1c32

Added filler items for ixupi availability.

Removes redundancy in text

dc7c8ad

Bedroom Room is now just Bedroom

Setup instruction

4997e48

This is setup instructions to the best of my knowledge for the GOG version of Shivers

Merge pull request #1 from Mathx2/patch-1

120ed80

Removes redundancy in text

Lobby access option, exclude locations added to slot data.

550d317

-Option for lobby access. Can be normal, early, local. -Excluded locations added to slot data

Merge branch 'main' of https://github.com/GodlFire/Shivers

c8593d5

Merge pull request #2 from Mathx2/patch-2

8d07505

Setup instruction

Update setup_en.md

4186bee

-Added instructions for disc copy of shivers -Added information for .yaml files, generating a single-player game

Fixed bedroom room that was not fixed in the rules file

0e7b2e9

Fixed bedroom room that was not fixed in the rules file

Fixed DUPE pot pieces ending up in other worlds. Added Game page docu…

ecc04ea

…ment -Fixed DUPE pot pieces ending up in other worlds. -Added Game page document

GodlFire and others added 15 commits August 20, 2023 08:25

Fixed key for front door not being set to local when in local mode

a5714e5

Fixed key for front door not being set to local when in local mode

Merge pull request #6 from ArchipelagoMW/main

317e8a1

Merging in 0.4.2 release to Shivers fork

Updated to use new self.random

09ec349

Updated to use new self.random

Update en_Shivers.md

7ab98a4

Minor update to doc

Update setup_en.md

6ff2280

minor update to doc

Merge pull request #7 from Mathx2/main

3693d96

Key rule prep for room rando

Adds new filler item heal

32a27dc

Adds new filler item heal and replaces the extra easier lyres that were in the pool with the new heal filler

New Feature

935ef46

-Added option to have elevators as checks

Fix unit test for completion condition

2f0fdde

Fix unit test for completion condition by moving completion condition from generate output to generate basic

Fixed a failure to generate when not using elevator checks

3a3295d

-Fixed a failure to generate when not using elevator checks due to not excluding the location rule -Hopefully fixed many workflow errors

Merge branch 'main' into main

be36a11

New Feature: Early Beth

54899a6

-Adds early beth option -Cleans up rules.py a bit

New feature

eb44a0e

-Adds option for early lightning

Cleanup

309c391

Cleanup

alwaysintreble reviewed Oct 30, 2023

View reviewed changes

alwaysintreble review comments addressed

93bbd39

-Review comments addressed. -Updated en_Shivers.md to note who to contact if a bug is encountered

Fixed an option not using new API. Added weight selection for filler …

a165652

…items Fixed an option not using new API. Added weight selection for filler items.

ThePhar self-assigned this Nov 24, 2023

GodlFire added 3 commits November 24, 2023 11:35

Merge branch 'main' into main

5d3e178

Updated README.md and docs/CODEOWNERS to add mentions to shivers

7d8441c

Updated README.md and docs/CODEOWNERS to add mentions to shivers

ThePhar requested changes Nov 24, 2023

View reviewed changes

Phar's review comments addressed

ea2ade4

ThePhar approved these changes Nov 24, 2023

View reviewed changes

Merge branch 'main' into main

f8718fa

ThePhar changed the title ~~Shivers: implement new game~~ Shivers: Implement New Game Nov 24, 2023

ThePhar merged commit 8d41430 into ArchipelagoMW:main Nov 24, 2023

Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024

Shivers: Implement New Game (ArchipelagoMW#1836)

7d2925a

Co-authored-by: Mathx2 <[email protected]> Co-authored-by: Zach Parks <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Shivers: Implement New Game #1836

Shivers: Implement New Game #1836

GodlFire commented May 24, 2023 •

edited

Loading

alwaysintreble left a comment

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

alwaysintreble Oct 30, 2023

GodlFire Nov 2, 2023

GodlFire commented Nov 2, 2023

ThePhar Nov 24, 2023

GodlFire Nov 24, 2023

ThePhar Nov 24, 2023

GodlFire Nov 24, 2023

ThePhar Nov 24, 2023

GodlFire Nov 24, 2023

ThePhar Nov 24, 2023

GodlFire Nov 24, 2023

ThePhar Nov 24, 2023 •

edited

Loading

GodlFire Nov 24, 2023

ThePhar Nov 24, 2023

GodlFire Nov 24, 2023

ThePhar Nov 24, 2023

GodlFire Nov 24, 2023


		state = self.multiworld.get_all_state(False)

		self.multiworld.random.shuffle(storagelocs)

	librarylocation = self.multiworld.random.choice([loc for loc in library_region.locations if not loc.name.startswith("Accessible:")])
	librarylocation = self.random.choice([loc for loc in library_region.locations if not loc.name.startswith("Accessible:")])

	Shivers is a horror themed point and click adventure. Explore the mysteries of Windlenot's Museum of the Strange and Unusual.
	Shivers is a horror themed point and click adventure. Explore the mysteries of Windlenot's Museum of the Strange and Unusual.

Shivers: Implement New Game #1836

Shivers: Implement New Game #1836

Conversation

GodlFire commented May 24, 2023 • edited Loading

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

alwaysintreble 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

GodlFire commented Nov 2, 2023

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

ThePhar Nov 24, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GodlFire commented May 24, 2023 •

edited

Loading

ThePhar Nov 24, 2023 •

edited

Loading