This project is built on the LibGdx framework and provides the capability to run OIS projects on various platforms. It achieves this by utilizing the OIS core library, which defines an API for seamless execution of different OIS projects along this project.
To streamline deployment, we've developed the OIS deployer Gradle plugin. This plugin leverages the platform's features to facilitate the deployment of OIS projects on specific platforms based on your requirements by using this project.
- Java version
15or a more recent release. - Gradle version
7or a newer version.
The project is not available in Maven central, required to be used locally Install OIS core library:
- Clone the core library
git clone https://github.com/attiasas/open-interactive-simulation-core.git
- Navigate to the cloned directory and publish the library to maven local
./gradlew publishToMavenLocal
Each submodule correspond to a different project that is used to run/deploy to a specific platform. Use the task configured by the project.
When running the gradle commands configure the following environment variables:
| Environment Variable | Description |
|---|---|
| OIS_ENV_DEBUG_MODE | Tell the runner to run on debug mode and not published |
| OIS_ENV_PROJECT_CONFIG_PATH | path to the simulation.ois project configuration file |
| OIS_ENV_PROJECT_JAR_PATH | path to the OIS project Jar location |
| OIS_ENV_PROJECT_ASSETS_DIR | [Optional, default to yhe assets directory] path to your project resource directory |
| OIS_ENV_ANDROID_SDK_PATH | [Optional, default to the value of 'ANDROID_HOME'] path to your Android sdk directory |
When running the gradle commands configure the following environment variables:
| Environment Variable | Description |
|---|---|
| OIS_ENV_PROJECT_NAME | the base name of the generated artifacts |
| OIS_ENV_PROJECT_JAR_PATH | path to the OIS project Jar location |
| OIS_ENV_PROJECT_GROUP | group name of the generated artifacts |
| OIS_ENV_PROJECT_VERSION | version of the generated artifacts |
| OIS_ENV_PROJECT_VERSION_NUM | version number (typically incremented with each release) of the generated artifacts |
The resources needs to be placed at the assets directory at the root project
Create a directory named ois and place the simulation.ois file inside.
Icons may be placed inside an icons directory.
Android Icons may be placed at res directory at android-runner.
We highly recommend running Gradle with the -d
option to get useful and readable debug information if something goes wrong with your build.
Please help us improve the library by reporting any issues you encounter.
We welcome pull requests from the community. To help us improve this project.