jMonkeyEngine-wiki/docs/modules/contributions/pages/contributions.adoc

= Contributions
:revnumber: 2.0
:revdate: 2020/07/11
:url-contribs: https://github.com/jMonkeyEngine-Contributions
:url-core: https://hub.jmonkeyengine.org/badges/103/core-developer
:url-enginelib: https://github.com/jMonkeyEngine/jmonkeyengine/tree/master
:url-forum-user: https://hub.jmonkeyengine.org/u
:url-github: https://github.com
:url-jitpack: https://jitpack.io
:url-mcentral: https://search.maven.org/search?
:url-mirrors: https://github.com/jMonkeyEngine-mirrors

The following list contains additional content for jMonkeyEngine 3 contributed by users. They are, as is the engine itself, open-source - Feel free to download and use them for your projects. :)


[TIP]
====
To install a jMonkeyEngine SDK plugin, go to `menu:Tools[Plugins>Available Plugins]`. +
(Currently only jME 3.0 stable SDK, jME 3.1+ does not yet support plugins)
====


== Libraries with Maven coordinates

JMonkeyEngine projects built using https://gradle.org/[Gradle]
or https://maven.apache.org/[Maven]
can easily incorporate pre-built libraries from public Maven repositories.

"GroupID:ArtifactID" entries link to package information;
follow these links to determine the version ID of the latest release.
"Name" entries link to relevant documentation, if any.

[cols="20,20,15,35,10",grid="none",options="header"]
|===
|Name
|Purpose
|Maintainer(s)
|Maven repository URL +
GroupID:ArtifactID
|Source code

|https://1337atr.weebly.com/jttf.html[jME-TTF]
|Render TrueType fonts
|(none)
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:jme-ttf[com.github.stephengold:jme-ttf]
|{url-github}/ATryder/jME-TTF[GitHub]


|{url-github}/stephengold/Heart#readme[Heart]
|General-purpose toolkit
|{url-forum-user}/sgold[sgold]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:Heart[com.github.stephengold:Heart]
|{url-github}/stephengold/Heart[GitHub]

|{url-github}/stephengold/jme3-utilities#readme[Jme3-utilities-nifty]
|Graphical user interface
|{url-forum-user}/sgold[sgold]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:jme3-utilities-nifty[com.github.stephengold:jme3-utilities-nifty]
|{url-github}/stephengold/jme3-utilities/tree/master/nifty[GitHub]

|{url-github}/stephengold/jme3-utilities#readme[Jme3-utilities-ui]
|Modal hotkeys and help screens
|{url-forum-user}/sgold[sgold]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:jme3-utilities-ui[com.github.stephengold:jme3-utilities-ui]
|{url-github}/stephengold/jme3-utilities/tree/master/ui[GitHub]

|https://stephengold.github.io/Minie/minie/overview.html[Minie]
|3-D physics simulation
|{url-forum-user}/sgold[sgold]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:Minie[com.github.stephengold:Minie]
|{url-github}/stephengold/Minie[GitHub]

|{url-github}/stephengold/SkyControl#readme[SkyControl]
|Sky simulation
|{url-forum-user}/sgold[sgold]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:SkyControl[com.github.stephengold:SkyControl]
|{url-github}/stephengold/SkyControl[GitHub]

|{url-github}/stephengold/Wes#readme[Wes]
|Animation editing and retargeting
|{url-forum-user}/sgold[sgold]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:Wes[com.github.stephengold:Wes]
|{url-github}/stephengold/Wes[GitHub]


|{url-github}/riccardobl/jme3-bullet-vhacd#readme[V-HACD Collision Shape Factory]
|Decompose meshes into convex collision shapes
|{url-forum-user}/RiccardoBlb[RiccardoBlb]
|\https://jitpack.io +
{url-jitpack}/#riccardobl/jme3-bullet-vhacd[com.github.riccardobl:jme3-bullet-vhacd]
|{url-github}/riccardobl/jme3-bullet-vhacd[GitHub]

|{url-github}/riccardobl/jme-igui#readme[jme-IGUI]
|Immediate graphical user interface
|{url-forum-user}/RiccardoBlb[RiccardoBlb]
|\https://jitpack.io +
{url-jitpack}/#riccardobl/jme-igui[com.github.riccardobl:jme-igui]
|{url-github}/riccardobl/jme-igui[GitHub]


| xref:gui/tonegodgui/tonegodgui.adoc[ToneGod GUI]
|Native graphical user interface
|(none)
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:com.github.stephengold%20AND%20a:tonegodgui[com.github.stephengold:tonegodgui]
|{url-github}/stephengold/tonegodgui[GitHub]

|{url-github}/jack-bradshaw/monorepo/tree/main/java/io/jackbradshaw/kmonkey[KMonkey]
|Support for Kotlin Coroutines
|{url-forum-user}/jackbradshaw[jackbradshaw]
|\https://repo1.maven.org/maven2 +
{url-mcentral}q=g:io.jackbradshaw:kmonkey[io.jackbradshaw:kmonkey]
|{url-github}/jack-bradshaw/monorepo/tree/main/java/io/jackbradshaw/kmonkey[GitHub]


|===


== Github Repo

This is the main repository for jmonkey contributions:
link:https://github.com/jMonkeyEngine-Contributions[https://github.com/jMonkeyEngine-Contributions]


== Forum: Contributions

This is the forum category where you can find other people's contributions or present your own contribution:
link:http://hub.jmonkeyengine.org/c/contribution-depot-jme3[http://hub.jmonkeyengine.org/c/contribution-depot-jme3]


== Other Repos

There are other repositories for code sources. A list of weblinks follows:

