SBG Archipelago
Archipelago multiworld randomizer for Super Battle Golf: locked angles, power, holes, dive and jump, hints, traps and buffs.SBG Archipelago
Super Battle Golf, randomized. This mod plugs Super Battle Golf into Archipelago, the multiworld randomizer. Your swing is taken apart and scattered across the multiworld: you start with a couple of aim angles, a low power cap and a handful of holes, and find the rest as items, from your own game or other people's.
Beta (0.9.0). The core is tested against a real Archipelago server, but playing together in one lobby and several of the traps and buffs have not yet been tried by more than one person. Please report problems.
What changes
- Aim angles are locked. You start with putts (0°) and 60°; the others (and Free Aim) are items.
- Power is capped, and each Progressive Power Cap item raises it.
- Holes (or whole courses) are locked. Locked holes are greyed out in the match setup menu and a match cannot start with one.
- Diving and jumping can be locked until you find them.
- Item boxes only give items you have unlocked, in the game's usual proportions. The pause menu shows the real odds.
- Checks are finishing each hole, a bonus for each score tier (par to condor), and the game's own speedrun and chip-in bonuses, on every hole.
- Win conditions are your choice, and you can combine them: every hole, a number of holes, strokes under par over your best holes, or every check on a number of holes.
- Traps and buffs (optional): ice, penalty strokes, ball reset, butterfingers, mines, high wind, flashbang, walking only, pickpocket, angle lock, inverse controls, inverted mouse and a flipped power meter; and mulligan, speed boost, magnet shield, power surge and giant burger.
- DeathLink (optional).
- Hints from the game's chat:
!hint power,!hint angle 45,!hint free aim,!hint dive,!hint hole cove,!hint box airhorn. Messages starting with!go to Archipelago instead of the lobby, so!missing,!checkedand!statuswork too.
Installing
You need BepInEx 5 for Super Battle Golf. Install the mod in either way:
- Mod manager (easiest): install SBG_Archipelago from Thunderstore with Gale or the Thunderstore Mod Manager.
- By hand: download
SBG-Archipelago-mod-<version>-manual.zipfrom the GitHub releases and unzip it into the game folder, so thatSBG-Archipelago.dllandArchipelago.MultiClient.Net.dllend up inBepInEx/plugins/SBG-Archipelago/.
Whoever generates the multiworld also needs the game's world file, sbg.apworld (from the same releases page):
double-click it in the Archipelago Launcher, or drop it into the Launcher's custom_worlds folder.
Making your YAML
- In the Archipelago Launcher, open Options Creator, choose Super Battle Golf, pick your options (there are presets) and save. Or use Generate Template Options and edit the file.
- Or start from the files in
templates/: the full template with every option explained, or a short quick-start file.
Then send your YAML to whoever is generating the multiworld.
Generating and hosting
The host collects everyone's YAML, installs sbg.apworld, and generates with the Archipelago Launcher. The result can be hosted
from a PC with the Archipelago server or uploaded to the Archipelago website's Host Game page (the website cannot
generate games it does not know, so generate on a PC first). Hints cost points set by the host's Archipelago settings.
Connecting
Start Super Battle Golf, host a lobby, open the console and run:
apConnect <address:port> <slot name> [password]
Use the address and port your host gives you. apStatus shows the connection. Your unlocks are restored from the server each
time you connect, and the mod remembers your progress between sessions. You can also set the server, slot and password in
BepInEx/config/com.sbg.archipelago.cfg.
Playing together
- Co-op: everyone in the same lobby has this mod and connects to the same slot. Unlocks, angles, power and items are shared, and any player's speedrun, chip-in or score counts for everyone. Traps and buffs affect everyone.
- Versus: players in separate lobbies use separate slots (separate players in the multiworld).
Everyone in a lobby needs the mod. What the host's mod enforces for the whole lobby, even for a player without it: the power cap, wind, par time, item box odds, which holes can be played, scoring and checks. What needs the mod on each player's own game: aim angle limits, diving and jumping, the control traps and buffs, DeathLink and the on-screen messages.
Commands
In the game console: apConnect, apDisconnect, apStatus, apHint <item>, apEnforce on|off (turns the restrictions
off for this session), apEffect <name> (tries a trap or buff on yourself), apPower, apTest and apTestResult
(play-testing hole requirements). In the game's chat: !hint … and the other ! commands above.
PopTracker
A PopTracker pack is on the releases page. It shows your win conditions at the top, your unlocks (angles, power, Dive,
Jump, item box items) and every hole with its checks, and fills in as you play. Put it in PopTracker's packs folder and
connect with the same address and slot.
Reporting a problem
Open an issue on GitHub or message Kaosys on Discord, with your
BepInEx/LogOutput.log (lines tagged [SBG-AP]; copy it before relaunching the game). The log can also contain player names
and Steam IDs from the game itself.
Building from source
The mod (dotnet build -c Release, with SUPER_BATTLE_GOLF_PATH pointing at the game folder), the world (apworld/), the
tracker pack (poptracker-pack/) and the tests (tests/) are all in this repository. scripts/Build-Release.ps1 builds,
tests and packages a release. The _dev/ folder holds a local test server and a client harness for contributors; players
never need it.
Credits and licences
- Licensed under the MIT licence.
- Uses Archipelago.MultiClient.Net (MIT), shipped alongside
the mod; see
THIRD-PARTY-NOTICES.md. - The icon is the Archipelago logo. Super Battle Golf and its art belong to its developers, who allowed the game's icons to be used in the PopTracker pack.
- Thanks to the Archipelago community and its documentation.
