#ios #swift #bevy #bevy-plugin #mobile #gamedev

bevy_ios_iap

Bevy Plugin and Swift Package to provide access to iOS native StoreKit2 from inside Bevy Apps

5 releases

0.2.1 May 12, 2024
0.2.0 May 9, 2024
0.1.2 May 6, 2024
0.1.1 May 5, 2024
0.1.0 May 2, 2024

#229 in Game dev

Download history 229/week @ 2024-04-29 573/week @ 2024-05-06 55/week @ 2024-05-13 97/week @ 2024-05-20 1/week @ 2024-05-27 73/week @ 2024-06-03 14/week @ 2024-06-10

187 downloads per month

MIT license

28KB
460 lines

bevy_ios_iap

crates.io docs.rs discord

Provides access to iOS native StoreKit2 Swift API from inside Bevy Apps. It uses Swift-Bridge to auto-generate the glue code and transport datatypes.

demo

See also bevy_ios_gamecenter, bevy_ios_notifications, bevy_ios_alerts, bevy_ios_review & bevy_ios_impact

Features

  • fetch products
  • purchase products
  • listen to changes in transaction states
  • fetch list of all transactions (to restore old purchases of non-consumables)

Notes

  • does not return locally un-signed/un-verified transactions

Todo

  • support subscription product type
  • remaining error handling in: ios_iap_transactions_all and ios_iap_products
  • allow access to signature for remote verification
  • support offers
  • support family sharing
  • transaction revocation reason

Instructions

  1. Add to XCode: Add SPM (Swift Package Manager) dependency
  2. Add Rust dependency
  3. Setup Plugin

1. Add to XCode

  • Add StoreKit framework: gamekit

  • Go to File -> Add Package Dependencies and paste https://github.com/rustunit/bevy_ios_iap.git into the search bar on the top right: xcode

  • Don't forget to configure your purchases like for any other iOS app, this guide will not focus on that, as it is the same no matter what engine you use. this guide focuses on setting things up in a bevy project.

Note: The rust crate used must be exactly the same version as the Swift Package (for binary compatibility reasons). 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_iap

or

# always pin to the same exact version you also of the Swift package
bevy_ios_iap = { version = "=0.2.1" }

3. Setup Plugin

Initialize Bevy Plugin:

// request initialisation right on startup
app.add_plugins(IosIapPlugin::new(true));
fn bevy_system() {
    // If you set the plugin to manual init, this will register the 
    // TranscactionObserver to listen to updates to any Transactions and trigger
    // `IosIapEvents::Transaction` accordingly.
    // Note: this will require the user to be logged in into their apple-id and popup a login dialog if not
    bevy_ios_iap::init();

    // request product details, product IDs have to be explicitly provided
    // this will lead to a response: `IosIapEvents::Products`
    bevy_ios_iap::get_products(vec!["com.rustunit.zoolitaire.levelunlock".into()]);

    // trigger a product purchase for a specific product ID
    // this will lead to a response: `IosIapEvents::Purchase`
    bevy_ios_iap::purchase("com.rustunit.zoolitaire.levelunlock".into());

    // request to restore active subscriptions and non-consumables
    // this will lead to a response: `IosIapEvents::CurrentEntitlements`
    bevy_ios_iap::current_entitlements();

    // marks a transaction as finished after the product was provided to the customer.
    // if this is not called a transaction will keep being triggered automatically on 
    // app start as iOS wants us to be sure we granted the user the purchased good.
    // this will lead to a response: `IosIapEvents::TransactionFinished`
    bevy_ios_iap::finish_transaction(42);
}

Process Response Events from iOS back to us in Rust:

fn process_iap_events(
    mut events: EventReader<IosIapEvents>,
) {
    for e in events.read() {
        match e {
            IosIapEvents::Products(_) => todo!(),
            IosIapEvents::Purchase(_) => todo!(),
            IosIapEvents::Transaction(_) => todo!(),
            IosIapEvents::TransactionFinished(_) => todo!(),
            IosIapEvents::AllTransactions(_) => todo!(),
            IosIapEvents::CurrentEntitlements(_) => todo!(),
        }
    }
}

License

All code in this repository is dual-licensed under either:

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.

Dependencies

~23–51MB
~764K SLoC