*  link:http://sourceforge.net/projects/jmonkeycsg/[http://sourceforge.net/projects/jmonkeycsg/]
*  link:https://github.com/davidB/jme3_skel[https://github.com/davidB/jme3_skel]


== Frameworks

These are premade classes/functionalities that you can use.

CAUTION: These contributions are developed by jMonkeyEngine users and aren't officially supported by jMonkeyEngine. As such, these projects and the supporting documentation may become stale over time as the contributors lose interest.

=== ImagePainter

[.right.text-left]
image::http://i.imgur.com/NYtSC.jpg[NYtSC.jpg,width="150",height=""]

A fairly complete set of painting tools for editing jME3 Images from code.

[cols="2", options="header"]
|===

a| *Contact person*
a| {url-forum-user}/zarch/activity[zarch]

a| *Documentation*
a| link:https://hub.jmonkeyengine.org/t/image-painter-plugin-available/24255[Forum Post, full javadoc in plugin]

a| *Available as SDK plugin*
a| Yes

a| *Work in progress*
a| No

|===


=== ParticleController

[.right.text-left]

Next Generation Particle Emitters.

[cols="2", options="header"]
|===

a| *Contact person*
a| {url-forum-user}/zarch/activity[zarch]

a| *Documentation*
a| xref:effect/particles/particles.adoc[Wiki Page]

a| *Available as SDK plugin*
a| No

a| *Work in progress*
a| No

|===


=== Shaderblow

[.right.text-left]
image::sdk:plugin/glass-shader.png[glass-shader.png,width="150",height=""]

The "`Shaderblow`" library contains various shader effects, e.g. refraction, particles, forceshields, grayscale and much more.

[cols="2", options="header"]
|===

a| *Contact person*
a| {url-forum-user}/mifth/activity[mifth]

a| *Documentation*
a| xref:sdk:plugin/shaderblow.adoc[Wiki Page]

a| *Available as SDK plugin*
a| Yes

a| *Work in progress*
a| Yes

|===

=== Zay-ES Entity System

[.right.text-left]
image::http://i.imgur.com/mQ6Uki9.jpg[mQ6Uki9.jpg,width="150",height=""]

A self-contained thread-capable entity system.

[cols="2", options="header"]
|===

<a| *Contact person*
a| {url-forum-user}/pspeed/activity[Paul Speed (pspeed)]

<a| *Documentation*
<a| xref:es/entitysystem/entitysystem.adoc[Wiki Page]

<a| *Available as SDK plugin*
<a| Yes

<a| *Work in progress*
<a| Seems fairly complete

|===

=== Lemur Gui Library
[.right.text-left]
image::https://camo.githubusercontent.com/dae08416ac8e7ebf5663dfcf409e8415c3b37a0f79edae535e68c69ae872b33f/687474703a2f2f692e696d6775722e636f6d2f325075723370472e706e67[lemur,width="150",height=""]

Lemur is GUI toolkit for making user interfaces in jMonkeyEngine applications. It supports standard 2D UIs as well as fully 3D UIs. The modular design allows an application to use all or some of it as needed or even to build a completely new custom GUI library on top.

[cols="2", options="header"]
|===

<a| *Contact person*
a| {url-forum-user}/pspeed/activity[Paul Speed (pspeed)]

<a| *Documentation*
<a| link:https://github.com/jMonkeyEngine-Contributions/Lemur/wiki[Wiki Page]

<a| *Forum Topic*
<a| link:https://hub.jmonkeyengine.org/c/user-code-projects/lemur/46[Lemur]

<a| *Available as SDK plugin*
<a| No

<a| *Work in progress*
<a| Complete library, well maintained and documented with examples.
|===

=== tonegodGUI

[.right.text-left]
image::http://i.imgur.com/0Ww1xA7.png[0Ww1xA7.png,width="150",height=""]

A Native +++<abbr title="Graphical User Interface">GUI</abbr>+++ Library for JME3

[cols="2", options="header"]
|===

a| *Contact person*
a| {url-forum-user}/t0neg0d/activity[t0neg0d]

a| *Documentation*
a| xref:gui/tonegodgui/tonegodgui.adoc[Wiki Page]

a| *Available as SDK plugin*
a| Yes

a| *Work in progress*
a| Abandoned but there is a fork of the project that has been updated and can be found on {url-github}/stephengold/tonegodgui[GitHub].

|===


=== Immediate graphical user interface

IGUI is a minimalistic immediate gui for jMonkeyEngine. It is built around Picture and BitmapText classes.

[cols="2", options="header"]
|===

a| *Contact person*
a| {url-forum-user}/RiccardoBlb[RiccardoBlb]

a| *Documentation*
a| {url-github}/riccardobl/jme-igui#readme[jme-IGUI]

a| *Available as SDK plugin*
a| No

a| *Work in progress*
a| Yes

|===

=== Tamarin OpenXR

Tamarin provides OpenXR functionality to enable jMonkey applications to run on VR headsets. It provides full support for the headset, controller actions, haptic feedback and a sample set of vr hands.

[cols="2", options="header"]
|===

a| *Contact person*
a| {url-forum-user}/richtea[richtea]

a| *Documentation*
a| {url-github}/oneMillionWorlds/Tamarin/wiki[Tamarin wiki]

a| *Available as SDK plugin*
a| No

a| *Work in progress*
a| No (Actively maintained and improved)

|===

== Assets packs

_No contributions yet_


== Want to commit something yourself?

If you have a framework/assets pack/whatever you want to contribute, please check out our link:http://hub.jmonkeyengine.org/c/contribution-depot-jme3/[Contribution Depot].


== Forgot something?

Well, this is a wiki page - Please add projects that are available or keep the provided information up-to-date if you want.