https://github.com/cheatfreak47/apsa2b-linker-handler

a userscript and url handler to automate launching SA2B archipelago games
https://github.com/cheatfreak47/apsa2b-linker-handler

Last synced: 3 months ago
JSON representation

a userscript and url handler to automate launching SA2B archipelago games

• Host: GitHub
• URL: https://github.com/cheatfreak47/apsa2b-linker-handler
• Owner: cheatfreak47
• License: wtfpl
• Created: 2024-03-01T23:54:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-02T06:51:02.000Z (almost 2 years ago)
• Last Synced: 2025-07-23T03:33:30.158Z (11 months ago)
• Language: AutoHotkey
• Size: 5.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# SA2B Archipelago Instant Launch thing

Listen here. I'm lazy and don't wanna open SA2 Mod Loader every time. I wanna click a button and it all just does it for me.

https://github.com/cheatfreak47/apsa2b-linker-handler/assets/7818664/b88c83fb-f4d2-49ad-8fb8-0477711d5899

So I made this. All the code is pretty well commented and clear about how it works, but do note it's obviously not official or officially supported or anything. Don't go bothering anyone but me in the issues section about it.

# Usage:

 - Install [Sonic Adventure 2 from Steam](https://store.steampowered.com/app/213610/Sonic_Adventure_2/)

 - Install [Archipelago](https://archipelago.gg)

 - Set up the [SA2 Mod Loader](https://mm.reimuhakurei.net/sa2mods/SA2ModLoader.7z) or [SA Mod Manager](https://github.com/X-Hax/SA-Mod-Manager/releases/latest)

 - Set up the [SA2B Archipelago Mod](https://archipelago.gg/tutorial/Sonic%20Adventure%202%20Battle/setup/en). Don't forget to run the batch file included with the mod.

 - Install your favorite userscript extension on your default browser. (examples include: Tampermonkey, Violentmonkey, Greasemonkey, Firemonkey, etc) My favorite is [FireMonkey on Firefox](https://addons.mozilla.org/en-US/firefox/addon/firemonkey/).

 - Install the [userscript](https://raw.githubusercontent.com/cheatfreak47/apsa2b-linker-handler/main/APSA2BLinker.user.js) from this repo.

 - Download and un7z the [compiled release](https://github.com/cheatfreak47/apsa2b-linker-handler/releases) or compile `APSA2BHandler.ahk` from the repository yourself.

 - Take the resulting `APSA2BHandler.exe` and put it in the Sonic Adventure 2 install folder or the Archipelago install folder.

 - Run `APSA2BHandler.exe` and click on Install to install the URL Handler.

 - That's it. To remove the URL Handler run the program again and choose Uninstall.

## How it works for people who don't read code

Basically it registers a new URL type that when you click on it, runs a program that configures your SA2B_Archipelago mod for you, loads up the Text Client, and Launches the game for you. The new URLs are added to the page by a userscript you install in a userscript browser extension. That's it.

## Description for APSA2B Linker JS

![Image of Linker in Action](https://raw.githubusercontent.com/cheatfreak47/apsa2b-linker-handler/main/APSA2BLinker.png)

 - A fairly basic userscript that should work with all userscript browser extensions

 - lazily uses jquery to read the `archipelago://` from the page and makes a new link using the `apsa2b://` url that contains the same data, in the download field that is usually unused for Sonic Adventure 2 Battle games

 - refreshes for you if the archipelago links are directing to port 0, which happens sometimes when you have fast internet

## Description for APSA2B Handler AHK

![Image of URL Handler](https://raw.githubusercontent.com/cheatfreak47/apsa2b-linker-handler/main/APSA2BHandler.png)

 - must be compiled with ahk2exe from [AutoHotKey 1.1](https://www.autohotkey.com/download/ahk-install.exe) to be used because you cannot associate an ahk script with a url, only an executable file.

 - if you use ahk2exe manually to compile, you can customize the icon like the release version to use the `icon.ico` from `C:\ProgramData\Archipelago\Data\`. My build script also does this.

 - has an install/uninstall button for the URL handler when ran on it's own for easy install/uninstall

 - has some very basic error handling

 - updates the SA2B_Archipelago config.ini file with the needed data passed by the clicked url

 - launches the text client for you

 - ~~checks if the mod is enabled and opens the mod manager for you if it isn't~~ See [Issue 2](https://github.com/cheatfreak47/apsa2b-linker-handler/issues/2)

 - launches the game for you ~~if the mod is already enabled~~ See [Issue 2](https://github.com/cheatfreak47/apsa2b-linker-handler/issues/2)