Skip to content

Latest commit

 

History

History
85 lines (65 loc) · 3.49 KB

README.md

File metadata and controls

85 lines (65 loc) · 3.49 KB
Raw

Libbulletjme Project logo

The LbjExamples Project provides documentation and example applications for the Libbulletjme 3-D physics library.

It contains 3 subprojects:

  1. docs: Antora documentation for Libbulletjme, including the tutorial
  2. apps: Java applications referenced in the tutorial
  3. kotlin-apps: Kotlin translations of certain apps

The applications make use of the SPORT graphics engine, which was formerly a subproject and is now a separate project at GitHub.

Complete source code is provided under a 3-clause BSD license.

How to build and run LbjExamples from source

Initial build

  1. Install a Java Development Kit (JDK), if you don't already have one.
  2. Point the JAVA_HOME environment variable to your JDK installation: (In other words, set it to the path of a directory/folder containing a "bin" that contains a Java executable. That path might look something like "C:\Program Files\Eclipse Adoptium\jdk-17.0.3.7-hotspot" or "/usr/lib/jvm/java-17-openjdk-amd64/" or "/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home" .)
  • using Bash or Zsh: export JAVA_HOME=" path to installation "
  • using Fish: set -g JAVA_HOME " path to installation "
  • using Windows Command Prompt: set JAVA_HOME=" path to installation "
  • using PowerShell: $env:JAVA_HOME = ' path to installation '
  1. Download and extract the LbjExamples source code from GitHub:
  • using Git:
    • git clone https://github.com/stephengold/LbjExamples.git
    • cd LbjExamples
  1. Run the Gradle wrapper:
  • using Bash or Fish or PowerShell or Zsh: ./gradlew build
  • using Windows Command Prompt: .\gradlew build

Tutorials

The tutorial apps all have names starting with "Hello". For instance, the first tutorial app is named "HelloLibbulletjme".

To execute "HelloLibbulletjme":

  • using Bash or Fish or PowerShell or Zsh: ./gradlew :apps:HelloLibbulletjme
  • using Windows Command Prompt: .\gradlew :apps:HelloLibbulletjme

Chooser

A Swing-based chooser application is provided. However, it includes only the graphical apps and doesn't work on macOS yet.

To run the chooser:

  • using Bash or Fish or PowerShell or Zsh: ./gradlew AppChooser
  • using Windows Command Prompt: .\gradlew AppChooser

Cleanup

You can restore the project to a pristine state:

  • using Bash or Fish or PowerShell or Zsh: ./gradlew clean
  • using Windows Command Prompt: .\gradlew clean

Note: these commands will delete any downloaded native libraries.