BBCF-Sammi

This mod exports Blazblue: Central Fiction'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 BBCF 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 BBCF.exe
   • At the moment, this mod is not compatible with any version of the BBCF Improvement Mod. Your game will crash if used together!
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: 42617). This is implementation specific. SAMMI instructions to come soon (tm).

Disclaimer

This software does not enable cheating. It only exposes a read-only version of the game's state for other software. If you make a cheat with this code you suck as a human being, and I'm not liable for your crappy life or its resultant choices.

API overview

The mod sends out 6 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 and characters. Occurs every frame.
• Fields:
  • data
    • event: will always be "bbcf_stateUpdate"
    • eventInfo
      • p1/2
        • health
        • posx
        • posy
        • character
        • prevAction
        • currAction
        • heat
        • Overdrive
        • barrierGauge
        • drive
        • maxDrive
        • side
        • ODTimeRemaining
        • moveType
        • activeFlow
      • inGameTimer (in seconds)
      • frameCount

Hit Event:

• Abstract: fires every time any character gets hit.
• Fields:
  • data
    • event: "bbcf_hitEvent"
    • eventInfo
      • attacker
      • attackerAction
      • attackerActiveFlow
      • defender
      • defenderAction
      • defenderPrevAction
      • defenderActiveFlow
      • attackLevel
      • attackFlag
      • untechTime
      • hitstopOverride
      • airPushbackX
      • airPushbackY
      • damage
      • scalingTicks
      • comboCount
      • frameCount

Guard Event:

• Abstract: fires every time any character blocks.
• Fields:
  • data
    • event: "bbcf_guardEvent"
    • eventInfo
      • attacker
      • attackerAction
      • attackerActiveFlow
      • defender
      • defenderAction
      • defenderActiveFlow
      • attackLevel
      • moveType
      • frameCount

Round Transition:

• Abstract: fires approximately when there's a change in either of the three states. Check SAMMITypes.hpp for full enumeration.
• Fields:
  • data
    • event: "bbcf_roundTransitionEvent"
    • eventInfo
      • currGameMode
      • prevGameMode
      • currGameState
      • prevGameState
      • currMatchState
      • prevMatchState
      • frameCount

Object Creation:

• Abstract: Fires whenever a new game object (particle effect, projectile, etc) is created. There will be a lot of these, ignore them if you don't have a use.
• Fields:
  • data
    • event: "bbcf_objectCreatedEvent"
    • eventInfo
      • currAction
      • sprite
      • frameCount

Timeout

• Abstract: Fires whenever the game goes to the main menu or lobby for any reason. Usable to detect sudden quits or similar.
• Fields:
  • data
    • event: "bbcf_Timeout"
    • No other fields

Contact:

Please only contact me if you have issues or major feature requests. Do not ask me how to set up stuff in SAMMI, other documentation covers that. To reach me:

• quattrodan3 on Discord
• nleff72 on Twitter/BlueSky
• email: dan (at) lakeviewcomputerspecialists (dot) com