UNI2xSAMMI

This mod (intends to) export UNI2's game state to any app you wish that is capable of reading WebSockets data. In particular: SAMMI, the streaming assistant, is targeted. Very WIP at the moment! Expect bugs, inconsistencies, and lack of data. Please get in contact (below), if you have questions/concerns! Questions?: Hopefully the're answered here!

Installation

1. Navigate to your UNI2 install directory. You can right click on the game in Steam and then click "browse local files" under "manage" to get to the right folder.
2. Put all three .dll files in the release zip into that folder, next to UNI2.exe
3. Launch the game. If a console window appears with some text as the game launches, then it's working.
4. Connect with your client of choice (port: 12524). This is implementation specific. SAMMI instructions to come soon (tm).

Disclaimer

To preempt any misuse, an output delay of 300ms is prepended to every outgoing event.

This can be easily accommodated for in OBS if you're interested in synchronizing effects to gameplay. For video, use Render Delay filters. For audio, apply Delay to the appropriate sources in Advanced Audio Properties.

This mod is read-only, so it cannot be used to alter gameplay.

API overview

The mod sends out N types of events based on the state of the game. They are detailed below. Each event consists of a JSON object with multiple fields. Tabbing implies a '.'

State Update:

• Abstract: the general state of the game, occurs every frame.
• Fields:
  • data
    • event: "uni2_StateUpdate"
    • eventInfo
      • p1/2
        • CharacterID
        • health
        • exsMeter
        • state
        • stateBackup (in case the backing string for state isn't found)
        • posX
        • posY
        • inputs
          • up, down, forwards, back (stick/movement values)
          • A, B, C, D (buttons, macros just turn on multiple of these)
        • vorpal
        • veilOff
        • CVeilOff
        • GRDBlocks
      • frameCount

Hit Event:

• Abstract: fires every time any character gets hit
• Notes: During on-hit combos only, two messages with slightly different data in them are sent per logical hit. Usually, the first of those is sufficient. Also fires if the defender doesn't tech.
• Fields:
  • data
    • event: "uni2_HitEvent"
    • eventInfo
      • p1/2 (same sub-fields as State Update)
      • attacker
      • defender
      • comboCount
      • lastHitDamage
      • comboDamage
      • meterGainedInCombo
      • comboProration
      • frameCount

Combo Start Event:

• Abstract: fires at the start of a combo or blockstring.
• Notes: Occurs after the first HitEvent in some scenarios due to a timing error. Not necessarily to be relied upon. HitEvents after this are guaranteed to have valid data, though ones before it may as well.
• Fields:
  • data
    • event: "uni2_ComboStartEvent"
    • eventInfo: empty

Combo End Event:

• Abstract: fires at the end of a combo or blockstring.
• Notes: Not necessarily to be relied upon. HitEvents after this are not guaranteed to have valid data, though it is possible.
• Fields:
  • data
    • event: "uni2_ComboEndEvent"
    • eventInfo: empty

Vorpal Event:

• Abstract: fires whenever either character achives Vorpal state (i.e. the TS timer finishes).
• Fields:
  • data
    • event: "uni2_VorpalEvent"
    • eventInfo
      • p1/2 (same sub-fields as State Update)
      • whoWonGRD
      • timesWon
      • frameCount

Round Start:

• Abstract: fires whenever a round begins (also training mode reset)
• Fields:
  • data
    • event: "uni2_RoundStartEvent"
    • eventInfo: empty

Round End:

• Abstract: fires whenever a round ends
• Fields:
  • data
    • event: "uni2_RoundEndEvent"
    • eventInfo:
      • p1/2 (same sub-fields as State Update)
      • winner
      • loser
      • reason
      • frameCount