Skip to content

coavins/EmoTrackerPacks

 
 

Repository files navigation

Hamsda's OOT pack + Autotracking

Base version Autotracker version Test Status

About this fork

This fork adds autotracking functionality to Hamsda's EmoTracker pack for OOT Randomizer. Please refer to the upstream repository or pack README if you have any questions regarding the usage or behavior of the standard tracker features.

There is an active pull request to officially merge this work into Hamsda's pack. Please show support by giving it a 👍 if you want to see this happen!

This repo accepts pull requests! Please see CONTRIBUTING.md for more information.

Huge thanks to RiptideSage for making this project possible.

Contact

If you encounter a problem with the autotracker, please create an issue in this repository.

If you're having trouble with basic use of the tracker in general, you might want to check out Hamsda's repository.

Setup

Requirements

  • EmoTracker (tested with 2.3.8.17) or PopTracker (early beta - very limited functionality)
  • BizHawk (tested with 2.3 through 2.8)
  • For BizHawk 2.8 and below: bizhawk-connector
  • For BizHawk 2.9: You can use the connector lua from this site

Install the pack

To manually install or update this pack, download the latest release and put the zip file into your EmoTracker packs directory:

%userprofile%\Documents\EmoTracker\packs

You don't have to extract the zip. When EmoTracker is reloaded, this pack should appear under "Installed Packages" with (Autotracker) in the name.

Connect to Bizhawk

Enable the autotracker

Note: You should configure your tracker settings before you connect to the emulator.

EmoTracker

To activate the autotracker, right-click the robot icon in the lower right corner of EmoTracker and choose "SNES", then "Lua". When the robot turns red or yellow, it is ready.

PopTracker

To activate the autotracker, left-click the word "Lua" in the top left corner of PopTracker. When the text turns yellow, it is waiting for a connection from BizHawk. When the text turns green, it means BizHawk successfully connected and autotracking will begin.

Load the connector script in BizHawk

In BizHawk, after your ROM is loaded, go to Tools > Lua Console. In the new window, go to Script > Open Script and navigate to the connector.lua file in your Bizhawk lua folder.

Note: When playing with Archipelago or multiworld, you should load the Archipelago/multiworld lua first.

When the connector.lua script is started, the connection should be established and you should see the robot icon in EmoTracker turn green. After a short delay, autotracking will begin. Items and checks will be marked as soon as you receive them in-game.

Usage

When starting a new game, you should make sure that your tracker settings are configured correctly before you connect to the emulator, as the autotracker will immediately start making changes based on your active settings. The autotracker can also be used with a file you already started playing; it will catch up and mark off all items and cleared checks.

Things that are autotracked:

Checks

  • Inventory items
  • Quest items
  • Locations checked
  • Dungeon bosses defeated
  • Trade sequence progress
  • Keys found (for keysanity variants)
  • Beans planted
  • Which prize is awarded by each dungeon

Settings

  • Free scarecrow's song

Things that are NOT yet tracked:

  • Master Quest dungeon checks
  • Frog Song rupees
  • Granny's blue potion
  • Whether the scarecrow's song is available
  • Captures for spawn and entrance randomizer
  • At which song location each song was received

Racing

The autotracker will only function when racing mode is disabled.

Casual When this setting is displayed, the autotracker will operate normally.

Please be mindful of the rules when joining races. Using an autotracker in a race where they are not permitted would be cheating. Always remember to check the rules to confirm that your tracker is allowed before using it in any race, even if you don't intend to use autotracking.

This pack can only mark off items after they are received, and checks after they have been checked. It cannot be used to reveal information that is not already known to the player, including where items are hidden or what random settings have been applied.

Special thanks

Thanks to RiptideSage who saved me weeks of hunting down scene flags. This project was only possible because I could follow in your footsteps.

Thanks to codemann8, whose LTTP pack showed me how to write scripts for EmoTracker.

I also referenced the following OOT resources during development.