npm - bps-kit - Versions diffs - 1.0.1 → 1.0.3 - Mend

bps-kit 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3669) hide show

package/templates/vault/hig-technologies/references/carplay.md DELETED Viewed

@@ -1,119 +0,0 @@
----
-title: "CarPlay | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/carplay
-# CarPlay
-CarPlay lets people get directions, make calls, send and receive messages, listen to music, and more from their car’s built-in display, all while staying focused on the road.
-![A sketch of the CarPlay icon. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/a1087b54e07bb75c8e79e0f764d21ca1/technologies-CarPlay-intro%402x.png)
-People download CarPlay apps from the App Store and install them on iPhone like any other app. When people connect their iPhone with their vehicle, app icons for installed CarPlay apps appear on the CarPlay Home screen.
-CarPlay is designed for drivers to use while they’re driving. Keep this context in mind as you design your CarPlay app, providing features that help people perform tasks quickly and with minimal interaction.
-To create the interface of your CarPlay app, you use the system-defined templates that are appropriate for the type of app you’re developing, such as audio, communication, navigation, or fueling. For each template, your app provides the content and iOS renders it in CarPlay. Because the system displays UI components and handles the interface with the vehicle, you don’t need to adjust your layout for different screen resolutions, or manage input from different types of hardware like touchscreens, knobs, or touch pads.
-To learn how to create various types of CarPlay apps and use the system-provided templates, see [CarPlay App Programming Guide](https://developer.apple.com/carplay/documentation/CarPlay-App-Programming-Guide.pdf). The general design guidelines below apply to all types of CarPlay apps.
-## [iPhone interactions](https://developer.apple.com/design/human-interface-guidelines/carplay#iPhone-interactions)
-CarPlay shows compatible apps from the connected iPhone on the car’s built-in display, applying simplified interfaces that are optimized for use while driving.
-**Eliminate app interactions on iPhone when CarPlay is active.** Interactions with your app need to occur using the car’s built-in controls and display. If your app requires setup on iPhone, make sure people perform it before the vehicle is in motion.
-**Never lock people out of CarPlay because the connected iPhone requires input.** Your app needs to function when iPhone is inaccessible — for example, when people put it in a bag or in the trunk while driving. If people must resolve a problem on the connected iPhone, let them do so after the vehicle stops.
-**Make sure your app works without requiring people to unlock iPhone.** Most people use CarPlay while their iPhone is locked, so ensure that the features you provide in your CarPlay app work as expected in this scenario.
-### [Audio](https://developer.apple.com/design/human-interface-guidelines/carplay#Audio)
-In CarPlay, keep in mind that your app coexists with other audio sources, such as the car’s own built-in radio and voice prompts from the navigation system. Regardless of whether audio is a primary aspect of your app’s experience, you need to know how people expect audio to behave so you can meet those expectations.
-**Let people choose when to start playback.** In general, avoid beginning playback automatically unless your app’s purpose is to play a single source of audio, or your app is resuming previously interrupted audio. Also, avoid starting an audio session until you’re ready to actually play audio because starting a session silences other audio sources, like the car’s built-in radio.
-**Start playback as soon as audio has sufficiently loaded.** After people make a selection, it may take several seconds for audio to begin playing, depending on buffering and network conditions. The system keeps the selection highlighted and displays a spinning activity indicator until your app signals that the audio is ready to play.
-**Display the Now Playing screen when audio is ready to play.** Don’t delay playback until descriptive information completes loading. If necessary, continue loading such information in the background, and show it when it’s available.
-**Resume audio playback after an interruption only when it’s appropriate.** For example, your app can resume audio after a temporary interruption like a phone call. Permanent interruptions, such as a music playlist initiated by Siri, are nonresumable. When a resumable interruption occurs, your app needs to resume playback when the interruption ends if audio was actively playing when the interruption started.
-**When necessary, automatically adjust audio levels, but don’t change the overall volume.** Although your app can adjust relative, independent volume levels to achieve a great mix of audio, people need to control the final output volume.
-## [Layout](https://developer.apple.com/design/human-interface-guidelines/carplay#Layout)
-CarPlay supports a wide range of display resolutions with varying pixel densities and aspect ratios. The system automatically scales app icons and interfaces based on the resolution of the display, so they always appear onscreen at roughly the same size. Some common screen sizes are listed in the table below.
-Dimensions (pixels)| Aspect ratio
----|---
-800x480| 5:3
-960x540| 16:9
-1280x720| 16:9
-1920x720| 8:3
-**Provide useful, high-value information in a clean layout that’s easy to scan from the driver’s seat.** Don’t clutter the screen with nonessential details and unnecessary visual embellishments.
-**Maintain an overall consistent appearance throughout your app.** In general, ensure that elements with similar functions look similar.
-**Ensure that primary content stands out and feels actionable.** Large items tend to appear more important than smaller ones and are easier for people to tap. In general, place the most important content and controls in the upper half of the screen.
-## [Color](https://developer.apple.com/design/human-interface-guidelines/carplay#Color)
-Color can indicate interactivity, impart vitality, and provide visual continuity.
-**In general, prefer a limited color palette that coordinates with your app logo.** Subtle use of color is a great way to communicate your brand.
-**Avoid using the same color for interactive and noninteractive elements.** If interactive and noninteractive elements have the same color, it’s hard for people to know where to tap.
-**Test your app’s color scheme under a variety of lighting conditions in an actual car.** Lighting varies significantly based on time of day, weather, window tinting, and more. Colors you see on your computer at design time won’t always look the same when your app is used in the real world. Consider how color brightness might affect the experience of driving at night, and how low-contrast colors can wash out in direct sunlight. If necessary, make adjustments to provide the best possible viewing experience in the majority of use cases.
-**Ensure your app looks great in both dark and light environments.** CarPlay supports both light and dark appearances, and may automatically adjust the current appearance based on lighting conditions.
-**Choose colors that help you communicate effectively with everyone.** Different people see and interpret colors differently. For guidance on using colors in ways that people appreciate, see [Inclusive color](https://developer.apple.com/design/human-interface-guidelines/color#Inclusive-color).
-## [Icons and images](https://developer.apple.com/design/human-interface-guidelines/carplay#Icons-and-images)
-CarPlay supports both landscape and portrait displays and both @2x (low resolution) and @3x (high resolution) scale factors.
-**Supply high-resolution images with scale factors of @2x and @3x for all CarPlay artwork in your app.** The system automatically shows the correct images and scales them appropriately, based on the resolution and size of the car’s display.
-**Mirror your iPhone app icon.** A well-designed app icon works well in CarPlay and on iPhone, without the need for a second design.
-**Don’t use black for your icon’s background.** Lighten a black background or add a border so the icon doesn’t blend into the display background.
-Create your CarPlay app icon in the following sizes:
-@2x (pixels)| @3x (pixels)
----|---
-120x120| 180x180
-## [Error handling](https://developer.apple.com/design/human-interface-guidelines/carplay#Error-handling)
-A CarPlay app needs to handle errors gracefully and report them to people only when absolutely necessary.
-**Report errors in CarPlay, not on the connected iPhone.** If you must notify people of a problem, do so clearly in CarPlay. Never direct people to pick up their iPhone to read or resolve an error.
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/carplay#Platform-considerations)
- _No additional considerations for iOS. Not supported in iPadOS, macOS, tvOS, visionOS, or watchOS._
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/carplay#Resources)
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/carplay#Related)
-[CarPlay](http://developer.apple.com/carplay/)
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/carplay#Developer-documentation)
-[CarPlay App Programming Guide](https://developer.apple.com/carplay/documentation/CarPlay-App-Programming-Guide.pdf)
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/carplay#Videos)
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/3AE21C44-8831-4C0A-BCBE-68C437FB8FC8/9903_wide_250x141_1x.jpg) Turbocharge your app for CarPlay ](https://developer.apple.com/videos/play/wwdc2025/216)
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/carplay#Change-log)
-Date| Changes
----|---
-May 2, 2023| Consolidated guidance into one page.

package/templates/vault/hig-technologies/references/game-center.md DELETED Viewed

@@ -1,343 +0,0 @@
----
-title: "Game Center | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/game-center
-# Game Center
-Game Center is Apple’s social gaming network, which lets players track their progress and connect with friends across Apple platforms, and boosts the discovery of your game across players’ devices.
-![A sketch of the Game Center icon. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/4df10f335123d3744626913e7fc71a02/technologies-Game-Center-intro%402x.png)
-Supporting Game Center in your game allows players to:
-  * Discover new games their friends are playing.
-  * Seamlessly invite friends to play.
-  * See the latest activity from their games across the system, in the Apple Games app, the App Store, notifications, and more.
-By enabling the player activities listed above, supporting Game Center also helps surface your game to more players across Apple platforms.
-You can add Game Center into your game using the GameKit framework, which provides a full-featured UI that makes it easy for players to access and view their Game Center data within your game. Alternatively, you can also use GameKit to present this data within your own custom UI. For developer guidance, see [GameKit](https://developer.apple.com/documentation/GameKit).
-## [Accessing Game Center](https://developer.apple.com/design/human-interface-guidelines/game-center#Accessing-Game-Center)
-To provide the best Game Center experience for your players, begin by determining whether the player is signed in to their Game Center account on the system when they launch your game. If they aren’t, initialize the player with Game Center at that time. This provides the most seamless user experience, and maximizes discovery opportunities for your game, such as in the Top Played chart and in social recommendations through players’ friends.
-### [Integrating the access point](https://developer.apple.com/design/human-interface-guidelines/game-center#Integrating-the-access-point)
-The Game Center _access point_ is an Apple-designed UI element that lets players view their Game Center profile and information without leaving your game. For developer guidance, see [Adding an access point to your game](https://developer.apple.com/documentation/GameKit/adding-an-access-point-to-your-game).
-![An iPhone screenshot of the game The Coast, on the title screen. The access point control, a circular button with a diagonal rocket symbol, sits in the upper corner on the leading edge.](https://docs-assets.developer.apple.com/published/9774fc7f07482493ee1559593dc08e53/games-access-point-collapsed%402x.png)
-In iOS, iPadOS, and macOS the access point leads players to the Game Overlay, a system overlay that allows players to view their progress and start game activities.
-![An illustration composed of an iPhone screenshot and an iPad screenshot, both of the game The Coast, with the Game Overlay appearing over the top of each. In the iPhone screenshot the overlay covers the entire screen, while in the iPad screenshot the overlay appears vertically on the trailing edge.](https://docs-assets.developer.apple.com/published/bd606a6020d893c8275928bfcf22bc36/games-game-overlay%402x.png)
-In visionOS and tvOS, the access point leads players to the in-game dashboard, a full-screen view of a player’s Game Center activity that appears on top of your game.
-**Display the access point in menu screens.** Consider adding the access point to the main menu or the settings area of your game. Avoid displaying the access point during active gameplay or in temporary splash screens, cinematic flows, or tutorials that might precede your game’s main menu screen.
-**Avoid placing controls near the access point.** You can choose to present the access point at any of the four corners of the screen in a fixed position. Remember that the access point has both a collapsed and expanded version, so check whether the access point overlaps any important UI and controls and adjust your layout accordingly.
-Note
-In visionOS, the locations of the access point vary based on game type, such as immersive or volume-based. For developer guidance, see [Adding an access point to your game](https://developer.apple.com/documentation/GameKit/adding-an-access-point-to-your-game#Configure-the-access-point-on-visionOS).
-**Consider pausing your game while the Game Overlay or dashboard is present.** Pausing your game can help players view their Game Center information without feeling like the game is continuing without them.
-### [Using custom UI](https://developer.apple.com/design/human-interface-guidelines/game-center#Using-custom-UI)
-Your game can include custom links into the Game Overlay (in iOS, iPadOS, macOS) or the dashboard (in visionOS and tvOS). Your custom UI can deep-link into specific areas within both such as leaderboards or a player’s Game Center profile.
-**Use the artwork Game Center provides in custom links.** When referencing Game Center features in custom UI, use the official artwork from [Apple Design Resources](https://developer.apple.com/design/resources/#technologies). Preserve the appearance of this artwork and don’t adjust the dimensions or visual effects.
-**Use the correct terminology in custom links.** The following table describes how to use Game Center terminology correctly so that you can avoid confusing players in custom UI.
-Term| Incorrect terms| Localization
----|---|---
-Game Center| GameKit, GameCenter, game center| Use the system-provided translation of _Game Center_
-Game Center Profile| Profile, Account, Player Info| Use the system-provided translation of _Game Center_ and localize _Profile_
-Achievements| Awards, Trophies, Medals|
-Leaderboards| Rankings, Scores, Leaders|
-Challenges| Competitions|
-Add Friends| Add, Add Profiles, Include Friends|
-## [Achievements](https://developer.apple.com/design/human-interface-guidelines/game-center#Achievements)
-Achievements give players an added incentive to stay engaged with your game. Game Center achievements appear in a collectible card format that highlights the player’s progress and showcases your artwork. For developer guidance, see [Rewarding players with achievements](https://developer.apple.com/documentation/GameKit/rewarding-players-with-achievements).
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the Achievements overview screen.](https://docs-assets.developer.apple.com/published/026715959db42c83de8cc04dc399dd03/games-achievement-overlay%402x.png)
-Achievements overview
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the detail view of a single achievement.](https://docs-assets.developer.apple.com/published/fa2b92d24d82b3cae0748a731df621e8/games-achievement-overlay-detail%402x.png)
-Achievement detail
-### [Integrating achievements into your game](https://developer.apple.com/design/human-interface-guidelines/game-center#Integrating-achievements-into-your-game)
-**Align with Game Center achievement states.** Game Center defines four achievement states: locked, in-progress, hidden, and completed. The system groups achievements by completion status, displaying completed achievements in the Completed group and all other achievements in the Locked group. When you map your achievements to the four Game Center achievement states, you give players a consistent experience and you help them see at a glance the types of achievements your game offers.
-**Determine a display order.** The order in which you upload achievements is the order in which they appear, so consider the order you want before uploading files. For example, you might want your achievements to appear in an order that corresponds to the most common path through your game.
-**Be succinct when describing achievements.** The achievement card limits the title and description to two lines each. If your title or description wraps beyond two lines, the card truncates the text. Use title-style capitalization for the achievement title and sentence-style capitalization for the description.
-![A diagram of an achievement card, with callouts indicating the achievement image, title, and description.](https://docs-assets.developer.apple.com/published/54e27c562164cbf32aff9722a4058bf0/games-achievement-anatomy%402x.png)
-**Give players a sense of progress.** When you use progressive achievements, the system displays player progress and provides encouraging messages like “Youʼre more than halfway to completing Great Lakes Freighter in The Coast. Keep going!” to help motivate players to complete them.
-### [Creating achievement images](https://developer.apple.com/design/human-interface-guidelines/game-center#Creating-achievement-images)
-**Design rich, high-quality images that help players feel rewarded.** Achievements are a prominent feature in Game Center UI, so it’s essential to design high-quality assets that catch the eye and encourage players to return to your game. Avoid reusing the same asset to represent more than one achievement. If you don’t provide an asset for an achievement, the card shows a placeholder image instead.
-**Create artwork in the appropriate size and format.** The system applies a circular mask to your achievement image, so be sure to keep content centered. Use the following specifications to create images.
-  * iOS, iPadOS, macOS, visionOS
-  * tvOS
-![A diagram of the layout for an achievement image in iOS, iPadOS, macOS, and visionOS, with callouts indicating the image size and mask diameter.](https://docs-assets.developer.apple.com/published/ba7aed683c8f0f112ce7024ce5a9a34f/ios-achievement-image-layout%402x.png)
-Attribute| Value
----|---
-Format| PNG, TIF, or JPG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-Image size| 512x512 pt (1024x1024 px @2x)
-Mask diameter| 512 pt (1024 px @2x)
-![A diagram of the layout for an achievement image in tvOS, with callouts indicating the image size and mask diameter.](https://docs-assets.developer.apple.com/published/1e98f3b125dd0babeb08bfbaf4873fed/tvos-achievement-image-layout%402x.png)
-Attribute| Value
----|---
-Format| PNG, TIF, or JPG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-Image size| 320x320 pt (640x640 px @2x)
-Mask diameter| 200 pt (400 px @2x)
-## [Leaderboards](https://developer.apple.com/design/human-interface-guidelines/game-center#Leaderboards)
-Leaderboards are a great way to encourage friendly competition within your game. When you adopt Game Center, players can easily check their ranking against friends and global players as well as receive notifications when their friends challenge them or pass their score on a leaderboard. You can take advantage of the system-designed UI or present leaderboard information within custom UI. For developer guidance, see [Encourage progress and competition with leaderboards](https://developer.apple.com/documentation/GameKit/encourage-progress-and-competition-with-leaderboards).
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the Leaderboards overview screen.](https://docs-assets.developer.apple.com/published/63770530177075f25554a9eefa82a959/games-leaderboards-overlay%402x.png)
-Leaderboards overview
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the detail view of a single leaderboard.](https://docs-assets.developer.apple.com/published/825cea7230ad7958b60f681aef7bb407/games-leaderboards-detail%402x.png)
-Leaderboard detail
-**Choose a leaderboard type.** Game Center supports two types of leaderboards: _classic_ and _recurring_.
-  * A _classic leaderboard_ tracks a player’s best all-time score. Classic leaderboards are always active with no ending. The following are examples of goals you might include in a classic leaderboard:
-    * Strive for the most perfect score in a rhythm game.
-    * Collect the most coins in a single dungeon run.
-    * Achieve the longest continuous time in an endless runner.
-  * A _recurring leaderboard_ resets based on a time interval you define, such as every week or every day. Recurring leaderboards can increase engagement by giving players more chances to take the lead. The following are examples of features that work well with recurring leaderboards:
-    * Daily rotating puzzles
-    * Seasonal or holiday-themed events
-    * Weekly leaderboards for different battle modes
-**Take advantage of leaderboard sets for multiple leaderboards.** Leaderboard sets are an organization system that can make it easier for players to find the board they’re looking for. Consider grouping leaderboard sets by themes or gameplay experiences, such as:
-  * Difficulty modes (Easy, Standard, Hard)
-  * Activity types (Combat, Crafting, Farming)
-  * Genres and themes (Disco, Pop, Rock)
-**Add leaderboard images.** Leaderboard artwork gives you another opportunity to reinforce your game’s visual aesthetic. Aim to create a unique image for each leaderboard in your game that reflects and showcases the gameplay involved in leaderboard ranking. Leaderboards appear across the system, promoting ways for players to engage and compete with friends, and having compelling images helps attract players and gives them a sense of the experience.
-For games that run in iOS, iPadOS, and macOS, use a single image for your leaderboard image. For games that run in tvOS, provide a set of images that animate when the artwork is in focus. To learn more about focus effects, see [Focus and selection](https://developer.apple.com/design/human-interface-guidelines/focus-and-selection). For help creating focusable images, download the tvOS template from [Apple Design Resources](https://developer.apple.com/design/resources/#tvos-apps). Use the following specifications to create leaderboard artwork.
-  * iOS, iPadOS, macOS
-  * tvOS
-![A diagram of the layout for a leaderboard image in iOS, iPadOS, and macOS, with callouts indicating the image size and mask diameter.](https://docs-assets.developer.apple.com/published/a41db2a595bec653175fcfb13b50b9ed/leaderboard-image-layout-general%402x.png)
-Attribute| Value
----|---
-Format| JPEG, JPG, or PNG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-Image size| 512x512 pt (1024x1024 px @2x)
-Cropped area| 512x312 pt (1024x624 px @2x)
-![A diagram of the layout for a leaderboard image in tvOS, with callouts indicating the image size, focused size, and unfocused size.](https://docs-assets.developer.apple.com/published/631b5255803637a7084fe167f971810c/tvos-multi-layered-leaderboard-image%402x.png)
-Attribute| Value
----|---
-Format| PNG, TIF, or JPG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-Image size| 659x371 pt (1318x742 px @2x)
-Focused size| 618x348 pt (1236x696 px @2x)
-Unfocused size| 548x309 pt (1096x618 px @2x)
-Note
-Be mindful of how cropping might affect your leaderboard artwork. In iOS, iPadOS, and macOS, the system crops artwork for leaderboards that are part of a leaderboard set. In tvOS, the focus effect on leaderboard artwork may crop your images at the edges of some layers. Make sure your primary content stays comfortably visible in both these scenarios.
-## [Challenges](https://developer.apple.com/design/human-interface-guidelines/game-center#Challenges)
-Challenges turn single player activities into multiplayer experiences with friends. Challenges are built on top of leaderboards and allow players to connect with their friends and participate in competitions with time limits. For developer documentation, see [Creating engaging challenges from leaderboards](https://developer.apple.com/documentation/GameKit/creating-engaging-challenges-from-leaderboards).
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the Challenges overview screen.](https://docs-assets.developer.apple.com/published/63176e29afb5351d511719cafdf1bb0d/games-challenges-overlay%402x.png)
-Challenges overview
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the detail view of a single challenge.](https://docs-assets.developer.apple.com/published/ddfb071869dd7577f3e43f955f1b6ce7/games-challenges-overlay-detail%402x.png)
-Challenge detail
-**Create engaging challenges.** Challenges are great for short, skill-based gameplay activities that have a clear way of gauging players’ accomplishments. Create challenges that take 1-5 minutes to play, with gameplay that players can complete individually. Examples of compelling challenges are:
-  * Complete the fastest lap in a racing level.
-  * Defeat the most enemies in a single round.
-  * Solve a daily puzzle with the fewest mistakes.
-**Avoid creating challenges that track overall progress or personal best scores.** These can give regular players an unfair advantage. Instead, track players’ most recent score after each attempt at your challenge. This helps keep your challenge motivating by placing all players on a level playing field.
-**Make it easy to jump into your challenge.** Players can access challenges through invitation links, the Game Overlay, or in the Games app in iOS, iPadOS, and macOS. Always deep-link to the exact mode or level where your challenge begins, and help first-time players complete any initial onboarding before beginning the challenge. For example, if your game requires a tutorial level to understand basic controls, launch the player into the tutorial first and present UI that lets them know your game automatically jumps into the challenge afterward.
-![A diagram of a challenge card, with callouts indicating the challenge title, artwork, and number of players, and the system-provided gradient at the bottom of the card.](https://docs-assets.developer.apple.com/published/73d82f1a3511b11cab8ffb1d3026283d/games-challenge-anatomy%402x.png)
-**Create high-quality artwork that encourages players to engage with your challenges.** The system shows your challenge’s artwork in the Game Overlay, Games app, and in the preview of an invitation link. Avoid placing the primary content of your artwork in an area where the challenge’s title and description might cover it. If you need to use text in your challenge image, provide the appropriate localized versions through App Store Connect or Xcode. Use the following specifications to create challenge artwork.
-![A diagram of the layout for a challenge image, with callouts indicating the image size and cropped area.](https://docs-assets.developer.apple.com/published/3f26192095237c3c95276f37dd349ab6/games-challenge-image-specs%402x.png)
-Attribute| Value
----|---
-Format| JPEG, JPG, or PNG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-Image size| 1920x1080 pt (3840x2160 px @2x)
-Cropped area| 1465x767 pt (2930x1534 px @2x)
-## [Multiplayer activities](https://developer.apple.com/design/human-interface-guidelines/game-center#Multiplayer-activities)
-Game Center supports both real-time and turn-based multiplayer activities that make it easy to connect players with friends or other players. Players can access multiplayer gameplay through party codes, the Game Overlay, the dashboard, or in the Games app. For developer documentation, see [Creating activities for your game](https://developer.apple.com/documentation/GameKit/creating-activities-for-your-game).
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the Multiplayer levels overview screen.](https://docs-assets.developer.apple.com/published/f89b2ebd744907258cc4543688d5d011/games-multiplayer-overlay%402x.png)
-Multiplayer levels overview
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the detail view of a single multiplayer level.](https://docs-assets.developer.apple.com/published/b96755c00a2049def7aa3ce15c11c544/games-multiplayer-overlay-detail%402x.png)
-Multiplayer level detail
-**Use party codes to invite players to multiplayer activities.** Game Center party codes are a great way to coordinate real-time multiplayer sessions whether you use Game Center matchmaking and networking facilities or provide your own. Game Center generates alpha-numeric party codes that are typically eight characters long, such as “2MP4-9CMF.” When integrating party codes into your multiplayer games, consider the following guidelines for the best player experience:
-  * Allow players to join gameplay late, leave early, and return later.
-  * Provide a way for players to view the current party code in your game.
-  * Allow players to enter a party code manually.
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the in-game UI for setting up or joining a multiplayer activity using a custom code.](https://docs-assets.developer.apple.com/published/21aa655690fc4f5ec113e47e587774ab/games-multiplayer-custom-code%402x.png)
-**Support multiplayer activities through in-game UI.** The Game Overlay and Game Center dashboard help players find other people for a multiplayer match without leaving your game. Game Center’s default multiplayer interface lets a player invite nearby or recent players, Game Center friends, and contacts. You can also choose to present multiplayer functionality within your custom UI. For developer guidance, see [Finding multiple players for a game](https://developer.apple.com/documentation/GameKit/finding-multiple-players-for-a-game).
-![An iPhone screenshot of the game The Coast with the Game Overlay open, showing the in-game UI starting a multiplayer activity.](https://docs-assets.developer.apple.com/published/1b1d8dd189678fda25a18976d990b485/games-multiplayer-in-game-ui%402x.png)
-**Provide engaging activity artwork.** Players see the preview image for a multiplayer activity throughout the system, such as in a party code, the Games app, or in-game UI. Use the following specifications to create your artwork.
-![A diagram of a multiplayer activity card, with callouts indicating the activity title, artwork, and number of players, and the system-provided gradient at the bottom of the card.](https://docs-assets.developer.apple.com/published/8f8b825cdf198a9194e816edefef3c45/games-multiplayer-anatomy%402x.png)
-![A diagram of the layout for a multiplayer activity image, with callouts indicating the image size and cropped area.](https://docs-assets.developer.apple.com/published/3f26192095237c3c95276f37dd349ab6/games-multiplayer-image-specs%402x.png)
-Attribute| Value
----|---
-Format| JPEG, JPG, or PNG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-Image size| 1920x1080 pt (3840x2160 px @2x)
-Cropped area| 1465x767 pt (2930x1534 px @2x)
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/game-center#Platform-considerations)
- _No additional considerations for iOS, iPadOS, macOS, or visionOS._
-### [tvOS](https://developer.apple.com/design/human-interface-guidelines/game-center#tvOS)
-**Display an optional image at the top of the dashboard.** In tvOS, you can add an additional piece of artwork to the dashboard to highlight your game’s aesthetic. Use a simple, easily recognizable image that looks great at a distance. Consider using your game’s logo or word mark; however, don’t use your app icon for this image. Use the following specifications to create a dashboard image.
-![A diagram of the layout for a tvOS dashboard image, with a callout indicating the image size.](https://docs-assets.developer.apple.com/published/438f3caaa842926ba5a0f54470c64373/tvos-dashboard-image%402x.png)
-Attribute| Value
----|---
-Image size| 600x180 pt (1200x360 px @2x)
-Format| PNG, TIF, or JPG
-Color space| sRGB or P3
-Resolution| 72 DPI (minimum)
-### [watchOS](https://developer.apple.com/design/human-interface-guidelines/game-center#watchOS)
-**Be aware of Game Center support on watchOS.** While GameKit features and API are available for watchOS games, keep in mind that there’s no system-supported Game Center UI that you can invoke on watchOS. Instead, Game Center content for watchOS games appears on a connected iPhone.
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/game-center#Resources)
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/game-center#Related)
-[Designing for games](https://developer.apple.com/design/human-interface-guidelines/designing-for-games)
-[Game controls](https://developer.apple.com/design/human-interface-guidelines/game-controls)
-[Apple Design Resources](https://developer.apple.com/design/resources/#technologies)
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/game-center#Developer-documentation)
-[GameKit](https://developer.apple.com/documentation/GameKit)
-[Creating activities for your game](https://developer.apple.com/documentation/GameKit/creating-activities-for-your-game)
-[Creating engaging challenges from leaderboards](https://developer.apple.com/documentation/GameKit/creating-engaging-challenges-from-leaderboards)
-[Create games for Apple platforms](https://developer.apple.com/games/)
-[Game Porting Toolkit](https://developer.apple.com/games/game-porting-toolkit/)
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/game-center#Videos)
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/0BEC1E9E-5221-48F9-853B-BEDA2BE23D63/9892_wide_250x141_1x.jpg) Get started with Game Center ](https://developer.apple.com/videos/play/wwdc2025/214)
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/0C96EE37-E8A0-46DB-88B3-3BF6C3F633DD/9893_wide_250x141_1x.jpg) Engage players with the Apple Games app ](https://developer.apple.com/videos/play/wwdc2025/215)
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/game-center#Change-log)
-Date| Changes
----|---
-June 9, 2025| Added guidance for new challenges and multiplayer activities, and considerations for the Apple Games app and Game Overlay. Updated guidance and specifications for activity preview images.
-February 2, 2024| Added links to developer guidance on using the access point and dashboard in a visionOS game.
-September 12, 2023| Added artwork for the iOS achievement layout.
-May 2, 2023| Consolidated guidance into one page.

package/templates/vault/hig-technologies/references/generative-ai.md DELETED Viewed

@@ -1,110 +0,0 @@
----
-title: "Generative AI | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/generative-ai
-# Generative AI
-Generative AI empowers you to enhance your app or game with dynamic content and offer intelligent features that unlock new levels of creativity, connection, and productivity.
-![A sketch of a pencil surrounded by sparkly stars, suggesting generative intelligence. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/5b2d1dc127432336c055e1a7ebf09a30/technologies-generative-ai-intro%402x.png)
-Generative artificial intelligence uses [machine learning](https://developer.apple.com/design/human-interface-guidelines/machine-learning) models to create and transform text, images, and other content. Use it to offer novel, delightful features that help people express themselves creatively, communicate effectively, and complete tasks more easily. For instance, generative AI can enable people to edit text, create imaginative stories and images, or interact with a character in a game that uses AI-generated dialog.
-## [Best practices](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Best-practices)
-**Design your experience responsibly.** Responsible AI is the intentional design and development of AI features that considers their direct and indirect impacts on people, systems, and society. With generative AI, it’s often easy to quickly prototype an exciting new feature for your app, yet challenging to create a robust experience that works in all real-world situations. Unlike classic programming, small changes to inputs (or even the same input, when given multiple times) often produce very different outcomes with generative AI. You also can’t always anticipate what requests people will make and how the AI will respond. Orient your design process around crafting AI experiences that are inclusive, designed with care, and protect privacy.
-**Keep people in control.** While AI can manipulate and create content, respect people’s agency and ensure they remain in charge of decision making and the overall experience. Honor their requests when in scope and the expected output is clear, and handle sensitive content carefully. Give them the ability to dismiss new content they don’t want, and revert or retry content transformations or other actions they don’t agree with. Clearly identify when and where you use AI.
-**Ensure an inclusive experience for all.** AI models learn from data and tend to favor the most common information. This may lead to harmful, unintended biases and stereotypes. Take extra care when designing your AI feature to consider how assumptions and personal attributes might impact the feature you have in mind. For example, if you generate images or descriptions of people, ask people to provide the information needed for the feature to work well rather than solely inferring personal or cultural characteristics. Seek clarity before making assumptions that may lead to common stereotypes, such as about gender identities or relationship types. Test your feature across a diverse set of people to identify and correct stereotypes, and ensure inclusive results. For guidance, see [Inclusion](https://developer.apple.com/design/human-interface-guidelines/inclusion) and [Accessibility](https://developer.apple.com/design/human-interface-guidelines/accessibility).
-**Design engaging and useful generative features.** Generative AI is a powerful tool, but it’s not the right solution for every situation. Offer generative features when and where they provide clear and specific value, like time savings, improved communication, or enhanced creativity.
-**Ensure a great experience even when generative features aren’t available or people opt not to use them.** In some cases, generative AI may be essential to an experience, and there’s no reasonable non-AI substitute. In other cases, AI may play a complementary role that enhances your app’s core functionality, but isn’t critical for people achieving their goals. For example, Genmoji offers a fun way to create new, original emoji, but people can still use regular emoji too. The Apple Intelligence summarization feature makes catching up with notifications faster, but people can still read notifications without it. When possible, consider offering a non-AI fallback so people can always enjoy your app or game.
-## [Transparency](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Transparency)
-**Communicate where your app uses AI.** Letting people know when and where your app uses AI sets expectations and gives people the opportunity to knowingly choose to use an AI-powered feature. Never trick someone into thinking they’re interacting with or viewing content authored by a human if they’re actually interacting with AI. Ensure your approach to disclosure aligns with any regulations in the regions where you offer your app.
-**Set clear expectations about what your AI-powered feature can and can’t do.** Clarifying your experience’s capabilities and limitations helps people establish a mental model of your feature. For example, when you introduce a feature, you might offer a brief tutorial. For open-ended features like a search bar or generation prompt, consider offering curated suggestions that make it easy to get started. If your feature has known limitations, let people know up front, show them how to get good results, and explain why when inferior results occur. For guidance, see [Limitations](https://developer.apple.com/design/human-interface-guidelines/machine-learning#Limitations).
-## [Privacy](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Privacy)
-**Prefer on-device processing.** Depending on your needs, you may be able to get great responses using on-device models, which prevent people’s information from leaving the device. For example, you may choose to use the on-device models available through the Apple Foundation Models framework. On-device models may also respond quicker than server-based models, and are available even when the device is offline. Server-based models are usually good options in situations that need larger, powerful models that require more memory and power than is typically available on a person’s device. Always consider privacy and user experience tradeoffs when selecting a model type. If you’re using server-based processing, process as much information as you can locally first and minimize what’s shared. Make sure people know if their information may be sent to a server, can see what’s being shared, and understand what data may be stored off-device or even used for training.
-**Ask permission before using personal information and usage data.** Some interactions with an AI model may involve sensitive information, like personal details, messages, photos, and feature usage information. After obtaining permission, use the minimum data you need and always offer a clear way to opt out of its use. If you need sensitive data for model improvement or storage, get explicit permission and handle it with care. If you share data with third parties, understand their approach to privacy. Be aware that model outputs can inadvertently contain sensitive information. Note that [apps for kids](https://developer.apple.com/app-store/kids-apps/) have stricter rules and laws around what data you can use. For guidance, see [Requesting permission](https://developer.apple.com/design/human-interface-guidelines/privacy#Requesting-permission).
-**Clearly disclose how your app and its model use and store personal information.** People are more likely to be comfortable sharing data when they understand how it’s used. Empower people to make an informed decision about what data they share with your AI model. When asking for permission to use someone’s information, explain the benefits in a way that’s concise, specific, and easy to understand. Articulate whether your model uses personal information for training and improvement.
-## [Models and datasets](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Models-and-datasets)
-**Thoughtfully evaluate model capabilities.** There are different types of generative models, some of which possess general knowledge, while others are trained for specific tasks. It’s important to understand the capabilities of any model you consider. As early as you can, get a hands-on look at the models and data available to help orient your design. Keep in mind that some model types may be unavailable to people in certain situations due to factors like device compatibility, network access, and battery level. For example, the [Foundation Models](https://developer.apple.com/documentation/FoundationModels) framework requires a compatible device with Apple Intelligence turned on.
-**Be intentional when choosing or creating a dataset.** Whether you’re training a model from scratch or customizing an existing model, the data you choose greatly impacts the model’s behavior. When you teach and evaluate your AI model, choose datasets that include a diverse range of subject matter representations. Learn where your data comes from and how it was gathered. Ensure you have relevant licenses for all data you don’t personally own, and offer appropriate choices when using people’s data. Most datasets gathered from the real world are imperfect, so allow time for testing and evaluation to proactively mitigate bias and misinformation that a model might learn and replicate.
-## [Inputs](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Inputs)
-**Guide people on how to use your generative feature.** Consider how to steer and educate people toward producing great results. One technique is to offer diverse, predefined example inputs that hint at what’s possible for a feature.
-**Raise awareness about and minimize the chance of hallucinations.** When a generative model is unsure how to respond to a request, it may produce content that seems plausible but is made up. These hallucinations can misinform people because the model may convincingly present the information as factual, even when it’s not. Generative models sometimes get details wrong, like dates of important events or information about people, so it’s important to clearly communicate that AI-generated content may contain errors. You can minimize the chance of hallucinations and limit their impact by carefully scoping what you ask a model to generate. Avoid requesting factual information unless you’re confident the model has access to verified and up-to-date information for the task. Avoid using AI-generated content in situations where a possible hallucination could misinform and harm someone.
-**Consider consequences and get permission before performing destructive or potentially problematic tasks.** Before performing a task, consider whether a mistake or the inability to reverse the action might cause more work or stress for people. Avoid automating destructive actions, like deleting photos, and actions that are hard to undo, like making a purchase on a person’s behalf. Generally, ask for confirmation before performing a significant action on someone’s behalf. Keep in mind that certain situations may be prohibited or have extra rules. Review and adhere to model-specific usage policies, as well as government and regulatory AI policy as it applies to each locale in which the generative features will be available.
-## [Outputs](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Outputs)
-**Help people improve requests when blocked or undesirable results occur.** Minimize scoped or blocked output by coaching people how to be more successful next time. For example, if prompted to generate harmful content, Image Playground says that it’s “Unable to use that description.” When possible, consider offering example requests that might lead to better results.
-**Reduce unexpected and harmful outcomes with thoughtful design and thorough testing.** People generally use apps with good intentions, but harmful outcomes can still arise from both accidental and purposeful misuse, and when responding to potentially sensitive topics. It may not be possible to mitigate every harmful scenario, but taking a proactive approach to identify risks, devise policies to address them, and evaluate features can help minimize the chance of misuse and harm. Consider ways people might interact with your feature and test those scenarios. Challenge your policies and expected use cases. See what happens when requests are out-of-scope, unrelated to the app experience you designed, and not well-represented by the model’s training data. Try requests that are poorly phrased, vague, or ambiguous; include personal, sensitive, or controversial topics; and encourage harmful or incorrect results. Use what you learn to improve your model, inform prevention, and respond thoughtfully.
-**Strive to avoid replicating copyrighted content.** Large AI models are trained using vast datasets from the internet and other sources. This means most generative models are familiar with and can unintentionally produce content similar to published work, including copyrighted content. You can reduce the likelihood of copyright infringement by building upon existing models that already protect against this, and by carefully curating inputs. For example, you might let people choose from a set of pre-approved prompts. You could also explicitly tell the model to avoid mimicking certain content or styles.
-**Factor processing time into your design.** _Latency_ is how much time it takes for a model to produce an output. Non-generative models, such as [people tracking in ARKit](https://developer.apple.com/documentation/arkit/capturing-body-motion-in-3d) and the [Vision](https://developer.apple.com/documentation/Vision) machine learning framework, typically have low latency and are suitable to run in real-time on camera feeds. Generative models typically take longer to produce a result, so design a loading experience or generate in the background while a person uses another part of the app. For guidance, see [Loading](https://developer.apple.com/design/human-interface-guidelines/loading).
-**Consider offering alternate versions of results.** Depending on the design of your feature, it might work best to present a single result or multiple meaningfully different results from which people can choose. Offering people a choice can give them a greater sense of control and help bridge the gap between the model’s interpretation and what someone actually wants. For example, Image Playground can generate multiple images that represent a person, allowing someone to pick the one they prefer. For guidance, see [Multiple options](https://developer.apple.com/design/human-interface-guidelines/machine-learning#Multiple-options).
-## [Continuous improvement](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Continuous-improvement)
-**Consider ways to improve your model over time.** You may want to update your model to adapt to people’s behavior, respond to feedback, include new data, and leverage enhanced capabilities. You can make some improvements, such as updating a list of blocked words, frequently and independent of the app development cycle, and you can plan significant improvements and new features around regular app updates. Plan for fine-tuning, retesting, and prompt engineering when updating to a newer, more capable base model. If you train your own model, retrain with additional data and fine-tune to improve performance. Thoroughly test and refine all model updates to identify and correct unexpected behavior.
-**Let people share feedback on outputs.** Feedback can help you identify and respond to unexpected outcomes and new potential issues that arise despite thorough testing. Feedback also gives people a way to celebrate what they like best about your AI experience and report concerns when outputs don’t match their expectations. Establish trust by taking feedback seriously and resolving issues quickly. Always make providing feedback voluntary. Respect people’s time by placing a feedback affordance in a clear location that doesn’t interrupt the experience. Consider offering a quick and easy way to give positive and negative feedback, like simple thumbs-up and thumbs-down buttons. You might also offer a way to share detailed feedback for complicated issues. For guidance, see [Explicit feedback](https://developer.apple.com/design/human-interface-guidelines/machine-learning#Explicit-feedback) and [Implicit feedback](https://developer.apple.com/design/human-interface-guidelines/machine-learning#Implicit-feedback).
-**Design flexible, adaptable features.** Generative AI is a rapidly advancing technology, and models and their resource needs are constantly evolving. Consider ways your app or game can adapt as capabilities and models improve. For example, you may want to separate your model from your user experience so you can swap out the model for other models over time. Lay a foundation that allows for future adjustments like this, while still offering the same great user experience.
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Platform-considerations)
- _No additional considerations for iOS, iPadOS, macOS, tvOS, visionOS, or watchOS._
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Resources)
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Related)
-[Machine learning](https://developer.apple.com/design/human-interface-guidelines/machine-learning)
-[Inclusion](https://developer.apple.com/design/human-interface-guidelines/inclusion)
-[Accessibility](https://developer.apple.com/design/human-interface-guidelines/accessibility)
-[Privacy](https://developer.apple.com/design/human-interface-guidelines/privacy)
-[Loading](https://developer.apple.com/design/human-interface-guidelines/loading)
-[Acceptable Use Requirements for the Foundation Models Framework](https://developer.apple.com/apple-intelligence/acceptable-use-requirements-for-the-foundation-models-framework)
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Videos)
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/6F92E66E-52A5-4289-9F76-A3E6983F9250/10049_wide_250x141_1x.jpg) Explore prompt design & safety for on-device foundation models ](https://developer.apple.com/videos/play/wwdc2025/248)
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/51620FBA-75C7-46B5-BCBA-800F38AEE3A5/10048_wide_250x141_1x.jpg) Discover machine learning & AI frameworks on Apple platforms ](https://developer.apple.com/videos/play/wwdc2025/360)
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Developer-documentation)
-[Apple Intelligence and machine learning](https://developer.apple.com/documentation/TechnologyOverviews/ai-machine-learning)
-[Foundation Models](https://developer.apple.com/documentation/FoundationModels)
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/generative-ai#Change-log)
-Date| Changes
----|---
-June 9, 2025| New page.