https://github.com/jvpichowski/zayes-bullet
Contains a simple example how you can combine native bullet and zay es
https://github.com/jvpichowski/zayes-bullet
bullet bullet-physics jme3 jmonkeyengine3 zayes
Last synced: 7 months ago
JSON representation
Contains a simple example how you can combine native bullet and zay es
- Host: GitHub
- URL: https://github.com/jvpichowski/zayes-bullet
- Owner: jvpichowski
- License: bsd-3-clause
- Created: 2017-02-06T21:47:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-23T09:03:30.000Z (about 8 years ago)
- Last Synced: 2025-01-26T09:29:02.953Z (9 months ago)
- Topics: bullet, bullet-physics, jme3, jmonkeyengine3, zayes
- Language: Java
- Size: 339 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZayES-Bullet
ZayES and Bullet are two key elements of jME3. This library aims to be
a flexible and easy to use adapter between them. Every entity could be
integrated into the physics calculations by only combining physics
components.
## Getting started
The easiest way to get started is to clone this repository
and have a look at the examples in the test folder. You'll
notice the most important aspects.
## Adding ZayEs-Bullet to your project
ZayES-Bullet is released on bintray. Just add the dependency definition
to your build file or download directly the needed jars. There are
javadoc and sources available.
([Direct link to Bintray](https://bintray.com/jvpichowski/jME3-Tools/ZayES-Bullet))
Don't forget to add the needed bintray repository to your repositories:
```
maven { url "https://dl.bintray.com/jvpichowski/jME3-Tools/" }
```
Or you could use 'jitpack.io' to fetch the latest changes (They may be breaking changes). Just use this example 'build.gradle' file:
```
group 'com.jvpichowski'
version '1.0-SNAPSHOT'
apply plugin: 'java'
sourceCompatibility = 1.8
repositories {
jcenter()
maven { url 'https://jitpack.io' }
}
ext.jmeVersion = '3.1.0-stable'
dependencies {
compile "org.jmonkeyengine:jme3-core:$jmeVersion"
compile "org.jmonkeyengine:jme3-desktop:$jmeVersion"
compile "org.jmonkeyengine:jme3-lwjgl:$jmeVersion"
compile "org.jmonkeyengine:jme3-bullet-native:$jmeVersion"
compile "org.jmonkeyengine:jme3-bullet:$jmeVersion"
compile 'com.simsilica:sio2:1.0.3'
compile 'com.simsilica:zay-es:1.2.1'
compile 'com.github.jvpichowski:ZayES-Bullet:master-SNAPSHOT'
testCompile group: 'junit', name: 'junit', version: '4.12'
}
```
## Architecture
ZayES-Bullet consists of two parts. On the one hand there are the
components you need to describe your entity (e.g. mass, shape, ...).
Have a look in the `components` package to discover all of them.
On the other hand there is the BulletSystem which pulls those information,
adds them to the physics simulation and propagates the new state back to
the entity in form of components. Then you could watch for them and
change your game view. The BulletSystem is the complex part and could
be extended in various ways but usually you only have to create it and
call `update()` from time to time to update its state. Don't forget to
destroy it if you don't need it anymore. I have added an `ESBulletState`
Because this library is mostly used by jME3 developers. This states
handles the creation, destruction and update of the BulletSystem for you.
You simple have to attach it to your StateManager. In the constructor
you can specify different threading modes. See the javadoc for more
explanation on them.
## Thread safety
ZayES is by default threadsafe. As a consequence you don't have to worry to much
about thread safety if you only read and add components. But there could
be some pitfalls with the BulletSystem for advanced users because you can
obtain direct access to the Bullet PhysicsSpace (e.g. to register listeners). You have to be aware
that the listeners are called from the physics thread and not from the
render thread. As a consequence you have to enqueue all events.
## Versioning
This library is still in an alpha state. The key features should work but
there has to be more testing. Be aware that the api might change. At the
moment I'm very happy with the core api and it probably won't change anymore.
But be warned that there could still be breaking changes in later releases.
## Road map
The next step will be a good character control. Then I will add more
advanced components like a force field. And I will improve my own debug
view.
## License
ZayES-Bullet is released under the BSD 3-Clause License. If you like it
I would be proud if you show me your work and give credit to me.
## Getting in touch
I have a [thread in the jME3 forum](https://hub.jmonkeyengine.org/t/bullet-zay-es-example/37946)
where I will discuss several aspects. There you have the chance to ask
questions and state your requirements.