Gamekit

作者 dpearson26998d90fd121a26无许可证1.1K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库2个月前更新

Integrate Game Center features using GameKit. Use when authenticating GKLocalPlayer, checking player restrictions, submitting leaderboard scores, reporting achievements, implementing real-time or turn-based matchmaking, handling GKMatch data, showing the Game Center dashboard or access point, adding challenges and friend invitations, saving game data, or verifying player identity on a server.

仅含说明Software Development

AI 生成的概览

指导集成 Apple GameKit 的 Game Center 功能，如身份验证、排行榜、成就和匹配。

功能: 该技能提供通过 Apple GameKit 框架为应用添加 Game Center 功能的说明和 Swift 代码示例。内容涵盖玩家身份验证、限制检查、访问点和仪表盘展示、排行榜分数提交、成就上报、实时与回合制匹配、对局数据交换，以及常见错误和审查清单。它产出的是指导与代码片段，而不是文件或脚本。
适用场景: 适用于在 Apple 平台应用中实现或审查 Game Center 集成时，例如验证 GKLocalPlayer、提交分数、上报成就或构建多人匹配。也适合检查玩家限制以及在服务器上验证玩家身份。
运行要求: 需要一个使用 GameKit 框架的 Apple 平台项目，在 Xcode 签名设置中启用 Game Center 能力，并在 App Store Connect 中配置排行榜和成就。它不附带脚本，仅引用一份模式文档和外部 GameKit 文档。

GameKit

Use GameKit for Game Center authentication, competition, matchmaking, social surfaces, and saved-game handoffs; keep rendering, board logic, and full SharePlay group-activity design in their owning framework skills.

Authentication
Access Point
Dashboard
Leaderboards
Achievements
Real-Time Multiplayer
Turn-Based Multiplayer
Common Mistakes
Review Checklist
References

Authentication

All GameKit features require the local player to authenticate first. Set the authenticateHandler on GKLocalPlayer.local early in the app lifecycle. GameKit calls the handler multiple times during initialization.

swift

