Streaming tool for Touhou 12.3: Hisoutensoku. SokuStreaming provides an easy-to-use API to fetch information from the game and connect to games.

Requires CMake, git and the VisualStudio compiler (MSVC). Both git and cmake needs to be in the PATH environment variable.

All the following commands are to be run inside the visual studio 32bits compiler command prompt (called x86 Native Tools Command Prompt for VS 20XX in the start menu), unless stated otherwise.

First go inside the folder you want the repository to be in. In this example it will be C:\Users\PinkySmile\SokuProjects but remember to replace this with the path for your machine. If you don't want to type the full path, you can drag and drop the folder onto the console.

cd C:\Users\PinkySmile\SokuProjects

Now let's download the repository and initialize it for the first time

git clone https://github.com/SokuDev/SokuStreaming
cd SokuStreaming
git submodule init
git submodule update
mkdir build
cd build
cmake .. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Debug

Note that if you want to build in Release, you should replace -DCMAKE_BUILD_TYPE=Debug with -DCMAKE_BUILD_TYPE=Release.

Now, to build the mod, go to the build directory (if you did the previous step you already are) cd C:\Users\PinkySmile\SokuProjects\SokuStreaming\build and invoke the compiler by running cmake --build . --target SokuStreaming. If you change the name of the mod (in the add_library statement in CMakeLists.txt), you will need to replace 'SokuStreaming' by the name of your mod in the previous command.

You should find the resulting SokuStreaming.dll mod inside the build folder that can be to SWRSToys.ini. In my case, I would add this line to it SokuStreaming=C:/Users/PinkySmile/SokuProjects/SokuStreaming/build/SokuStreaming.dll.

Accepted methods: GET

Note: Always redirects to the default overlay provided in the .ini. By default, returns a 404 if not specified in the ini.

• 404 Not Found
• 405 Method Not Allowed
• 302 Found

Accepted methods: GET, POST

GET -> Returns a State object describing the current state of the game.

POST -> Takes a PartialState object and updates the state accordingly. Nothing is returned.

Note that any POST to this route that doesn't come from 127.0.0.1 will result in a 403.

• 400 Bad Request: The given JSON object was invalid. (POST only)
• 403 Forbidden (POST only)
• 405 Method Not Allowed
• 200 OK

Accepted methods: POST

POST -> Takes a ConnectionRequest object and tries to connect to the specified game. Nothing is returned.

Note that any call to this route that doesn't come from 127.0.0.1 will result in a 403.

• 400 Bad Request: The given JSON object was invalid.
• 403 Forbidden
• 405 Method Not Allowed
• 503 Service Unavailable: The game is not ready to connect (either hosting or already connecting)
• 202 Accepted

Accepted methods: GET

These routes map directly to the static folder in the mod folder. If you want to access the file at modules/SokuStreaming/static/image.png, you can get it from the route /static/image.png. If the requested url ends with a trailing /, then the corresponding folder is searched and the content is returned. The format of the response depends on the Accept header. If it is set to application/json, the value is a json array of string. Otherwise, the html version of the page is returned. Note that only specifically application/json will yield a json result. Anything else won't, even if it specifies json as the preferred result.

• 404 Not Found
• 405 Method Not Allowed
• 200 OK

Accepted methods: GET

Returns the list of characters known to the game. This includes vanilla characters, as well as Soku2 characters if enabled. The result is a json object with, as key the id of the character and its internal name as value.

• 405 Method Not Allowed
• 200 OK

Accepted methods: GET

Returns the internal name of a character by its id.

• 404 Not Found
• 405 Method Not Allowed
• 200 OK

Accepted methods: GET

These routes map directly to the game package assets. The format returned depends on the extension of the file. If the extension matches the one from the game, the file is returned as-is with no conversion performed. For example a request to /internal/data/stand/remilia.png will return the file data/stand/remilia.cv2 converted to png.

• 501 Not Implemented
• 404 Not Found
• 405 Method Not Allowed
• 200 OK

Starts a websocket connection to the game. See the Websocket section for more details.

• 400 Bad Request
• 101 Switching Protocols

The websocket is used to communicate events to the connected client about the game state. All client messages are ignored.

A websocket event looks like this.

{
    "o": 2,
    "d": 1
}

o: Integer -> Opcode

d: <Anything> -> The data associated with the opcode.

Data type -> State object

Indicate a big change in the state. The data is the newly updated state.

Data type -> CardUpdate object

Indicate a big change in the state. The data is the newly updated state.

Data type: Integer

Indicate a change of score for the left player. The data is the newly updated score.

Data type: Integer

Indicate a change of score for the right player. The data is the newly updated score.

Data type: List[Integer]

Indicate a change of deck state for the left player. The data is the newly updated deck.

Data type: List[Integer]

Indicate a change of deck state for the right player. The data is the newly updated deck.

Data type: String

Indicate a change of name for the left player. The data is the newly updated name.

Data type: String

Indicate a change of name for the right player. The data is the newly updated name.

Data type: Stats object

Indicate a change of statistics for the left player. The data is the newly updated stats.

Data type: Stats object

Indicate a change of statistics for the right player. The data is the newly updated stats.

Data type: None

The current game just ended.

