Skip to content

A Kotlin Multiplatform Project utilizing ggwave, a data-over-sound library.

License

Notifications You must be signed in to change notification settings

wooram-yang/ggwave-kmp

Repository files navigation

ggwave-kmp

Supported Platforms Supported Platforms Supported Platforms License: MIT

screen_video_2024-11-16-21 52 58_720p

Overview

ggwave-kmp is a Kotlin Multiplatform Project (KMP) designed to send and receive messages across Android, iOS, and desktop platforms like Windows and macOS through sound waves. This project is written in Kotlin and uses Compose Multiplatform, while the core library, ggwave, is written in C/C++. The fundamental technology is based on an FSK-based transmission protocol. For more details, you can read the specification here.

It consists of a common UI codebase using Compose Multiplatform and three platform-specific components for capturing and playing audio data.

How to use

  1. Press the receive button to get messages through the microphone



  2. On another device, type a message and press the send button



  3. Done



Prerequisites

On Windows

  • MinGW-w64 (gcc, g++)
  • cmake version above 3.20.0
    • ninja

On macOS

  • Xcode Command Line Tools (clang, clang++)
  • cmake version above 3.20.0
    • ninja

Building

Ensure that you have the necessary configurations to run an Android or iOS app. This was tested in Android Studio Ladybug 2024.2.1 Patch 2.

JVM (Windows, macOS)

./gradlew :composeApp:run

Screenshot



trimmed.mov

License

MIT License

Copyright (c) 2024 Wooram Yang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

A Kotlin Multiplatform Project utilizing ggwave, a data-over-sound library.

Resources

License

Stars

Watchers

Forks

Packages

No packages published