Sailwind LAN Co-op Mod

English | Русский

English

📖 Description

Sailwind LAN Co-op is a mod that adds multiplayer functionality to the game Sailwind. It allows you to play with friends over LAN (Local Area Network) or through VPN/tunneling services.

Current Version: 0.4.3 Wire Protocol: 89. Use the same build on every machine. Most new features still await end-to-end in-game validation; see the release notes. Requirements: BepInEx 5.x, Sailwind 0.39

✨ Features

• LAN Multiplayer: Play with friends on the same network
• Cross-Internet Play: Use with VPN services (Hamachi, ZeroTier, etc.)
• Configurable Settings: Adjust network parameters, player name, and more
• In-game Co-op Menu: Press F8 to host, join, disconnect, choose avatar, show diagnostics, and open debug tools
• Default Avatar Included: The release includes avatar.bundle for remote player models
• Avatar Customization: Replace avatar.bundle with your own compatible bundle if desired
• Up to 5 Players: One host with up to 4 clients simultaneously
• Shared Sea: Waves, weather and time of day run on the host's clock, so every player sees the same water under the same hull
• Quiet by Default: Routine diagnostics are off; serious errors still use a limited log budget
• Crew Status and Host Controls: See who is loading or ready, their ping and boat; hosts can lock the session or remove a guest
• Gesture Wheel: Hold G to wave, point, salute or shout "Land ho!" to your crew
• Hands on the Ship: Other players' avatars reach for the item they carry and the winch, wheel or rope they hold

📥 Installation

Prerequisites

1. Sailwind 0.39 installed via Steam
2. BepInEx 5.x installed for Sailwind
   • If not installed, download from: https://github.com/BepInEx/BepInEx/releases
   • Extract to your Sailwind game folder

Mod Installation

1. Download the latest release archive
2. Extract every file of the archive to: Sailwind/BepInEx/plugins/SailwindCoop/
3. Launch the game
4. To change your avatar, press F8, open Settings and click Avatar

🎮 How to Play

For gameplay details such as economy, missions, cargo, items, damage, mooring, anchor, sleep, and guest progress, read MULTIPLAYER_GUIDE.md.

Hosting a Game (You will be the server)

1. Launch Sailwind
2. Load or start a save game
3. Press F8 to open the Sailwind Co-op menu
4. Click Host
5. Share your IP address with friends (see "Finding Your IP" below), or switch the menu to Steam before pressing Host so Steam friends can join without an IP address (see MULTIPLAYER_GUIDE.md)
6. Wait for friends to connect

Joining a Game

1. Launch Sailwind
2. Important: Do NOT load a save game (stay at main menu)
3. Press F8 to open the Sailwind Co-op menu
4. Enter the host IP and click Join
   • Default IP is 127.0.0.1 (localhost)
   • The menu writes the value to BepInEx/config/com.sailwind.coop.cfg
5. The host's world is sent to you automatically and loaded into the co-op save slot — wait for it to finish

Disconnecting

• Press F8 and click Disconnect
• After a connection has succeeded once, Reconnect repeats the join from the main menu. It is intentionally unavailable inside an already loaded world.

Crew And Host Controls

• The Crew section shows each player's loading state, ping, and current boat.
• The host can use Lock session / Open session without disconnecting existing players.
• The host can remove a guest with the two-step Kick / Sure? action.
• Teleport to boat puts you back on the deck if you fell overboard or the boat left without you.

Gestures

• Hold G during a session to open the gesture wheel, move the mouse to a gesture and release. Release in the middle, or press Esc, to cancel.
• Gestures: Wave, Land ho!, Point, Come here, Applause, Shrug, Salute, Hooray.
• "Land ho!" and "Point" aim where you are looking. "Land ho!" also shouts, and other players hear it from where you stand.
• Walking ends a gesture. You do not see your own gesture, because the game is first person.
• The first time the wheel becomes available, a short hint appears on screen. The key is also shown in the F8 menu and can be changed with EmoteKey in the config.

Overlay/Debug Info

The buttons below sit under Settings in the F8 menu, which is collapsed until you click it.

• Press F8, open Settings and use Show Status / Hide Status
• Logging switches the log file on and off without restarting the game. It is off by default; turn it on before reproducing a problem, otherwise the log will hold nothing useful
• Dump water state writes debug/water-*.txt. Press it on both machines at the same moment if the sea ever looks different on one of them
• Export report writes debug/coop-report-*.txt with session and recent error diagnostics, including when logging was off
• The Debug button opens the developer panel, and only works if EnableDebugPanel is set in the config

Skin Selection

• Press F8, open Settings and click Avatar to open the skin selection menu
• Skin changes are visible to other players in real-time

Menu Input

• While the co-op menu is open, the mouse cursor is captured by the menu and does not interact with the world.
• Closing the co-op menu closes companion panels such as Avatar and Debug, then returns cursor control to the game.