Data type: None

The current game just started.

Data type: None

A new game session just started.

Data type: None

A new game session just ended.

{
    "ip": "27.189.90.102",
    "port": 10800,
    "spec": true
}

ip: String -> The IP address to connect to.

port: Integer -> The port on which to connect.

spec: Boolean -> If this is false, the game will try to connect as a player, otherwise, it will connect as a spectator.

{
    "left": {
        "name": "PinkySmile",
        "score": 0
    },
    "right": {
        "name": "SokuAI",
        "score": 9
    },
    "round": "Grand Final"
}

left.name: String -> New name of the left player (P1)

left.score: String -> New score of the left player (P1)

right.name: String -> New name of the right player (P2)

right.score: String -> New score of the right player (P2)

round: String -> New round string

{
    "isPlaying": true,
    "left": {
        "character": 11,
        "deck": [
            0,
            12,
            13,
            100,
            100
        ],
        "hand": [
            110,
            200,
            200,
            211,
            211
        ],
        "name": "Langschlafer",
        "palette": 7,
        "score": 1,
        "stats": {
            "doll": 0,
            "drops": 0,
            "fan": 0,
            "grimoire": 0,
            "rod": 0,
            "skills": {
                "0": 2,
                "1": 0,
                "2": 0,
                "3": 0
            },
            "special": 0
        },
        "used": [
            100,
            100,
            200,
            202,
            202,
            202,
            205,
            205,
            205,
            211
        ]
    },
    "right": {
        "character": 18,
        "deck": [
            4,
            105,
            105,
            108,
            108,
            108,
            213
        ],
        "hand": [
            4,
            15,
            105,
            108,
            211
        ],
        "name": "ViLi",
        "palette": 3,
        "score": 0,
        "stats": {
            "doll": 0,
            "drops": 0,
            "fan": 0,
            "grimoire": 0,
            "rod": 0,
            "skills": {
                "0": 0,
                "2": 0,
                "3": 0,
                "5": 1
            },
            "special": 0
        },
        "used": [
            4,
            4,
            105,
            201,
            203,
            203,
            212,
            213
        ]
    },
    "round": ""
}

isPlaying: Boolean -> Whether the game is in progress or not.

left: CharacterState -> Left player (P1) state

right: CharacterState -> Right player (P2) state

round: String -> The round string set either in game or doing a POST at /state

If "isPlaying" is false, the left and right character states are not guaranteed to be valid.

{
    "character": 18,
    "deck": [
        4,
        105,
        105,
        108,
        108,
        108,
        213
    ],
    "hand": [
        4,
        15,
        105,
        108,
        211
    ],
    "name": "Seiki",
    "palette": 3,
    "score": 0,
    "stats": {
        "doll": 0,
        "drops": 0,
        "fan": 0,
        "grimoire": 0,
        "rod": 0,
        "skills": {
            "0": 0,
            "2": 0,
            "3": 0,
            "5": 1
        },
        "special": 0
    },
    "used": [
        4,
        4,
        105,
        201,
        203,
        203,
        212,
        213
    ]
}

character: Integer -> Character ID. A list can be found here.

deck: List[Integer] -> List of card ID that are left in the deck.

hand: List[Integer] -> List of card ID that are in the player's hand.

name: String -> Name of the profile. If it didn't get changed using /state or the in game keys, this is the profile name.

palette: Integer -> The palette the player chose from 0 to 7 (0 is the default).

score: Integer -> The current score of the player in the set. Increased when a game is won.

stats: Stats -> Statistics modifiers and skills.

used: List[Integer] -> List of card ID that were used by the player.

Note that when Mountain Vapor activates, the hand will always be empty and all the deck will be replaced with the "21" card ID indicating they are hidden (21 is not a valid card id). When the weather returns to normal, all cards can be seen again.

{
    "doll": 0,
    "drops": 0,
    "fan": 0,
    "grimoire": 0,
    "rod": 0,
    "skills": {
        "0": 0,
        "2": 0,
        "3": 0,
        "5": 1
    },
    "special": 0
}

stats.doll: Integer -> The number of Sacrificial Doll system card used.

stats.drops: Integer -> The number of Heavenly Drop system card used.

stats.fan: Integer -> The number of Tengu Fan system card used.

stats.grimoire: Integer -> The number of Grimoire system card used.

stats.rod: Integer -> The number of Control Rod system card used.

stats.skills: Skills object -> The current skills the player have and their level.

stats.special: Integer -> Indicate the number of other stackablez character specific card. The supported card are Reisen's Elixir and Yuyuko's Resurrection Butterflies.

{
    "0": 0,
    "2": 0,
    "3": 0,
    "5": 1
}

A pair of key/value indicating which skill the player has and at which level it is. There must always be 4 pairs except for Patchouli (and Kaguya when using Soku2) which have 5. The key value is the skill ID and the value is its level. Value from 0-3 (0-4 for Patchy) are default skills, 4-7 (5-9 for Patchy) are first set of alt skills and 8-11 (10-14 for Patchy) are the last set of alt skills. The skill input is always in the same order in between alts and default but changes depending on the character. You can find the skill order by looking at the skill card IDs: subtract 100 from the card id and you will get the corresponding skill ID.