|
@@ -1,6 +1,8 @@
|
|
|
# jMonkeyEngine Software Development Kit (SDK) [](https://travis-ci.org/jMonkeyEngine/sdk)
|
|
|
|
|
|
Welcome to the repository of the jMonkeyEngine Software Development Kit (SDK).
|
|
|
+This SDK simplifies developing 3D Applications with the jMonkeyEngine. It contains everything ever needed to develop a full application.
|
|
|
+
|
|
|
Our SDK (or jmonkeyplatform) is based on the Netbeans IDE but includes additional features like:
|
|
|
- A Scene Editor (SceneExplorer: Preview your scene, adjust all positions, add `Controls` and `AppStates` (WYSIWYG) and then just save the scene)
|
|
|
- A Material Editor
|
|
@@ -31,22 +33,25 @@ __Note:__ Currently, the SDK has to build the engine on it's own, because not al
|
|
|
|
|
|
Technically the gradle task `buildSdk` is the main task which builds the sdk (Invoking `./gradlew buildSdk` or `gradlew.bat buildSdk` on Windows).
|
|
|
|
|
|
-If you just want to run the SDK on your machine:
|
|
|
+__If you just want to run the SDK on your machine:__
|
|
|
call `./gradlew run` (`gradlew.bat run`), which internally calls `buildSdk` and then uses `ant` to run the SDK.
|
|
|
|
|
|
-If you want to build the platform agnostic zip:
|
|
|
+__If you want to build the platform agnostic zip:__
|
|
|
call `./gradlew buildSdk` and then you have the file in `dist/jmonkeyplatform.zip`
|
|
|
|
|
|
-If you want to build the platform installers (like we do):
|
|
|
- call `./gradlew buildSdk` and then `ant build-installers`
|
|
|
- You have to install ant for this to work (for linux consult the internet, for mac os look into homebrew)
|
|
|
+__If you want to build the platform installers (like we do):__
|
|
|
+ call `./download-jdks.sh`, `./gradlew buildSdk` and then `ant build-installers`
|
|
|
+ You have to install ant for this to work (for linux consult the internet, for mac os look into homebrew).
|
|
|
+ Note that this takes a long time (more than one hour), because a huge amount of data is compressed and such.
|
|
|
|
|
|
-If you want to build the platform installers (On Windows -> without having ant):
|
|
|
+__If you want to build the platform installers (On Windows -> without having ant):__
|
|
|
See above. You can bypass ant by declaring a gradle task, just like it has been done for run. There, the gradle included ant will be used).
|
|
|
Alternatively you can launch netbeans in `netbeans/`, open the SDK as Netbeans Project Collection and select __package as__:
|
|
|
- 
|
|
|
+ .
|
|
|
+ Note that you still have to download and unpack the jdks somehow, which is a cumbersome process, which is why it is discouraged to
|
|
|
+ build the installers on Windows (Linux and Mac OS are supported).
|
|
|
|
|
|
-If you want to debug the SDK inside an IDE:
|
|
|
+__If you want to debug the SDK inside an IDE:__
|
|
|
See above. You want to open the SDK as Netbeans Project from within Netbeans (you can use the nb in `netbeans/`) and you can then treat it as regular project with the difference that there are several subproject.
|
|
|
|
|
|
A note about the `netbeans/` folder: To save bandwidth `buildSdk` downloads netbeans once to said folder and uses it over and over again. Even when the download URL is changed (i.e. when you update the netbeans version), you have to delete the netbeans folder and remove it from any cache (`Travis!`), so it can be reloaded.
|
|
@@ -61,8 +66,8 @@ Other than that, we are more than happy to help, even if your addition is incomp
|
|
|
Before you open an issue, make sure that it is not an engine bug, but a real sdk bug. If you are uncertain whether it is a real bug or misuse, you can either open an issue or ask [on the hub](https://hub.jmonkeyengine.org) using the `Troubleshooting | jmonkeyplatform` category.
|
|
|
|
|
|
## Issues when building
|
|
|
-__Could not find `jme3.1.0-stable`__ :
|
|
|
+__Could not find `jme3.1.0-stable`__ :
|
|
|
When you occur this issue, you have to go back to the engine build step and see how the engine is called. Technically the engine version is collected out from git tags, or called SNAPSHOT. Then there are cases where this recognition fails. For example when the SDK has a tag but the engine is snapshot. Then take a look at `build.gradle` in the sdk repo. It contains a field called `ext.jmeVersion` or something, where you can specify the version.
|
|
|
|
|
|
-__Could not find `jme3-jbullet`__ :
|
|
|
+__Could not find `jme3-jbullet`__ :
|
|
|
jBullet is not part of jCenter, which means you forgot to build the engine first. See above.
|