⚙️ Configuration

Configuration file location: Sailwind/BepInEx/config/com.sailwind.coop.cfg

🔍 Finding Your IP Address

For LAN Play (same network):

• Windows: Open Command Prompt and type ipconfig
• Look for "IPv4 Address" under your network adapter (usually starts with 192.168.x.x)

For Internet Play (with VPN):

• Hamachi: Use the Hamachi IP (5.x.x.x)
• ZeroTier: Use the ZeroTier-assigned IP
• Other VPN: Use the VPN-provided IP address

🛠️ Troubleshooting

Issue: Friends can't connect

• Ensure port 7777 (or your custom port) is open in your firewall
• For internet play: Set up port forwarding on your router
• Try disabling antivirus/firewall temporarily
• Make sure all players are using the same mod version

Issue: Game crashes on startup

• Verify BepInEx is installed correctly
• Check that SailwindCoop.dll is in the right folder
• Look at BepInEx/LogOutput.log for error details

Issue: Avatars appear incorrectly

• Adjust VerticalOffset and HostVerticalOffset in the config file
• Ensure avatar.bundle exists in Sailwind/BepInEx/plugins/SailwindCoop/

Issue: Reporting a bug

• Press F8 → Logging to switch logging on, reproduce the problem, then attach BepInEx/LogOutput.log
• Say which version both machines were running

Issue: High latency/lag

• Reduce SnapshotHz in config (lower = less network traffic)
• Increase InterpDelayMs for smoother interpolation
• Check your network connection quality

📝 Notes

• This mod is in early development (v0.4.3). Expect bugs!
• Only works with players who have the mod installed, and every machine must run the same version — the network protocol changes between releases, so mismatched builds refuse to connect
• The client loads the host's streamed world save into a dedicated co-op slot, while guest character progress is kept in a local co-op profile
• The host's game state is authoritative
• The default avatar bundle ships with the release and must sit next to the plugin DLL
• For best performance, play on a wired network connection

🤝 Contributing

Found a bug? Have a suggestion? Visit: https://github.com/pander33/SailwindCoop

Русский

📖 Описание

Sailwind LAN Co-op — это мод, добавляющий мультиплеер в игру Sailwind. Позволяет играть с друзьями по локальной сети (LAN) или через VPN/туннелирование.

Текущая версия: 0.4.3 Сетевой протокол: 89. На всех компьютерах должна быть одна сборка. Большинство новых функций ещё ожидает проверки в игре; см. описание релиза. Требования: BepInEx 5.x, Sailwind 0.39 (Steam версия)

✨ Особенности

• LAN мультиплеер: Игра с друзьями в одной сети
• Игра через интернет: Работает с VPN сервисами (Hamachi, ZeroTier и др.)
• Настраиваемые параметры: Настройка сети, имени игрока и др.
• Меню кооператива в игре: F8 открывает меню для хоста, подключения, отключения, выбора аватара, диагностики и отладки
• Аватар по умолчанию в комплекте: Релиз содержит avatar.bundle для моделей удаленных игроков
• Кастомизация аватаров: При желании можно заменить avatar.bundle на совместимый свой bundle
• До 5 игроков: Один хост и до 4 клиентов одновременно
• Общее море: Волны, погода и время суток идут по часам хоста — вода под лодкой одинакова у всех
• Тишина по умолчанию: Обычная диагностика выключена; серьёзные ошибки пишутся с ограничением частоты
• Колесо жестов: Удерживайте G, чтобы помахать, указать, отдать честь или крикнуть команде «Land ho!»
• Руки на снастях: Аватары других игроков тянутся к предмету в руке и к лебёдке, штурвалу или верёвке, которую держит игрок

📥 Установка

Необходимые условия

1. Sailwind 0.39 установлен через Steam
2. BepInEx 5.x установлен для Sailwind
   • Если не установлен, скачайте: https://github.com/BepInEx/BepInEx/releases
   • Распакуйте в папку с игрой Sailwind

Установка мода

1. Скачайте последний архив релиза
2. Распакуйте все файлы архива в: Sailwind/BepInEx/plugins/SailwindCoop/
3. Запустите игру
4. Чтобы сменить аватар, нажмите F8, откройте Settings и нажмите Avatar

🎮 Как играть

Подробное английское описание работы экономики, миссий, карго, предметов, повреждений, швартовки, якоря, сна и прогресса гостя: MULTIPLAYER_GUIDE.md.

Создание сервера (Вы будете хостом)

1. Запустите Sailwind
2. Загрузите или начните новую игру
3. Нажмите F8, чтобы открыть меню Sailwind Co-op
4. Нажмите Host
5. Сообщите друзьям свой IP адрес (см. "Как узнать свой IP" ниже)
6. Ждите подключения друзей

Подключение к игре

