Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Rchardon/RebirthItemTracker


https://github.com/Rchardon/RebirthItemTracker

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README 

        
# RebirthItemTracker



This tracker is following Hyphen-ated's work as he doesn't have time anymore to work on it.



/!\ This program isn't compatible with Windows 7 anymore /!\



This uses the `log.txt` file to track item pickups in The Binding of Isaac: Rebirth, Afterbirth, Afterbirth+, Repentance and Antibirth.



The game's built-in item tracker only shows 10 items (on AB+ and downwards) and the pause screen items are hard to read, so this program offers

a more powerful alternative. This is particularly useful for streamers, so their viewers can see their items, but can

be used by anyone.



Additionally, the tracker...



- tells you what an item does when you pick it up.

- marks items that were picked up during a _Curse of the Blind_.

- marks items that were rerolled using _D4_/_D100_/etc.

- shows what floor items were picked up on.

- shows the floor the player is currently on.

- displays the current seed.

- write current run data (seed, transformations, stats, version...) into text files in _overlay text/_ directory.

- allows tournament hosts to receive players' item data through a server, so they can fit nicely in a restream layout.



![](https://i.imgur.com/6kXiYpj.png)



Download it [here](https://github.com/rchardon/RebirthItemTracker/releases) or [here](https://github.com/Hyphen-ated/RebirthItemTracker/releases) for version 2.1.0

(get the latest file that doesn't have "source code" in the name).



To use it, first extract that zip file and then run the exe inside. Don't put it inside the same folder as any file

\named log.txt.



You can right click anywhere in the window to get an options screen.



You can mouse over items you've picked up to see their stats again, and click on them to open

[platinumgod.co.uk](http://platinumgod.co.uk/) in your browser for more information about that item.



It tries to read `log.txt` from inside the appropriate game folder, based on which game you select in the tracker options.

If something is unexpectedly weird about your game folder and it can't find it, you can put the tracker folder into the

folder with your log.txt and it will force it to use the specific one it finds there. (If you do this, you can't change

between different isaac games by using the tracker option, and you'd have to have multiple tracker installs to use for

Antibirth vs Afterbirth+, for example. Normally this should not have to happen.)



The tracker can remember your runs if you save&quit but it works differently for each dlc:



- For Rebirth, Antibirth and Afterbirth : It remembers the last paused run you did and you have to reload run informations

  by pressing CTRL + N when you reload your run.

- For Afterbirth+ : It remembers the paused runs on the 3 saves and you have to press CTRL + N to reload run informations.

- For Repentance : It remembers the paused runs on the 3 saves and it reloads automatically run informations when you continue

  your run.



The tracker checks for updates each time you launch it, and will update itself if you allow it. This only works on Windows.

You can toggle this in the options window.



The tracker can be used on Linux, but you have to run it from source, and it can't auto-update.

Read "HOW TO BUILD.txt" for instructions.

If playing Repentance through Proton, the folder with 'log.txt' is inside the wine prefix that is created by Steam.

Its path is usually

` ~/.steam/steam/steamapps/compatdata/250900/pfx/drive_c/users/steamuser/Documents/My Games/Binding of Isaac Repentance/`.

The tracker folder has to be put there as mentioned above.



The tracker doesn't work properly on a Mac: it will crash when you open the options menu. If you're okay with manually

editing your options.json file instead of using the gui to change your options, you might be able to run it on a Mac in

the same way it can be run on Linux (see above).



## Status Message Customization



The tracker displays a line of text at the top of its window. This text can be adjusted in the options to contain various

different pieces of information.



By default, it shows:

"Seed: {seed} / Guppy: {guppy} / Leviathan: {leviathan} / Spun: {spun} / Bookworm: {bookworm} / {version_number} / Room: {room_id} {racing_plus_version} {babies_mod_version} {IAR_version}"



Where there's a word inside curly braces, it substitutes the value of that variable.

Variables that you can use here include:



- General game info: {seed}, {version_number}, {room_id}

  {racing_plus_version} will show nothing if you don't play on R+ and if you are, it will show "/ R+: 0.XX.XX" so no need to put a slash

  before that variable, same for {babies_mod_version} and {IAR_version} (IAR stands for Isaac Achievement Randomizer)



- Transformations: {guppy}, {bob}, {conjoined}, {funguy}, {leviathan}, {ohcrap}, {seraphim}, {spun}, {yesmother}, {superbum}, {beelzebub}, {bookworm}, {spiderbaby}



- Stats: {dmg}, {delay}, {speed}, {shot_speed}, {range}, {height}, {tears}



The stats are kind of obsolete now that Found HUD is built into the game. They also don't track changes from things like

pills or Experimental Treatment, because those don't say what they do in the game's log file.



## Tournament/Restreaming Use



First, each competitor needs to go to the options screen, click "Let Others Watch Me", click "Get an authkey", authorize

the application on twitch in the browser window that pops up, and then paste the authkey they receive into the tracker.

After getting an authkey once, this step doesn't need to happen again. Don't show the authkey on stream.



If you're in "Let Others Watch Me" mode, indicated by the text "uploading to server" in the title bar, then the host can

see your items with the "Watch Someone Else" button.



The host needs to run a separate copy of the tracker for each competitor. To compensate for twitch delay, there's a

"read delay" setting which makes the tracker wait that many seconds before displaying updates from the player.

Ctrl-up and ctrl-down are shortcuts to change the delay, which is also shown in the title bar.



## Known issues



- When using the _Glowing Hour Glass_ right after taking any object, this object will remains in the tracker even if the

  character doesn't have it anymore.



- If you want to make a shortcut to the tracker, and you want automatic updates to work, make the shortcut to the file

  "Rebirth Item Tracker.exe" and not "item_tracker.exe".



- When playing Antibirth, it doesn't display detailed item information, nor can it keep track of what floor you're on.



- Transparent mode only works on Windows.



- You can't see rerolled items with D4 in Repentance.



- Tracker doesn't work with co-op mode.



- Duplicated active items that should count in transformations will not be counted properly in Repentance.