[](https://github.com/dodorare/crossbow)

September 11, 2022 ยท View on GitHub

CI Info Crate Info Documentation Crossbundle Crate MIT/Apache 2.0 FOSSA Status GitHub Stars

What is Crossbow?

The crossbow project aims to provide a complete toolkit for cross-platform game development in Rust - from project creation to publishing. In addition, the project simplifies the creation, packaging, and signing of Android and iOS applications. We want to make most of our tools - engine agnostic to help rust game developers integrate them into their engines or games.

Why Crossbow?

There are already cargo-apk, cargo-mobile, cargo-xcode, etc. - why do I need another packaging tool?

Project crossbow is not only a packaging tool for Android and iOS - it's cross-platform build tools, plugins, and toolkit for Rust! With crossbundle you can create native .apk/.aab without any Java or setup Gradle project with fancy Crossbow Android plugins (iOS in near future); with crossbundle-tools you can customize and create new commands; with crossbow-android you can write your own Android plugins in Java/Kotlin.

A lot of functionality was inspired by Godot, Xamarin, and cargo-apk.

Design Goals

  • Customizable: Create new commands with available tools.
  • Simple: Easy to install and start hacking but also pretty flexible for strong devs.
  • Flexible: It's possible to build plain .apk/.aab or .app/.ipa; or with help of Gradle/XCode.
  • Rust: Don't leave your Rust code - everything can be configured from Cargo.toml.
  • Plugins: Godot-like plugins for Android (and iOS in future) with Rust wrapper!

Documentation

Now we would recommend you to read crossbow's documentation. Over there you will find how to set up development environment, install needed crates and how to use the tools.

Project structure

Crossbundle crates:

NameDescriptionStatus
crossbundleCommand-line tool for building and running applications.โœ…
crossbundle-toolsToolkit used in crossbundle to build/pack/sign bundles.โœ…

Crossbow Platform crates:

NameDescriptionStatus
crossbow-androidCrossbow Android Platform implementation.๐Ÿ†—
crossbow-iosCrossbow iOS Platform implementation.๐Ÿ› 

Crossbow Plugins:

NameDescriptionStatus
admob-androidGoogle AdMob Plugin for Android.๐Ÿ†—
play-games-servicesGoogle Play Games Services Plugin for Android.๐Ÿ†—
play-billingGoogle Play Billing Plugin for Android.๐Ÿ†—
play-coreGoogle Play Core Plugin for Android.๐Ÿ“

Helper crates:

NameDescriptionStatus
android-tools-rsAndroid-related tools for building and developing application.โœ…
android-manifest-rsAndroidManifest serializer and deserializer for Rust.โœ…
apple-bundle-rsAppleBundleResources serializer and deserializer for Rust.โœ…

โœ… = Works and tested โ€” ๐Ÿ†— = Works but may contain bugs โ€” ๐Ÿ›  = Under development โ€” ๐Ÿ“ = Planned

Special Thanks

Also, this project initially funded by Web3 Foundation Grants Program. Big shout-out to them!

W3F Grants Badge

License

Licensed under either of:

at your option.

FOSSA Status