A VR utilities library for JMonkeyEngine using OpenXR.
To successfully use Tamarin you should typically have at least the following dependencies
implementation "com.onemillionworlds:tamarin:$tamarin_version"
implementation "org.jmonkeyengine:jme3-core:$jmonkeyengine_version"
implementation "org.jmonkeyengine:jme3-lwjgl3:$jmonkeyengine_version"
implementation "org.jmonkeyengine:jme3-desktop:$jmonkeyengine_version"
Optionally you can also have
implementation "com.simsilica:lemur:$lemur_version"
This library uses simple java.util.Logger for maximum compatibility. Bind that to your preferred logging library.
See https://github.com/oneMillionWorlds/Tamarin/wiki for documentation
See https://github.com/oneMillionWorlds/TamarinTestBed for examples
Grabbing and menu picking both use geometry picking. With simple scenes performance may be fine picking against the root node. However with complex scenes this may become slow, creating a node that contains all the grabbables (or all the UI interactables) may give better performance
This project is licensed under the BSD-3 license, meaning it can be used in a commercial project free of charge with no need to provide attribution. That said if you want to mention that Tamarin is used in your project that would be very welcome.
The hand models are similarly included under that license; if you want to start with Tamarin models but tweak them the blenderFiles may be useful. There is no requirement to distribute any updates to hand models, but if you want to contribute improved models that is also very welcome.
Standard Java coding conventions (try to match existing style).
British English; "Centre", "Colour" etc
To sign jars for maven central appropriate details will need to be in C:\Users{user}.gradle\gradle.properties. Will need
signing.keyId=keyId
signing.password=password
signing.secretKeyRingFile=C:/Users/{user}/AppData/Roaming/gnupg/pubring.kbx
ossrhUsername=your-jira-id
ossrhPassword=your-jira-password
Note that the keyId is just the last 8 characters of the long id, and the secretRing must be explicitly exported gpg --export-secret-keys -o secring.gpg
Project is provisioned on https://s01.oss.sonatype.org/
Deploy to sonatype via pipeline by:
- Running in gitlab the publish job
- Go to https://s01.oss.sonatype.org/ and log in
- Go to the staging repository and select the repository
- If all looks well "close" the repository and then Release it
- Tag the release
Deploy to sonatype manually by:
- Editing the build.gradle file to have a non snapshot version
- Running
./gradlew publishMavenJavaPublicationToSonaTypeRepository(see https://docs.gradle.org/current/userguide/publishing_maven.html) - Go to https://s01.oss.sonatype.org/ and log in as user oneMillionWorlds
- Go to the staging repository and select the repository
- If all looks well "close" the repository and then Release it
- Tag the release
To test a staging build the repository must be in "closed" state, then add the following to the consuming build.gradle
maven {
url "https://s01.oss.sonatype.org/content/repositories/comonemillionworlds-XXXX"
}
Where XXXX is replaced by the specific repository number being used for this version (see https://s01.oss.sonatype.org/#stagingRepositories when logged in).