https://github.com/insidegui/multipeerkit

MultipeerConnectivity + Codable = ❤️
https://github.com/insidegui/multipeerkit

ios macos peer-to-peer swift-library tvos

Last synced: 1 day ago
JSON representation

MultipeerConnectivity + Codable = ❤️

• Host: GitHub
• URL: https://github.com/insidegui/multipeerkit
• Owner: insidegui
• License: bsd-2-clause
• Created: 2020-02-28T15:57:34.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T17:31:54.000Z (8 months ago)
• Last Synced: 2024-12-21T19:05:39.329Z (1 day ago)
• Topics: ios, macos, peer-to-peer, swift-library, tvos
• Language: Swift
• Size: 2.29 MB
• Stars: 1,103
• Watchers: 22
• Forks: 71
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# MultipeerKit

A high-level abstraction built on top of the MultipeerConnectivity framework, which allows iOS, macOS and tvOS devices to exchange data between them over Wi-Fi networks, peer-to-peer Wi-Fi, and Bluetooth.

## Sample app

Check the example folder for a sample implementation.

![Sample](../assets/demo.gif?raw=true)

## Info.plist configuration

In order for MultipeerKit to work when running on iOS 14, you will have to include two keys in your app's Info.plist file.

The keys are `Privacy - Local Network Usage Description` (`NSLocalNetworkUsageDescription`) and `Bonjour services` (`NSBonjourServices`).

For the privacy key, include a human-readable description of what benefit the user gets by allowing your app to access devices on the local network.

The Bonjour services key is an array of service types that your app will browse for. For MultipeerKit, the entry should be in the format `_servicename._tcp`, where `servicename` is the `serviceType` you've set in your `MultipeerConfiguration`. If you're using the default configuration, the value of this key should be `_MKSVC._tcp`.

**If you do not configure the above keys properly, then MultipeerKit won't work.**

## Usage

The main class in this library is `MultipeerTransceiver`, which does both the sending and receiving aspects of the multipeer communication.

MultipeerKit can transmit and receive anything that conforms to the `Codable` protocol, which makes it easy for you to define your own message types.

```swift

// Create a transceiver (make sure you store it somewhere, like a property)

let transceiver = MultipeerTransceiver()

// Start it up!

transceiver.resume()

// Configure message receivers

transceiver.receive(SomeCodableThing.self) { payload, sender in

print("Got my thing from \(sender.name)! \(payload)")

}

// Broadcast message to peers

let payload = SomeEncodableThing()

transceiver.broadcast(payload)

```

For more information on how to use MultipeerKit, check out the [documentation](https://multipeerkit.rambo.codes).

## Integrating

MultipeerKit is a Swift package, to use it in your project, add this to your `Package.swift` file:

```swift

let package = Package(

    ...

    dependencies: [

        .package(url: "https://github.com/insidegui/MultipeerKit.git", from: "0.4.0")

    ],

    ...

)

```