README.md

Isaac Twitch Mod Reloaded

Rewrited and improved version of old TBoI mod, Isaac On Twitch. There are new features in this mod:

• Internal web server instead file input/output system for external data exchange
• New callbacks system. Increase performance and code quality
• File-splitting. No more 4K lines in main.lua
• External Item Description support
• Fixed game saves

Running

As before, run Isaac with --luadebug launch parameter

Command line

For debug, you can use next commands in Isaac command line (~):

itmr showcallbacks - show all active callbacks for items, trinkets and events

itmr storage - show current mod storage in JSON format

itmr allpassive - spawn all passive items from Twitch mod in current room

itmr allactive - spawn all active items from Twitch mod in current room

itmr toggleshader [shadername] - enable/disable shader from mod

itmr setshader [shadername] [paramname] [paramvalue] - set parameter for shader from mod

itmr debugtextfollow [text] - add text for every entity in room

itmr launchevent [eventname] - launch event by name

File structure

• content - Contains xml-files for Isaac mod API

• resources - Contains media-sources and files for replacing

• scripts - Contains .lua files for Twitch mod

  • ativeItems.lua - List of all active items from mod
  • callbacks.lua - Main callbacks for mod, like saving game
  • classes.lua - Mod classes, like active events or subscribers
  • cmd.lua - Commands for Isaac command line
  • enums.lua - Lists of different objects, like colors or enemies
  • events.lua - Events list
  • passiveItems.lua - List of all passive items from mod
  • helper.lua - Additional functions for comfort developing
  • server.lua - Twitch mod server for receiveng/sending data
  • sprites.lua - Contains UI and etc sprites from mod
  • shaders.lua - Contains shaders params
  • trinkets.lua - List of all trinkets from mod

• main.lua - Main mod script, contains root mod object

• metadata.xml - Mod config