Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swiftpackagerepository/gamekitservice.swift
https://github.com/swiftpackagerepository/gamekitservice.swift
gamecenter gamekit swift
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/swiftpackagerepository/gamekitservice.swift
- Owner: SwiftPackageRepository
- License: mit
- Created: 2020-12-03T23:44:23.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-07T16:30:01.000Z (over 3 years ago)
- Last Synced: 2024-10-21T03:45:16.474Z (29 days ago)
- Topics: gamecenter, gamekit, swift
- Language: Swift
- Homepage:
- Size: 13.7 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GameKitService.swift
## GameKit (GameCenter) helper for Swift
GameKitService is **created and maintaned with ❥** by Sascha Muellner.
---
[](https://github.com/SwiftPackageRepository/GameKitService.swift/actions?query=workflow%3ASwift)
[](https://codecov.io/gh/SwiftPackageRepository/GameKitService.swift)
[](https://swiftpackageindex.com/SwiftPackageRepository/GameKitService.swift)
[](https://github.com/SwiftPackageRepository/GameKitService.swift/blob/main/LICENSE)
[](https://swiftpackageindex.com/SwiftPackageRepository/GameKitService.swift)
[](https://github.com/apple/swift-package-manager)
[](https://SwiftPackageRepository.github.io/GameKitService.swift)
## What?
This is a **Swift** package with support for iOS/macOS/tvOS that focuses on bridging the current GameKit implementation to a single service structure utilizing Combine to simplify and modernize GameKit's match handling.
## Requirements
The latest version of GameKitService requires:
- Swift 5+
- iOS 13+
- Xcode 11+
## Installation
### Swift Package Manager
Using SPM add the following to your dependencies
``` 'GameKitService', 'master', 'https://github.com/SwiftPackageRepository/GameKitService.swift.git' ```
## How to use?
### Starting a match
Given you already authenticated the user and did initiate a match you, using for example [GCHelper](https://github.com/jackcook/GCHelper.git) or [GameKitUI](https://github.com/SwiftPackageRepository/GameKitUI.swift.git), you can now start it using **start** method from the **GameKitService**:
```swift
import GameKit
import GameKitService
let match: GKMatch
GameKitService
.shared
.start(match)
```
### Subscribing to match data changes
The following match data changes can be subscribed using the **GameKitService**.
#### Authenticated
Subscribe to the `authenticated: CurrentValueSubject` CurrentValueSubject, to receive when the user is authenticated at the GameCenter.
```swift
import GameKit
import GameKitService
let match: GKMatch
GameKitService
.shared
.authenticated(match)
```
#### Match start
Subscribe to the `started: PassthroughSubject` PassthroughSubject, to receive data about the starting of the match.
```swift
var cancellable: AnyCancellable?
self.cancellable = GameKitService
.ended
.received.sink { (match: GKMatch) in
// match: the ending match
}
```
#### Match data
Subscribe to the `received: PassthroughSubject<(match: GKMatch, data: Data, player: GKPlayer), Never>` PassthroughSubject, to receive data about the match from another player's device in the match.
```swift
var cancellable: AnyCancellable?
self.cancellable = GameKitService
.shared
.received.sink { (match: GKMatch, data: Data, player: GKPlayer) in
// match: the current match
// data: the data send from
// player: the player that did send the data
}
```
#### Match ended
Subscribe to the `ended: PassthroughSubject` PassthroughSubject, to receive data about the ending of the match.
```swift
var cancellable: AnyCancellable?
self.cancellable = GameKitService
.ended
.received.sink { (match: GKMatch) in
// match: the ending match
}
```
### Sending match data
To send data to other players in the match there are two possibilites. In the first one the data is send to all players in the match:
```swift
let data = "Hello Players!".data(using: .utf8)!
do {
try GameKitService
.shared
.send(data)
} catch {
}
```
Where as the second possibility allows you to send to a dedicated group (one or more) of players in the match.
```swift
let playerOne: GKPlayer
let data = "Hello Player One!".data(using: .utf8)!
do {
try GameKitService
.shared
.send(data, players: [playerOne])
} catch {
}
```
## Documentation
+ [Apple Documentation GameKit](https://developer.apple.com/documentation/gamekit/)
+ [raywenderlich.com: Game Center for iOS: Building a Turn-Based Game](https://www.raywenderlich.com/7544-game-center-for-ios-building-a-turn-based-game)
+ [raywenderlich.com: Game Center Tutorial: How To Make A Simple Multiplayer Game with Sprite Kit: Part 1/2](https://www.raywenderlich.com/7544-game-center-for-ios-building-a-turn-based-game)
+ [Medium: GameKit Real Time Multiplayer Tutorial](https://link.medium.com/Mwg3mSi4Ebb)