Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rustunit/bevy_ios_gamecenter
Bevy Plugin and Swift Package to provide access to iOS native Gamecenter from inside Bevy
https://github.com/rustunit/bevy_ios_gamecenter
bevy-engine gamedev ios mobile rust
Last synced: about 2 months ago
JSON representation
Bevy Plugin and Swift Package to provide access to iOS native Gamecenter from inside Bevy
- Host: GitHub
- URL: https://github.com/rustunit/bevy_ios_gamecenter
- Owner: rustunit
- License: apache-2.0
- Created: 2024-04-30T17:16:56.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-05T09:26:25.000Z (about 2 months ago)
- Last Synced: 2024-12-10T11:53:48.319Z (about 2 months ago)
- Topics: bevy-engine, gamedev, ios, mobile, rust
- Language: Swift
- Homepage: https://crates.io/crates/bevy_ios_gamecenter
- Size: 10.2 MB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# bevy_ios_gamecenter
[![crates.io][sh_crates]][lk_crates]
[![docs.rs][sh_docs]][lk_docs]
[![discord][sh_discord]][lk_discord]
[sh_crates]: https://img.shields.io/crates/v/bevy_ios_gamecenter.svg
[lk_crates]: https://crates.io/crates/bevy_ios_gamecenter
[sh_docs]: https://img.shields.io/docsrs/bevy_ios_gamecenter
[lk_docs]: https://docs.rs/bevy_ios_iap/latest/bevy_ios_gamecenter/
[sh_discord]: https://img.shields.io/discord/1176858176897953872?label=discord&color=5561E6
[lk_discord]: https://discord.gg/rQNeEnMhus
Bevy Plugin and Swift Package to provide access to iOS native GameKit (Gamecenter) from inside Bevy Apps
It uses [Swift-Bridge](https://github.com/chinedufn/swift-bridge) to auto-generate the glue code and transport data types.
> Demo from our game using this crate: [zoolitaire.com](https://zoolitaire.com)
## Features
* authentication
* save games (based on iCloud)
* achievements
* leaderboards
## TODOs
* challenges, matchmaking
## Instructions
1. Add to XCode: Add SPM (Swift Package Manager) dependency
2. Add Rust dependency
3. Setup Plugin
### 1. Add to XCode
* Add `GameKit` framework:
* Go to `File` -> `Add Package Dependencies` and paste `https://github.com/rustunit/bevy_ios_gamecenter.git` into the search bar on the top right:
**Note:**
The rust crate used must be exactly the same version as the Swift Package.
I suggest using a specific version (like `0.2.0` in the screenshot) to make sure to always use binary matching versions!
### 2. Add Rust dependency
```
cargo add bevy_ios_gamecenter
```
or
```toml
# always pin to the same exact version you also of the Swift package
bevy_ios_gamecenter = { version = "=0.3.0" }
```
### 3. Setup Plugin
Initialize Bevy Plugin:
```rust
// init right on startup
app.add_plugins(IosGamecenterPlugin::new(true));
```
```rust
fn bevy_system(mut gc: BevyIosGamecenter) {
gc.authenticate()
.on_response(|trigger: Trigger| match &trigger.event().0 {
IosGCAuthResult::IsAuthenticated => {},
IosGCAuthResult::LoginPresented => {},
IosGCAuthResult::Error(e) => error!("auth error: {e}"),
});
// here we request the player info type for the username and more
// Note: all requests via `gc` of type `BevyIosGamecenter`
// allow to attach an observer to listen to the response:
gc.request_player().on_response(on_player_response);
// update achievement progress, 100 % will complete it
gc.achievement_progress("id".into(),100.);
// reset all achievements
gc.achievements_reset();
// save a game state as a byte slice
gc.save_game("test".into(), vec![1, 2, 3].as_slice());
// request list of `IosGCSaveGame`
gc.fetch_save_games().on_response(on_response);
// based on result of above `fetch_save_games` request
let save_game = IosGCSaveGame {..}
gc.load_game(save_game);
// update leaderboard score
gc.leaderboards_score(
"raking id".into(),
// score
1,
// context
2,
);
// open gamecenter view (leaderboard)
gc.trigger_view(view_states::LEADERBOARDS);
}
```
## Our Other Crates
- [bevy_debug_log](https://github.com/rustunit/bevy_debug_log)
- [bevy_device_lang](https://github.com/rustunit/bevy_device_lang)
- [bevy_web_popups](https://github.com/rustunit/bevy_web_popups)
- [bevy_libgdx_atlas](https://github.com/rustunit/bevy_libgdx_atlas)
- [bevy_ios_review](https://github.com/rustunit/bevy_ios_review)
- [bevy_ios_alerts](https://github.com/rustunit/bevy_ios_alerts)
- [bevy_ios_iap](https://github.com/rustunit/bevy_ios_iap)
- [bevy_ios_notifications](https://github.com/rustunit/bevy_ios_notifications)
- [bevy_ios_impact](https://github.com/rustunit/bevy_ios_impact)
## Bevy version support
|bevy|bevy\_ios\_gamecenter|
|----|---|
|0.15|0.3,main|
|0.14|0.2|
|0.13|0.1|
# License
All code in this repository is dual-licensed under either:
- MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
at your option. This means you can select the license you prefer.
## Your contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.