Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephengold/lbjexamples
Documentation and example applications for the Libbulletjme physics simulation library
https://github.com/stephengold/lbjexamples
3d-graphics applications bullet-physics java open-source physics physics-3d physics-simulation sample-app tutorial
Last synced: 3 months ago
JSON representation
Documentation and example applications for the Libbulletjme physics simulation library
- Host: GitHub
- URL: https://github.com/stephengold/lbjexamples
- Owner: stephengold
- License: other
- Created: 2022-03-01T23:19:08.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T23:04:04.000Z (9 months ago)
- Last Synced: 2024-05-23T02:38:45.667Z (9 months ago)
- Topics: 3d-graphics, applications, bullet-physics, java, open-source, physics, physics-3d, physics-simulation, sample-app, tutorial
- Language: Java
- Homepage:
- Size: 4.24 MB
- Stars: 11
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[The LbjExamples Project][project] provides
documentation and example applications
for [the Libbulletjme 3-D physics library][libbulletjme].
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][sport],
which was formerly a subproject and
is now a separate project at [GitHub].
Complete source code is provided under
[a 3-clause BSD license][license].
## How to build and run LbjExamples from source
### Initial build
1. Install a [Java Development Kit (JDK)][adoptium],
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* `'`
3. Download and extract the LbjExamples source code from GitHub:
+ using [Git]:
+ `git clone https://github.com/stephengold/LbjExamples.git`
+ `cd LbjExamples`
4. 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.
[adoptium]: https://adoptium.net/releases.html "Adoptium Project"
[antora]: https://antora.org/ "Antora documentation-site generator"
[fish]: https://fishshell.com/ "Fish command-line shell"
[git]: https://git-scm.com "Git"
[github]: https://github.com "GitHub"
[gradle]: https://gradle.org "Gradle Project"
[java]: https://en.wikipedia.org/wiki/Java_(programming_language) "Java programming language"
[kotlin]: https://en.wikipedia.org/wiki/Kotlin_(programming_language) "Kotlin programming language"
[libbulletjme]: https://stephengold.github.io/Libbulletjme/lbj-en/English/overview.html "Libbulletjme Project"
[license]: https://github.com/stephengold/LbjExamples/blob/master/LICENSE "LbjExamples license"
[project]: https://github.com/stephengold/LbjExamples "LbjExamples Project"
[sport]: https://github.com/stephengold/sport "SPORT Project"
[swing]: https://en.wikipedia.org/wiki/Swing_(Java) "Swing toolkit"