com.gluonhq:charm-down-plugin-runtime-args

Common API to for injecting runtime arguments into Charm Down applications, and listening for these arguments.


License
GPL-3.0

Documentation

Gluon Charm Down

Gluon Charm Down is the component that addresses the integration with low-level platform APIs in an end-to-end Java Mobile solution.

Using Charm Down, you write code that access device and hardware features using a uniform, platform-independent API. At runtime, the appropriate implementation (charm-down-desktop, charm-down-android, charm-down-ios) makes sure the platform specific code is used to deliver the functionality.

Charm Down is open source, and it is freely licensed under the GPL license. Gluon can provide custom consultancy and training, commercial licenses, and open source commercial support, including daily and monthly releases.

Getting started

The best way to get started with Gluon Charm Down is using the Gluon plugin for your IDE and creating a Gluon Mobile project.

The Gluon samples are a good way to find out how Charm Down is used.

See the documentation and the Javadoc.

The list of available services at Charm Down can be found here.

Issues and Contributions

Issues can be reported to the Issue tracker

Contributions can be submitted via Pull requests

Building Charm Down

Requisites

Gluon Charm Down is frequently released, and this is only required in case you want to fork and build your local version of Charm Down.

These are the requisites:

  • A recent version of JDK 8
  • Gradle 2.2 or superior.

To build the Android Services:

  • Android SDK: the android sdk must be downloaded. The required Android platform is android-25.
  • ANDROID_HOME has to be defined as an environment variable, typically by adding it as a gradle property to ~/.gradle/gradle.properties.
  • Extras/Android Support Repository and Extras/Google Repository that can be installed with the Android SDK Manager.

To build the iOS Services:

  • A Mac with with MacOS X 10.11.5 or superior
  • XCode 8.x or superior

How to build and install Charm Down

To build the Charm Down services, on the project's root, run:

./gradlew clean build

If you want to install them, run:

./gradlew clean install

When the process finishes successfully, the different services can be added to a Gluon Mobile project by including mavenLocal() in the list of repositories.