Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
Sail is a networking protocol designed to facilitate remote control of the Ship
of Harkinian client. It is intended to be utilized alongside a Sail server, for
which we provide a few straightforward implementations here in this repo. The
current implementations available allow integration with Twitch chat and SAMMI
Bot, feel free to contribute your own!
current implementations available allow integration with Twitch chat and SAMMI, feel free to contribute your own!

## How to

Expand Down Expand Up @@ -38,7 +37,15 @@ programming to configure to your liking. Your limit is your imagination here.

### SAMMI Sail

The SAMMI sail is meant to be used with the SAMMI bot, it simply redirects
traffic between your SAMMI bot and SoH. You can configure the sail with env
The SAMMI sail is meant to be used with SAMMI, it simply redirects
traffic between SAMMI and SoH. You can configure the sail with env
variables to point to your SAMMI's webhook endpoint with SAMMI_WEBHOOK_URL and
have SAMMI point to the Sail's endpoint at http://localhost:43383

An example SAMMI deck is available to use in examples!
SAMMI 2025.1.0 and above:
- Drag and drop the SAMMI_SAIL_DECK.json on the main window and click yes.

SAMMI Versions below 2025.1.0:
- Copy the deck data in SAMMI_SAIL_DECK.json
- Click the new deck button in the main window and paste the deck.
1 change: 1 addition & 0 deletions examples/SAMMI_SAIL_DECK.json

Large diffs are not rendered by default.