1. Запустите Sailwind
2. Важно: НЕ загружайте сохранение (останьтесь в главном меню)
3. Нажмите F8, чтобы открыть меню Sailwind Co-op
4. Введите IP хоста и нажмите Join
   • IP по умолчанию: 127.0.0.1 (локальный)
   • Меню сохраняет значение в BepInEx/config/com.sailwind.coop.cfg
5. Мир хоста передаётся автоматически и загружается в co-op слот сохранения — дождитесь окончания

Отключение

• Нажмите F8 и кнопку Disconnect

Жесты

• Во время сессии удерживайте G: откроется колесо жестов. Наведите мышь на жест и отпустите клавишу. Чтобы отменить, отпустите её в центре или нажмите Esc.
• Жесты: Wave, Land ho!, Point, Come here, Applause, Shrug, Salute, Hooray.
• «Land ho!» и «Point» направлены туда, куда вы смотрите. «Land ho!» ещё и звучит: другие игроки слышат выкрик с вашего места.
• Шаг прерывает жест. Свой жест вы не видите, потому что игра от первого лица.
• Когда колесо впервые становится доступным, на экране появляется короткая подсказка. Клавиша также указана в меню F8 и меняется настройкой EmoteKey.

Оверлей с информацией

Кнопки ниже находятся в разделе Settings меню F8; он свёрнут, пока по нему не щёлкнуть.

• Нажмите F8, откройте Settings и используйте Show Status / Hide Status
• Logging включает и выключает лог-файл без перезапуска игры. По умолчанию выключено; включайте до воспроизведения проблемы, иначе в логе не будет ничего полезного
• Dump water state пишет debug/water-*.txt. Нажмите на обеих машинах одновременно, если море где-то выглядит иначе
• Кнопка Debug открывает панель разработчика и работает только при включённом EnableDebugPanel в конфиге

Выбор скина

• Нажмите F8, откройте Settings и нажмите Avatar, чтобы открыть меню выбора скина

Управление курсором

• Пока co-op меню открыто, курсор работает только с меню и не взаимодействует с миром.
• При закрытии co-op меню закрываются сопутствующие панели Avatar/Debug, затем управление курсором возвращается игре.

⚙️ Настройка

Файл конфигурации: Sailwind/BepInEx/config/com.sailwind.coop.cfg

🔍 Как узнать свой IP адрес

Для игры по LAN (в одной сети):

• Windows: Откройте командную строку и введите ipconfig
• Найдите "IPv4 адрес" вашей сетевой карты (обычно начинается с 192.168.x.x)

Для игры через интернет (с VPN):

• Hamachi: Используйте IP Hamachi (5.x.x.x)
• ZeroTier: Используйте назначенный ZeroTier IP
• Другой VPN: Используйте IP, предоставленный VPN

🛠️ Решение проблем

Проблема: Друзья не могут подключиться

• Убедитесь, что порт 7777 (или ваш порт) открыт в брандмауэре
• Для интернета: настройте проброс портов на роутере
• Попробуйте временно отключить антивирус/брандмауэр
• Убедитесь, что все используют одинаковую версию мода

Проблема: Игра вылетает при запуске

• Проверьте, что BepInEx установлен правильно
• Проверьте, что SailwindCoop.dll в нужной папке
• Посмотрите BepInEx/LogOutput.log для деталей ошибки

Проблема: Аватары отображаются неправильно

• Настройте VerticalOffset и HostVerticalOffset в конфиге
• Убедитесь, что avatar.bundle лежит в Sailwind/BepInEx/plugins/SailwindCoop/

Как сообщить о баге

• Нажмите F8 → Logging, чтобы включить логирование, воспроизведите проблему и приложите BepInEx/LogOutput.log
• Укажите версию мода на обеих машинах

Проблема: Высокая задержка/лаги

• Уменьшите SnapshotHz в конфиге (меньше = меньше сетевого трафика)
• Увеличьте InterpDelayMs для более плавной интерполяции
• Проверьте качество вашего сетевого соединения

📝 Примечания

• Мод в ранней разработке (v0.4.3). Возможны баги!
• Работает только с игроками, у которых установлен мод, и у всех должна быть одна и та же версия — сетевой протокол меняется между релизами, разные сборки не соединятся
• Клиент загружает полученный от хоста сейв мира в отдельный co-op слот, а прогресс персонажа гостя хранится в локальном co-op профиле
• Состояние игры хоста является авторитетным
• Аватар по умолчанию входит в релиз и должен лежать рядом с DLL мода
• Для лучшей производительности играйте по проводному соединению

🤝 Участие в разработке

Нашли баг? Есть предложения? Посетите: https://github.com/pander33/SailwindCoop

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

The "Land ho!" shout (sounds/landho.wav) is the sound "LandHo" by SilverDubloons from freesound.org, released under Creative Commons 0.

Этот проект лицензирован под MIT License - подробности в файле LICENSE.