import GameKit
func authenticatePlayer() {    GKLocalPlayer.local.authenticateHandler = { viewController, error in        if let viewController {            // Present so the player can sign in or create an account.            present(viewController, animated: true)            return        }        if let error {            // Player could not sign in. Disable Game Center features.            disableGameCenter()            return        }
        // Player authenticated. Check restrictions before starting.        let player = GKLocalPlayer.local
        if player.isUnderage {            hideExplicitContent()        }        if player.isMultiplayerGamingRestricted {            disableMultiplayer()        }        if player.isPersonalizedCommunicationRestricted {            disableInGameChat()        }
        configureAccessPoint()    }}

import GameKit
func authenticatePlayer() {    GKLocalPlayer.local.authenticateHandler = { viewController, error in        if let viewController {            // Present so the player can sign in or create an account.            present(viewController, animated: true)            return        }        if let error {            // Player could not sign in. Disable Game Center features.            disableGameCenter()            return        }
        // Player authenticated. Check restrictions before starting.        let player = GKLocalPlayer.local
        if player.isUnderage {            hideExplicitContent()        }        if player.isMultiplayerGamingRestricted {            disableMultiplayer()        }        if player.isPersonalizedCommunicationRestricted {            disableInGameChat()        }
        configureAccessPoint()    }}

Guard on GKLocalPlayer.local.isAuthenticated before calling any GameKit API. For server-side identity verification, see references/gamekit-patterns.md [blocked].

Access Point

GKAccessPoint displays a Game Center control in a corner of the screen. When tapped, it opens the Game Center dashboard. Configure it after authentication.

swift

func configureAccessPoint() {    GKAccessPoint.shared.location = .topLeading    GKAccessPoint.shared.showHighlights = true    GKAccessPoint.shared.isActive = true}

func configureAccessPoint() {    GKAccessPoint.shared.location = .topLeading    GKAccessPoint.shared.showHighlights = true    GKAccessPoint.shared.isActive = true}

Hide the access point during gameplay and show it on menu screens:

swift

GKAccessPoint.shared.isActive = false  // Hide during active gameplayGKAccessPoint.shared.isActive = true   // Show on pause or menu

GKAccessPoint.shared.isActive = false  // Hide during active gameplayGKAccessPoint.shared.isActive = true   // Show on pause or menu

Open the dashboard to a specific state programmatically. Specific leaderboard access-point triggers require iOS 18+.

swift

// Open directly to a leaderboardGKAccessPoint.shared.trigger(    leaderboardID: "com.mygame.highscores",    playerScope: .global,    timeScope: .allTime) { }
// Open directly to achievementsGKAccessPoint.shared.trigger(state: .achievements) { }

// Open directly to a leaderboardGKAccessPoint.shared.trigger(    leaderboardID: "com.mygame.highscores",    playerScope: .global,    timeScope: .allTime) { }
// Open directly to achievementsGKAccessPoint.shared.trigger(state: .achievements) { }

Dashboard

Present the Game Center dashboard using GKGameCenterViewController. The presenting object must conform to GKGameCenterControllerDelegate.

swift

final class GameViewController: UIViewController, GKGameCenterControllerDelegate {
    func showDashboard() {        let vc = GKGameCenterViewController(state: .dashboard)        vc.gameCenterDelegate = self        present(vc, animated: true)    }
    func showLeaderboard(_ leaderboardID: String) {        let vc = GKGameCenterViewController(            leaderboardID: leaderboardID,            playerScope: .global,            timeScope: .allTime        )        vc.gameCenterDelegate = self        present(vc, animated: true)    }
    func gameCenterViewControllerDidFinish(        _ gameCenterViewController: GKGameCenterViewController    ) {        gameCenterViewController.dismiss(animated: true)    }}

final class GameViewController: UIViewController, GKGameCenterControllerDelegate {
    func showDashboard() {        let vc = GKGameCenterViewController(state: .dashboard)        vc.gameCenterDelegate = self        present(vc, animated: true)    }
    func showLeaderboard(_ leaderboardID: String) {        let vc = GKGameCenterViewController(            leaderboardID: leaderboardID,            playerScope: .global,            timeScope: .allTime        )        vc.gameCenterDelegate = self        present(vc, animated: true)    }
    func gameCenterViewControllerDidFinish(        _ gameCenterViewController: GKGameCenterViewController    ) {        gameCenterViewController.dismiss(animated: true)    }}

Dashboard states include .dashboard, .leaderboards, .achievements, .challenges, .localPlayerProfile, and .localPlayerFriendsList.

Leaderboards

Configure leaderboards in App Store Connect before submitting scores. Supports classic (persistent) and recurring (time-limited, auto-resetting) types.

Submitting Scores

Submit to one or more leaderboards using the class method:

swift

func submitScore(_ score: Int, leaderboardIDs: [String]) async throws {    try await GKLeaderboard.submitScore(        score,        context: 0,        player: GKLocalPlayer.local,        leaderboardIDs: leaderboardIDs    )}

func submitScore(_ score: Int, leaderboardIDs: [String]) async throws {    try await GKLeaderboard.submitScore(        score,        context: 0,        player: GKLocalPlayer.local,        leaderboardIDs: leaderboardIDs    )}

Loading Entries

swift

func loadTopScores(    leaderboardID: String,    count: Int = 10) async throws -> (GKLeaderboard.Entry?, [GKLeaderboard.Entry]) {    let leaderboards = try await GKLeaderboard.loadLeaderboards(        IDs: [leaderboardID]    )    guard let leaderboard = leaderboards.first else { return (nil, []) }
    let (localEntry, entries, _) = try await leaderboard.loadEntries(        for: .global,        timeScope: .allTime,        range: 1...count    )    return (localEntry, entries)}

func loadTopScores(    leaderboardID: String,    count: Int = 10) async throws -> (GKLeaderboard.Entry?, [GKLeaderboard.Entry]) {    let leaderboards = try await GKLeaderboard.loadLeaderboards(        IDs: [leaderboardID]    )    guard let leaderboard = leaderboards.first else { return (nil, []) }
    let (localEntry, entries, _) = try await leaderboard.loadEntries(        for: .global,        timeScope: .allTime,        range: 1...count    )    return (localEntry, entries)}

GKLeaderboard.Entry provides player, rank, score, formattedScore, context, and date. For recurring leaderboard timing, leaderboard images, and leaderboard sets, see references/gamekit-patterns.md [blocked].

Achievements

Configure achievements in App Store Connect. Each achievement has a unique identifier, point value, and localized title/description.

Reporting Progress

Set percentComplete from 0...100. The property type is Double, but Apple requires an integer value. GameKit only accepts increases.

swift

func reportAchievement(identifier: String, percentComplete: Int) async throws {    let achievement = GKAchievement(identifier: identifier)    achievement.percentComplete = Double(min(max(percentComplete, 0), 100))    achievement.showsCompletionBanner = true    try await GKAchievement.report([achievement])}
// Unlock an achievement completelyfunc unlockAchievement(_ identifier: String) async throws {    try await reportAchievement(identifier: identifier, percentComplete: 100)}

func reportAchievement(identifier: String, percentComplete: Int) async throws {    let achievement = GKAchievement(identifier: identifier)    achievement.percentComplete = Double(min(max(percentComplete, 0), 100))    achievement.showsCompletionBanner = true    try await GKAchievement.report([achievement])}
// Unlock an achievement completelyfunc unlockAchievement(_ identifier: String) async throws {    try await reportAchievement(identifier: identifier, percentComplete: 100)}

Loading Player Achievements

swift

func loadPlayerAchievements() async throws -> [GKAchievement] {    try await GKAchievement.loadAchievements()}

func loadPlayerAchievements() async throws -> [GKAchievement] {    try await GKAchievement.loadAchievements()}

If an achievement is not returned, the player has no progress on it yet. Create a new GKAchievement(identifier:) to begin reporting. Use GKAchievement.resetAchievements() to reset all progress during testing.

Real-Time Multiplayer

Real-time multiplayer connects players in a peer-to-peer network for simultaneous gameplay. Players exchange data directly through GKMatch.

Matchmaking with GameKit UI

Use GKMatchmakerViewController for the standard matchmaking interface:

swift

func presentMatchmaker() {    let request = GKMatchRequest()    request.minPlayers = 2    request.maxPlayers = 4    request.inviteMessage = "Join my game!"
    guard let matchmakerVC = GKMatchmakerViewController(matchRequest: request) else {        return    }    matchmakerVC.matchmakerDelegate = self    present(matchmakerVC, animated: true)}

func presentMatchmaker() {    let request = GKMatchRequest()    request.minPlayers = 2    request.maxPlayers = 4    request.inviteMessage = "Join my game!"
    guard let matchmakerVC = GKMatchmakerViewController(matchRequest: request) else {        return    }    matchmakerVC.matchmakerDelegate = self    present(matchmakerVC, animated: true)}

Implement GKMatchmakerViewControllerDelegate:

swift

extension GameViewController: GKMatchmakerViewControllerDelegate {    func matchmakerViewController(        _ viewController: GKMatchmakerViewController,        didFind match: GKMatch    ) {        match.delegate = self        viewController.dismiss(animated: true)        startGame(with: match)    }
    func matchmakerViewControllerWasCancelled(        _ viewController: GKMatchmakerViewController    ) {        viewController.dismiss(animated: true)    }
    func matchmakerViewController(        _ viewController: GKMatchmakerViewController,        didFailWithError error: Error    ) {        viewController.dismiss(animated: true)    }}

extension GameViewController: GKMatchmakerViewControllerDelegate {    func matchmakerViewController(        _ viewController: GKMatchmakerViewController,        didFind match: GKMatch    ) {        match.delegate = self        viewController.dismiss(animated: true)        startGame(with: match)    }
    func matchmakerViewControllerWasCancelled(        _ viewController: GKMatchmakerViewController    ) {        viewController.dismiss(animated: true)    }
    func matchmakerViewController(        _ viewController: GKMatchmakerViewController,        didFailWithError error: Error    ) {        viewController.dismiss(animated: true)    }}

Exchanging Data

Send and receive game state through GKMatch and GKMatchDelegate:

swift

extension GameViewController: GKMatchDelegate {    func sendAction(_ action: GameAction, to match: GKMatch) throws {        let data = try JSONEncoder().encode(action)        try match.sendData(toAllPlayers: data, with: .reliable)    }
    func match(_ match: GKMatch, didReceive data: Data, fromRemotePlayer player: GKPlayer) {        guard let action = try? JSONDecoder().decode(GameAction.self, from: data) else {            return        }        handleRemoteAction(action, from: player)    }
    func match(_ match: GKMatch, player: GKPlayer, didChange state: GKPlayerConnectionState) {        switch state {        case .connected:            checkIfReadyToStart(match)        case .disconnected:            handlePlayerDisconnected(player)        default:            break        }    }}

extension GameViewController: GKMatchDelegate {    func sendAction(_ action: GameAction, to match: GKMatch) throws {        let data = try JSONEncoder().encode(action)        try match.sendData(toAllPlayers: data, with: .reliable)    }
    func match(_ match: GKMatch, didReceive data: Data, fromRemotePlayer player: GKPlayer) {        guard let action = try? JSONDecoder().decode(GameAction.self, from: data) else {            return        }        handleRemoteAction(action, from: player)    }
    func match(_ match: GKMatch, player: GKPlayer, didChange state: GKPlayerConnectionState) {        switch state {        case .connected:            checkIfReadyToStart(match)        case .disconnected:            handlePlayerDisconnected(player)        default:            break        }    }}

Data modes: .reliable sends until delivery succeeds or the connection times out; .unreliable sends once and may arrive out of order. Use .reliable for critical state and .unreliable for small, time-sensitive updates. Treat received match data as untrusted input. Register the local player as a listener (GKLocalPlayer.local.register(self)) to receive invitations. For programmatic matchmaking and custom match UI, see references/gamekit-patterns.md [blocked].

Turn-Based Multiplayer

Turn-based games store match state on Game Center servers. Players take turns asynchronously and do not need to be online simultaneously.

Starting a Match

swift

let request = GKMatchRequest()request.minPlayers = 2request.maxPlayers = 4
let matchmakerVC = GKTurnBasedMatchmakerViewController(matchRequest: request)matchmakerVC.turnBasedMatchmakerDelegate = selfpresent(matchmakerVC, animated: true)

let request = GKMatchRequest()request.minPlayers = 2request.maxPlayers = 4
let matchmakerVC = GKTurnBasedMatchmakerViewController(matchRequest: request)matchmakerVC.turnBasedMatchmakerDelegate = selfpresent(matchmakerVC, animated: true)

Taking Turns

Encode game state into Data, end the turn, and specify the next participants:

swift

func endTurn(match: GKTurnBasedMatch, gameState: GameState) async throws {    let data = try JSONEncoder().encode(gameState)
    // Build next participants list: remaining active players    let nextParticipants = match.participants.filter {        $0.status != .done && $0 != match.currentParticipant    }
    try await match.endTurn(        withNextParticipants: nextParticipants,        turnTimeout: GKTurnTimeoutDefault,        match: data    )}

func endTurn(match: GKTurnBasedMatch, gameState: GameState) async throws {    let data = try JSONEncoder().encode(gameState)
    // Build next participants list: remaining active players    let nextParticipants = match.participants.filter {        $0.status != .done && $0 != match.currentParticipant    }
    try await match.endTurn(        withNextParticipants: nextParticipants,        turnTimeout: GKTurnTimeoutDefault,        match: data    )}

Ending the Match

Set outcomes for all participants, then end the match:

swift

func endMatch(_ match: GKTurnBasedMatch, winnerIndex: Int, data: Data) async throws {    for (index, participant) in match.participants.enumerated() {        participant.matchOutcome = (index == winnerIndex) ? .won : .lost    }    try await match.endMatchInTurn(withMatch: data)}

func endMatch(_ match: GKTurnBasedMatch, winnerIndex: Int, data: Data) async throws {    for (index, participant) in match.participants.enumerated() {        participant.matchOutcome = (index == winnerIndex) ? .won : .lost    }    try await match.endMatchInTurn(withMatch: data)}

Listening for Turn Events

swift

GKLocalPlayer.local.register(self)
extension GameViewController: GKLocalPlayerListener {    func player(_ player: GKPlayer, receivedTurnEventFor match: GKTurnBasedMatch,                didBecomeActive: Bool) {        // Load match data and update UI        loadAndDisplayMatch(match)    }
    func player(_ player: GKPlayer, matchEnded match: GKTurnBasedMatch) {        showMatchResults(match)    }}

GKLocalPlayer.local.register(self)
extension GameViewController: GKLocalPlayerListener {    func player(_ player: GKPlayer, receivedTurnEventFor match: GKTurnBasedMatch,                didBecomeActive: Bool) {        // Load match data and update UI        loadAndDisplayMatch(match)    }
    func player(_ player: GKPlayer, matchEnded match: GKTurnBasedMatch) {        showMatchResults(match)    }}

Match Data Size

Check the match object's matchDataMaximumSize before ending a turn. Store larger state externally and keep only compact references in match data.

Common Mistakes

Not authenticating before using GameKit APIs

swift

// DON'Tfunc submitScore() {    GKLeaderboard.submitScore(100, context: 0, player: GKLocalPlayer.local,                              leaderboardIDs: ["scores"]) { _ in }}
// DOfunc submitScore() async throws {    guard GKLocalPlayer.local.isAuthenticated else { return }    try await GKLeaderboard.submitScore(        100, context: 0, player: GKLocalPlayer.local, leaderboardIDs: ["scores"]    )}

// DON'Tfunc submitScore() {    GKLeaderboard.submitScore(100, context: 0, player: GKLocalPlayer.local,                              leaderboardIDs: ["scores"]) { _ in }}
// DOfunc submitScore() async throws {    guard GKLocalPlayer.local.isAuthenticated else { return }    try await GKLeaderboard.submitScore(        100, context: 0, player: GKLocalPlayer.local, leaderboardIDs: ["scores"]    )}

Setting authenticateHandler multiple times

swift

// DON'T: Set handler on every scene transitionoverride func viewDidAppear(_ animated: Bool) {    super.viewDidAppear(animated)    GKLocalPlayer.local.authenticateHandler = { vc, error in /* ... */ }}
// DO: Set the handler once, early in the app lifecycle

// DON'T: Set handler on every scene transitionoverride func viewDidAppear(_ animated: Bool) {    super.viewDidAppear(animated)    GKLocalPlayer.local.authenticateHandler = { vc, error in /* ... */ }}
// DO: Set the handler once, early in the app lifecycle

Ignoring multiplayer restrictions

swift

// DON'Tfunc showMultiplayerMenu() { presentMatchmaker() }
// DOfunc showMultiplayerMenu() {    guard !GKLocalPlayer.local.isMultiplayerGamingRestricted else { return }    presentMatchmaker()}

// DON'Tfunc showMultiplayerMenu() { presentMatchmaker() }
// DOfunc showMultiplayerMenu() {    guard !GKLocalPlayer.local.isMultiplayerGamingRestricted else { return }    presentMatchmaker()}

Not setting match delegate immediately

swift

// DON'T: Set delegate in dismiss completion -- misses early messagesfunc matchmakerViewController(_ vc: GKMatchmakerViewController, didFind match: GKMatch) {    vc.dismiss(animated: true) { match.delegate = self }}
// DO: Set delegate before dismissingfunc matchmakerViewController(_ vc: GKMatchmakerViewController, didFind match: GKMatch) {    match.delegate = self    vc.dismiss(animated: true)}

// DON'T: Set delegate in dismiss completion -- misses early messagesfunc matchmakerViewController(_ vc: GKMatchmakerViewController, didFind match: GKMatch) {    vc.dismiss(animated: true) { match.delegate = self }}
// DO: Set delegate before dismissingfunc matchmakerViewController(_ vc: GKMatchmakerViewController, didFind match: GKMatch) {    match.delegate = self    vc.dismiss(animated: true)}

Not calling finishMatchmaking for programmatic matches

swift

// DON'Tlet match = try await GKMatchmaker.shared().findMatch(for: request)startGame(with: match)
// DOlet match = try await GKMatchmaker.shared().findMatch(for: request)GKMatchmaker.shared().finishMatchmaking(for: match)startGame(with: match)

// DON'Tlet match = try await GKMatchmaker.shared().findMatch(for: request)startGame(with: match)
// DOlet match = try await GKMatchmaker.shared().findMatch(for: request)GKMatchmaker.shared().finishMatchmaking(for: match)startGame(with: match)

Not disconnecting from match

swift

// DON'Tfunc returnToMenu() { showMainMenu() }
// DOfunc returnToMenu() {    currentMatch?.disconnect()    currentMatch?.delegate = nil    currentMatch = nil    showMainMenu()}

// DON'Tfunc returnToMenu() { showMainMenu() }
// DOfunc returnToMenu() {    currentMatch?.disconnect()    currentMatch?.delegate = nil    currentMatch = nil    showMainMenu()}

Review Checklist

References

See references/gamekit-patterns.md [blocked] for identity verification, legacy voice chat, saved games, custom match UI, leaderboard images, challenge handling, and rule-based matchmaking.
GameKit documentation
GKLocalPlayer
GKAccessPoint
GKLeaderboard
GKAchievement
GKMatch
GKTurnBasedMatch

来源与署名

来源：dpearson2699/swift-ios-skills位于skills/gamekit提交8d90fd1

许可证：无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

Gamekit

GameKit

Contents

Authentication

Access Point

Dashboard

Leaderboards

Submitting Scores

Loading Entries

Achievements

Reporting Progress

Loading Player Achievements

Real-Time Multiplayer

Matchmaking with GameKit UI

Exchanging Data

Turn-Based Multiplayer

Starting a Match

Taking Turns

Ending the Match

Listening for Turn Events

Match Data Size

Common Mistakes

Not authenticating before using GameKit APIs

Setting authenticateHandler multiple times

Ignoring multiplayer restrictions

Not setting match delegate immediately

Not calling finishMatchmaking for programmatic matches

Not disconnecting from match

Review Checklist

References

来源与署名

更多来自 dpearson2699/swift-ios-skills 的技能

Widgetkit

Weatherkit

Vision Framework

Tipkit

Tabletopkit

Swiftui Webkit

更多Software Development技能

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices