morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

A Hat in Time: Implement New Game (#2640)

Browse Source 
Adds A Hat in Time as a supported game in Archipelago.
This commit is contained in:
CookieCat
2024-05-20 03:04:06 -04:00
committed by GitHub
parent c792ae76ca
commit fe7bc8784d
19 changed files with 5715 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
worlds/ahit/docs/en_A Hat in Time.md Normal file
View File

@@ -0,0 +1,53 @@
# A Hat in Time
## Where is the options page?
The [player options page for this game](../player-options) contains all the options you need to configure and export a
config file.
## What does randomization do to this game?
Items which the player would normally acquire throughout the game have been moved around.
Chapter costs are randomized in a progressive order based on your options,
so for example you could go to Subcon Forest -> Battle of the Birds -> Alpine Skyline, etc. in that order.
If act shuffle is turned on, the levels and Time Rifts in these chapters will be randomized as well.
To unlock and access a chapter's Time Rift in act shuffle,
the levels in place of the original acts required to unlock the Time Rift in the vanilla game must be completed,
and then you must enter a level that allows you to access that Time Rift.
For example, Time Rift: Bazaar requires Heating Up Mafia Town to be completed in the vanilla game.
To unlock this Time Rift in act shuffle (and therefore the level it contains)
you must complete the level that was shuffled in place of Heating Up Mafia Town
and then enter the Time Rift through a Mafia Town level.
## What items and locations get shuffled?
Time Pieces, Relics, Yarn, Badges, and most other items are shuffled.
Unlike in the vanilla game, yarn is typeless, and hats will be automatically stitched
in a set order once you gather enough yarn for each hat.
Hats can also optionally be shuffled as individual items instead.
Any items in the world, shops, act completions,
and optionally storybook pages or Death Wish contracts are locations.
Any freestanding items that are considered to be progression or useful
will have a rainbow streak particle attached to them.
Filler items will have a white glow attached to them instead.
## Which items can be in another player's world?
Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit
certain items to your own world.
## What does another world's item look like in A Hat in Time?
Items belonging to other worlds are represented by a badge with the Archipelago logo on it.
## When the player receives an item, what happens?
When the player receives an item, it will play the item collect effect and information about the item
will be printed on the screen and in the in-game developer console.
## Is the DLC required to play A Hat in Time in Archipelago?
No, the DLC expansions are not required to play. Their content can be enabled through certain options
that are disabled by default, but please don't turn them on if you don't own the respective DLC.

102
worlds/ahit/docs/setup_en.md Normal file
View File

@@ -0,0 +1,102 @@
# Setup Guide for A Hat in Time in Archipelago
## Required Software
- [Steam release of A Hat in Time](https://store.steampowered.com/app/253230/A_Hat_in_Time/)
- [Archipelago Workshop Mod for A Hat in Time](https://steamcommunity.com/sharedfiles/filedetails/?id=3026842601)
## Optional Software
- [A Hat in Time Archipelago Map Tracker](https://github.com/Mysteryem/ahit-poptracker/releases), for use with [PopTracker](https://github.com/black-sliver/PopTracker/releases)
## Instructions
1. Have Steam running. Open the Steam console with this link: [steam://open/console](steam://open/console)
This may not work for some browsers. If that's the case, and you're on Windows, open the Run dialog using Win+R,
paste the link into the box, and hit Enter.
2. In the Steam console, enter the following command:
`download_depot 253230 253232 7770543545116491859`. ***Wait for the console to say the download is finished!***
This can take a while to finish (30+ minutes) depending on your connection speed, so please be patient. Additionally,
**try to prevent your connection from being interrupted or slowed while Steam is downloading the depot,**
or else the download may potentially become corrupted (see first FAQ issue below).
3. Once the download finishes, go to `steamapps/content/app_253230` in Steam's program folder.
4. There should be a folder named `depot_253232`. Rename it to HatinTime_AP and move it to your `steamapps/common` folder.
5. In the HatinTime_AP folder, navigate to `Binaries/Win64` and create a new file: `steam_appid.txt`.
In this new text file, input the number **253230** on the first line.
6. Create a shortcut of `HatinTimeGame.exe` from that folder and move it to wherever you'd like.
You will use this shortcut to open the Archipelago-compatible version of A Hat in Time.
7. Start up the game using your new shortcut. To confirm if you are on the correct version,
go to Settings -> Game Settings. If you don't see an option labelled ***Live Game Events*** you should be running
the correct version of the game. In Game Settings, make sure ***Enable Developer Console*** is checked.
## Connecting to the Archipelago server
To connect to the multiworld server, simply run the **ArchipelagoAHITClient**
(or run it from the Launcher if you have the apworld installed) and connect it to the Archipelago server.
The game will connect to the client automatically when you create a new save file.
## Console Commands
Commands will not work on the title screen, you must be in-game to use them. To use console commands,
make sure ***Enable Developer Console*** is checked in Game Settings and press the tilde key or TAB while in-game.
`ap_say <message>` - Send a chat message to the server. Supports commands, such as `!hint` or `!release`.
`ap_deathlink` - Toggle Death Link.
## FAQ/Common Issues
### I followed the setup, but I receive an odd error message upon starting the game or creating a save file!
If you receive an error message such as
**"Failed to find default engine .ini to retrieve My Documents subdirectory to use. Force quitting."** or
**"Failed to load map "hub_spaceship"** after booting up the game or creating a save file respectively, then the depot
download was likely corrupted. The only way to fix this is to start the entire download all over again.
Unfortunately, this appears to be an underlying issue with Steam's depot downloader. The only way to really prevent this
from happening is to ensure that your connection is not interrupted or slowed while downloading.
### The game keeps crashing on startup after the splash screen!
This issue is unfortunately very hard to fix, and the underlying cause is not known. If it does happen however,
try the following:
- Close Steam **entirely**.
- Open the downpatched version of the game (with Steam closed) and allow it to load to the titlescreen.
- Close the game, and then open Steam again.
- After launching the game, the issue should hopefully disappear. If not, repeat the above steps until it does.
### I followed the setup, but "Live Game Events" still shows up in the options menu!
The most common cause of this is the `steam_appid.txt` file. If you're on Windows 10, file extensions are hidden by
default (thanks Microsoft). You likely made the mistake of still naming the file `steam_appid.txt`, which, since file
extensions are hidden, would result in the file being named `steam_appid.txt.txt`, which is incorrect.
To show file extensions in Windows 10, open any folder, click the View tab at the top, and check
"File name extensions". Then you can correct the name of the file. If the name of the file is correct,
and you're still running into the issue, re-read the setup guide again in case you missed a step.
If you still can't get it to work, ask for help in the Discord thread.
### The game is running on the older version, but it's not connecting when starting a new save!
For unknown reasons, the mod will randomly disable itself in the mod menu. To fix this, go to the Mods menu
(rocket icon) in-game, and re-enable the mod.
### Why do relics disappear from the stands in the Spaceship after they're completed?
This is intentional behaviour. Because of how randomizer logic works, there is no way to predict the order that
a player will place their relics. Since there are a limited amount of relic stands in the Spaceship, relics are removed
after being completed to allow for the placement of more relics without being potentially locked out.
The level that the relic set unlocked will stay unlocked.
### When I start a new save file, the intro cinematic doesn't get skipped, Hat Kid's body is missing and the mod doesn't work!
There is a bug on older versions of A Hat in Time that causes save file creation to fail to work properly
if you have too many save files. Delete them and it should fix the problem.