README.md

jme-alloc project

A direct dynamic memory allocation api for jMonkeyEngine lwjgl-2 and android games.

To build locally, use:

┌─[pavl-machine@pavl-machine]─[/home/twisted/GradleProjects/jme-alloc]
└──╼ $./gradlew clean && 
      ./gradlew :jme3-alloc:compileJava && \
      ./gradlew :jme3-alloc-native:compileX86_64 && \
      ./gradlew :jme3-alloc-native:copyNatives && \
      ./gradlew :jme3-alloc:assemble

To test locally, use:

┌─[pavl-machine@pavl-machine]─[/home/twisted/GradleProjects/jme-alloc]
└──╼ $./gradlew :jme3-alloc-examples:run

For more about, building, testing and contributing, visit:

CONTRIBUTING.md

For quick use:

/* select your platform here */
final String platform = "desktop"
final String binaryType = "debug"
final String version = "1.0.0-pre-gamma-1"

repositories {
    mavenCentral()
}
dependencies {
    implementation "io.github.software-hardware-codesign:jme3-alloc-${platform}-${binaryType}:${version}"
}

API:

• Native extraction according to the system variant (OS + architecture) using com.jme3.alloc.util.loader.NativeBinaryLoader.
• Dynamic linking code.
• Base Allocator/De-allocator API: com.jme3.alloc.util.NativeBufferUtils and com.jme3.alloc.NativeBufferAllocator.
• Native logging api with output to an external log file stream.
• Garbage collectible buffers API.

Build-system:

• Separate jvm and native modules.
• Generating header files for java sources.
• Packaging java and natives in a jar.
• Github-actions.
• Handling different variants build (linux-x86-64).
• Handling different variants build (linux-x86).
• Handling different variants build (windows-x86-64).
• Handling different variants build (macos-x86-64).
• Handling different android build architectures (aarch-64, arm32, intel-x86-64, intel-x86).
• Handling different variants build (windows-x86).
• Handling different variants build (macos-x86).

Documentation:

• JavaDocs.
• NativeDocs.
• Running Examples.
• Contribution guide.
• Documentation website for different releases (not only the latest).