project_creation.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <title>jMonkeyEngine SDK: Creating Projects :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/sdk/project_creation.html">
  8. <meta name="keywords" content="documentation, project, deployment, sdk">
  9. <meta name="generator" content="Antora 2.3.3">
  10. <link rel="stylesheet" href="../../_/css/site.css">
  11. </head>
  12. <body class="article">
  13. <header class="header">
  14. <nav class="navbar">
  15. <div class="navbar-brand">
  16. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">jMonkeyEngine Docs</a>
  17. <button class="navbar-burger" data-target="topbar-nav">
  18. <span></span>
  19. <span></span>
  20. <span></span>
  21. </button>
  22. </div>
  23. <div id="topbar-nav" class="navbar-menu">
  24. <div class="navbar-end">
  25. <a class="navbar-item" href="#">Home</a>
  26. <div class="navbar-item has-dropdown is-hoverable">
  27. <a class="navbar-link" href="#">Products</a>
  28. <div class="navbar-dropdown">
  29. <a class="navbar-item" href="#">Product A</a>
  30. <a class="navbar-item" href="#">Product B</a>
  31. <a class="navbar-item" href="#">Product C</a>
  32. </div>
  33. </div>
  34. <div class="navbar-item has-dropdown is-hoverable">
  35. <a class="navbar-link" href="#">Services</a>
  36. <div class="navbar-dropdown">
  37. <a class="navbar-item" href="#">Service A</a>
  38. <a class="navbar-item" href="#">Service B</a>
  39. <a class="navbar-item" href="#">Service C</a>
  40. </div>
  41. </div>
  42. <div class="navbar-item has-dropdown is-hoverable">
  43. <a class="navbar-link" href="#">Resources</a>
  44. <div class="navbar-dropdown">
  45. <a class="navbar-item" href="#">Resource A</a>
  46. <a class="navbar-item" href="#">Resource B</a>
  47. <a class="navbar-item" href="#">Resource C</a>
  48. </div>
  49. </div>
  50. <div class="navbar-item">
  51. <span class="control">
  52. <a class="button is-primary" href="#">Download</a>
  53. </span>
  54. </div>
  55. </div>
  56. </div>
  57. </nav>
  58. </header>
  59. <div class="body">
  60. <div class="nav-container" data-component="docs" data-version="master">
  61. <aside class="nav">
  62. <div class="panels">
  63. <div class="nav-panel-menu is-active" data-panel="menu">
  64. <nav class="nav-menu">
  65. <h3 class="title"><a href="../jme3.html">Docs</a></h3>
  66. <ul class="nav-list">
  67. <li class="nav-item" data-depth="0">
  68. <ul class="nav-list">
  69. <li class="nav-item" data-depth="1">
  70. <a class="nav-link" href="../documentation.html">Getting Started</a>
  71. </li>
  72. <li class="nav-item" data-depth="1">
  73. <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  74. </li>
  75. <li class="nav-item" data-depth="1">
  76. <button class="nav-item-toggle"></button>
  77. <a class="nav-link" href="../jme3.html">jMonkeyEngine 3</a>
  78. <ul class="nav-list">
  79. <li class="nav-item" data-depth="2">
  80. <button class="nav-item-toggle"></button>
  81. <span class="nav-text">Beginner Tutorials</span>
  82. <ul class="nav-list">
  83. <li class="nav-item" data-depth="3">
  84. <a class="nav-link" href="../jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  85. </li>
  86. <li class="nav-item" data-depth="3">
  87. <a class="nav-link" href="../jme3/beginner/hello_node.html">Hello Node</a>
  88. </li>
  89. <li class="nav-item" data-depth="3">
  90. <a class="nav-link" href="../jme3/beginner/hello_asset.html">Hello Asset</a>
  91. </li>
  92. <li class="nav-item" data-depth="3">
  93. <a class="nav-link" href="../jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  94. </li>
  95. <li class="nav-item" data-depth="3">
  96. <a class="nav-link" href="../jme3/beginner/hello_input_system.html">Hello Input System</a>
  97. </li>
  98. <li class="nav-item" data-depth="3">
  99. <a class="nav-link" href="../jme3/beginner/hello_material.html">Hello Material</a>
  100. </li>
  101. <li class="nav-item" data-depth="3">
  102. <a class="nav-link" href="../jme3/beginner/hello_animation.html">Hello Animation</a>
  103. </li>
  104. <li class="nav-item" data-depth="3">
  105. <a class="nav-link" href="../jme3/beginner/hello_picking.html">Hello Picking</a>
  106. </li>
  107. <li class="nav-item" data-depth="3">
  108. <a class="nav-link" href="../jme3/beginner/hello_collision.html">Hello Collision</a>
  109. </li>
  110. <li class="nav-item" data-depth="3">
  111. <a class="nav-link" href="../jme3/beginner/hello_terrain.html">Hello Terrain</a>
  112. </li>
  113. <li class="nav-item" data-depth="3">
  114. <a class="nav-link" href="../jme3/beginner/hello_audio.html">Hello Audio</a>
  115. </li>
  116. <li class="nav-item" data-depth="3">
  117. <a class="nav-link" href="../jme3/beginner/hello_effects.html">Hello Effects</a>
  118. </li>
  119. <li class="nav-item" data-depth="3">
  120. <a class="nav-link" href="../jme3/beginner/hello_physics.html">Hello Physics</a>
  121. </li>
  122. </ul>
  123. </li>
  124. <li class="nav-item" data-depth="2">
  125. <button class="nav-item-toggle"></button>
  126. <span class="nav-text">Intermediate Tutorials</span>
  127. <ul class="nav-list">
  128. <li class="nav-item" data-depth="3">
  129. <button class="nav-item-toggle"></button>
  130. <span class="nav-text">Concepts</span>
  131. <ul class="nav-list">
  132. <li class="nav-item" data-depth="4">
  133. <a class="nav-link" href="../jme3/intermediate/best_practices.html">Best Practices</a>
  134. </li>
  135. <li class="nav-item" data-depth="4">
  136. <a class="nav-link" href="../jme3/intermediate/simpleapplication.html">Simple Application</a>
  137. </li>
  138. <li class="nav-item" data-depth="4">
  139. <a class="nav-link" href="../jme3/features.html">Features</a>
  140. </li>
  141. <li class="nav-item" data-depth="4">
  142. <a class="nav-link" href="../jme3/intermediate/optimization.html">Optimization</a>
  143. </li>
  144. <li class="nav-item" data-depth="4">
  145. <a class="nav-link" href="../jme3/faq.html">FAQ</a>
  146. </li>
  147. </ul>
  148. </li>
  149. <li class="nav-item" data-depth="3">
  150. <button class="nav-item-toggle"></button>
  151. <span class="nav-text">Math Concepts</span>
  152. <ul class="nav-list">
  153. <li class="nav-item" data-depth="4">
  154. <a class="nav-link" href="../jme3/math_for_dummies.html">Math For Dummies</a>
  155. </li>
  156. <li class="nav-item" data-depth="4">
  157. <a class="nav-link" href="../jme3/intermediate/math.html">Math</a>
  158. </li>
  159. <li class="nav-item" data-depth="4">
  160. <a class="nav-link" href="../jme3/math.html">More Math</a>
  161. </li>
  162. <li class="nav-item" data-depth="4">
  163. <a class="nav-link" href="../jme3/rotate.html">Rotate</a>
  164. </li>
  165. <li class="nav-item" data-depth="4">
  166. <a class="nav-link" href="../jme3/math_video_tutorials.html">Math Video Tutorials</a>
  167. </li>
  168. </ul>
  169. </li>
  170. <li class="nav-item" data-depth="3">
  171. <button class="nav-item-toggle"></button>
  172. <span class="nav-text">3D Graphics Concepts</span>
  173. <ul class="nav-list">
  174. <li class="nav-item" data-depth="4">
  175. <a class="nav-link" href="../jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  176. </li>
  177. <li class="nav-item" data-depth="4">
  178. <a class="nav-link" href="../jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  179. </li>
  180. <li class="nav-item" data-depth="4">
  181. <a class="nav-link" href="../jme3/beginner/hellovector.html">Hello Vector</a>
  182. </li>
  183. <li class="nav-item" data-depth="4">
  184. <a class="nav-link" href="../jme3/terminology.html">Terminology</a>
  185. </li>
  186. <li class="nav-item" data-depth="4">
  187. <a class="nav-link" href="../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  188. </li>
  189. <li class="nav-item" data-depth="4">
  190. <a class="nav-link" href="../jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  191. </li>
  192. <li class="nav-item" data-depth="4">
  193. <a class="nav-link" href="../jme3/external/blender.html">Importing from Blender</a>
  194. </li>
  195. <li class="nav-item" data-depth="4">
  196. <a class="nav-link" href="../jme3/external/3dsmax.html">Importing from 3DS Max</a>
  197. </li>
  198. </ul>
  199. </li>
  200. </ul>
  201. </li>
  202. </ul>
  203. </li>
  204. <li class="nav-item" data-depth="1">
  205. <a class="nav-link" href="../logo.html">Logo Usage</a>
  206. </li>
  207. <li class="nav-item" data-depth="1">
  208. <a class="nav-link" href="../bsd_license.html">License</a>
  209. </li>
  210. <li class="nav-item" data-depth="1">
  211. <a class="nav-link" href="../github_tips.html">Github Tips</a>
  212. </li>
  213. </ul>
  214. </li>
  215. <li class="nav-item" data-depth="0">
  216. <button class="nav-item-toggle"></button>
  217. <span class="nav-text">SDK</span>
  218. <ul class="nav-list">
  219. <li class="nav-item" data-depth="1">
  220. <a class="nav-link" href="../sdk.html">jMonkeyEngine SDK</a>
  221. </li>
  222. </ul>
  223. </li>
  224. </ul>
  225. </nav>
  226. </div>
  227. <div class="nav-panel-explore" data-panel="explore">
  228. <div class="context">
  229. <span class="title">Docs</span>
  230. <span class="version">master</span>
  231. </div>
  232. <ul class="components">
  233. <li class="component is-current">
  234. <span class="title">Docs</span>
  235. <ul class="versions">
  236. <li class="version is-current is-latest">
  237. <a href="../jme3.html">master</a>
  238. </li>
  239. </ul>
  240. </li>
  241. <li class="component">
  242. <span class="title">Wiki UI</span>
  243. <ul class="versions">
  244. <li class="version is-latest">
  245. <a href="../../wiki-ui/index.html">master</a>
  246. </li>
  247. </ul>
  248. </li>
  249. </ul>
  250. </div>
  251. </div>
  252. </aside>
  253. </div>
  254. <main class="article">
  255. <div class="toolbar" role="navigation">
  256. <button class="nav-toggle"></button>
  257. <a href="../documentation.html" class="home-link"></a>
  258. <nav class="breadcrumbs" aria-label="breadcrumbs">
  259. <ul>
  260. <li><a href="../jme3.html">Docs</a></li>
  261. <li><a href="project_creation.html">jMonkeyEngine SDK: Creating Projects</a></li>
  262. </ul>
  263. </nav>
  264. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/sdk/project_creation.adoc">Edit this Page</a></div>
  265. </div>
  266. <div class="content">
  267. <article class="doc">
  268. <h1 class="page">jMonkeyEngine SDK: Creating Projects</h1>
  269. <div id="preamble">
  270. <div class="sectionbody">
  271. <div class="paragraph">
  272. <p>The jMonkeyEngine SDK makes it easy to get started with developing 3-D games based on the jMonkeyEngine.</p>
  273. </div>
  274. </div>
  275. </div>
  276. <div class="sect1">
  277. <h2 id="creating-a-new-jmonkeyengine-project"><a class="anchor" href="#creating-a-new-jmonkeyengine-project"></a>Creating a New jMonkeyEngine Project</h2>
  278. <div class="sectionbody">
  279. <div class="olist arabic">
  280. <ol class="arabic">
  281. <li>
  282. <p>Choose <code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">New Project</b></span></code> from the main menu.</p>
  283. </li>
  284. <li>
  285. <p>In the New Project Wizard, select the template <code><span class="menuseq"><b class="menu">JME3</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Basic Game</b></span></code>.</p>
  286. </li>
  287. <li>
  288. <p>Click next to specify a project name, and the path where to store your new project.</p>
  289. </li>
  290. <li>
  291. <p>Click Finish. A skeleton application is created and opens in the Project Explorer.</p>
  292. <div class="ulist">
  293. <ul>
  294. <li>
  295. <p>This basic jme3 application is based on the SimpleApplication class to allow an easy start with jme3.</p>
  296. </li>
  297. <li>
  298. <p>You can click the run button to run it: You will see a blue cube.</p>
  299. </li>
  300. </ul>
  301. </div>
  302. </li>
  303. </ol>
  304. </div>
  305. <div class="sect2">
  306. <h3 id="project-structure"><a class="anchor" href="#project-structure"></a>Project Structure</h3>
  307. <div class="imageblock text-center">
  308. <div class="content">
  309. <img src="../_images/sdk/jmonkeyplatform-docu-4.png" alt="jmonkeyplatform-docu-4.png" width="421" height="298">
  310. </div>
  311. </div>
  312. <div class="paragraph">
  313. <p>Let&#8217;s have a look at the abstract project structure in the Project Explorer. (<kbd>Ctrl</kbd>+<kbd>1</kbd>).</p>
  314. </div>
  315. <div class="ulist">
  316. <ul>
  317. <li>
  318. <p><strong>Project Assets node:</strong> These directories have been created for you to store your games assets, such as fonts, materials, models, shaders, sounds, and textures. For a newly created project, these directories are empty.</p>
  319. </li>
  320. <li>
  321. <p><strong>Source Packages node:</strong> This is where you manage your packages and classes. For a newly created project, it contains one package and one class, <code>Main.java</code>. Double click <code>Main.java</code> to open it in the editor.</p>
  322. </li>
  323. <li>
  324. <p><strong>Libraries node:</strong> An overview of all libraies on your game&#8217;s classpath. The classpath is already set-up for the jme3 framework (including LWJGL, Bullet, Nifty <abbr title="Graphical User Interface">GUI</abbr>, etc).</p>
  325. </li>
  326. </ul>
  327. </div>
  328. </div>
  329. <div class="sect2">
  330. <h3 id="directory-structure"><a class="anchor" href="#directory-structure"></a>Directory Structure</h3>
  331. <div class="paragraph">
  332. <p>Now let&#8217;s have a look at the project&#8217;s file structure in the File Explorer (<kbd>Ctrl</kbd>+<kbd>2</kbd>). This explorer shows the physical directory structure on your hard drive.</p>
  333. </div>
  334. <div class="ulist">
  335. <ul>
  336. <li>
  337. <p><strong>assets</strong> – This directory corresponds to the Project Assets node. It is needed for the assetManager.</p>
  338. <div class="paragraph">
  339. <p>This is the recommended internal structure:</p>
  340. </div>
  341. <div class="ulist">
  342. <ul>
  343. <li>
  344. <p><code>assets/Interface</code></p>
  345. </li>
  346. <li>
  347. <p><code>assets/MatDefs</code></p>
  348. </li>
  349. <li>
  350. <p><code>assets/Materials</code></p>
  351. </li>
  352. <li>
  353. <p><code>assets/Models</code></p>
  354. </li>
  355. <li>
  356. <p><code>assets/Scenes</code></p>
  357. </li>
  358. <li>
  359. <p><code>assets/Shaders</code></p>
  360. </li>
  361. <li>
  362. <p><code>assets/Sounds</code></p>
  363. </li>
  364. <li>
  365. <p><code>assets/Textures</code></p>
  366. </li>
  367. </ul>
  368. </div>
  369. </li>
  370. <li>
  371. <p><strong>src</strong> – This directory corresponds to the Source Packages node. Your sources code goes here.</p>
  372. </li>
  373. <li>
  374. <p><strong>nbproject</strong> – This is meta data used by the jMonkeyEngine SDK (don&#8217;t edit).</p>
  375. </li>
  376. <li>
  377. <p><strong>build.xml</strong> – This is an Ant build script that is hooked up to the clean/build/run/test actions in the jMonkeyEngine SDK. It loads a default build script, and allows you to further customize the build process. The Ant script also assures that you are able to clean/build/run/test your application outside of the jMonkeyEngine SDK – e.g. from the command line.</p>
  378. </li>
  379. <li>
  380. <p><strong>build</strong> – This directory contains the compiled classes. (Will be generated by the jMonkeyEngine SDK when you build the project.)</p>
  381. </li>
  382. <li>
  383. <p><strong>dist</strong> – This directory contains the executable JAR files. (Will be generated by the jMonkeyEngine SDK when you build the project.)</p>
  384. </li>
  385. <li>
  386. <p><strong>test</strong> – The jMonkeyEngine SDK will store JUnit tests here if you create any. (Optional.)</p>
  387. </li>
  388. </ul>
  389. </div>
  390. </div>
  391. <div class="sect2">
  392. <h3 id="project-configuration"><a class="anchor" href="#project-configuration"></a>Project Configuration</h3>
  393. <div class="paragraph">
  394. <p>[RMB] select the project and from the menu open the project <code>Properties</code>.</p>
  395. </div>
  396. <div class="ulist">
  397. <ul>
  398. <li>
  399. <p>In the <code>Run</code> section:</p>
  400. <div class="ulist">
  401. <ul>
  402. <li>
  403. <p>Specify the main class of your project. (Pressing <kbd>F6</kbd> runs this main class.)</p>
  404. </li>
  405. <li>
  406. <p>You can optionally configure JVM options and command line parameters. In most cases, set the <code>-Xms VMOption [NUMBER] m</code> for the memory usage.</p>
  407. <div class="ulist">
  408. <ul>
  409. <li>
  410. <p>For example (-Xms500m).</p>
  411. </li>
  412. <li>
  413. <p>see <a href="http://performance.netbeans.org/howto/jvmswitches/">http://performance.netbeans.org/howto/jvmswitches/</a>).</p>
  414. </li>
  415. </ul>
  416. </div>
  417. </li>
  418. </ul>
  419. </div>
  420. </li>
  421. <li>
  422. <p>In the Application section:</p>
  423. <div class="ulist">
  424. <ul>
  425. <li>
  426. <p>Specify the game title (by default the game will be named <code>BasicGame</code>).</p>
  427. </li>
  428. <li>
  429. <p>Specify the vendor name (your name), a short description, your project&#8217;s homepage, and a splash screen.</p>
  430. </li>
  431. </ul>
  432. </div>
  433. </li>
  434. </ul>
  435. </div>
  436. </div>
  437. <div class="sect2">
  438. <h3 id="clean-build-and-run-cycle"><a class="anchor" href="#clean-build-and-run-cycle"></a>Clean, Build and Run Cycle</h3>
  439. <div class="imageblock text-center">
  440. <div class="content">
  441. <img src="../_images/sdk/jmonkeyplatform-docu-5.png" alt="jmonkeyplatform-docu-5.png" width="421" height="298">
  442. </div>
  443. </div>
  444. <div class="admonitionblock important">
  445. <table>
  446. <tr>
  447. <td class="icon">
  448. <i class="fa icon-important" title="Important"></i>
  449. </td>
  450. <td class="content">
  451. <div class="paragraph">
  452. <p>Pressing <strong><kbd>F6</kbd> builds &amp; runs</strong> the <em>main</em> class of the <em>main project</em>. If there are several classes, or several projects, you have to specify which one you want <kbd>F6</kbd> to run. <b class="button">RMB</b> select a project and choose <code>Set As Main Project</code>, then <b class="button">RMB</b> select the project again and choose <code><span class="menuseq"><b class="menu">Properties</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Run</b></span></code> and choose a Main Class.</p>
  453. </div>
  454. <div class="paragraph">
  455. <p>To build and run the main() of <em>any file that is open in the editor</em>, press <kbd>Shift</kbd>+<kbd>F6</kbd>!</p>
  456. </div>
  457. </td>
  458. </tr>
  459. </table>
  460. </div>
  461. <div class="ulist">
  462. <ul>
  463. <li>
  464. <p><b class="button">RMB</b> select the project and use the context-menu to clean all generated classes and JARs.</p>
  465. </li>
  466. <li>
  467. <p><b class="button">RMB</b> select individual files with a main method to build and run them. (<kbd>Shift</kbd>+<kbd>F6</kbd>)</p>
  468. </li>
  469. <li>
  470. <p>Press the <b class="button">Run</b> button (green arrow in the toolbar) to build and run the project. (<kbd>F6</kbd>)</p>
  471. </li>
  472. </ul>
  473. </div>
  474. <div class="paragraph">
  475. <p><strong>More than one project open?</strong> The toolbar buttons and the F-keys are bound to the main project, which is shown in bold in the Project Explorer. <b class="button">RMB</b> select a project and select <code>Set As Main Project</code> to make it respond to the toolbar buttons and F-keys.</p>
  476. </div>
  477. <div class="paragraph">
  478. <p><strong>Worried About Proprietary Lock-in?</strong> You are never locked into the jMonkeyEngine SDK: At any time, you can change into your project directory on the command line, and clean, build, and run your project, using non-proprietary Apache Ant commands:</p>
  479. </div>
  480. <div class="listingblock">
  481. <div class="content">
  482. <pre class="highlightjs highlight"><code>ant clean; ant jar; ant run;</code></pre>
  483. </div>
  484. </div>
  485. </div>
  486. </div>
  487. </div>
  488. <div class="sect1">
  489. <h2 id="development-process"><a class="anchor" href="#development-process"></a>Development Process</h2>
  490. <div class="sectionbody">
  491. <div class="ulist">
  492. <ul>
  493. <li>
  494. <p><strong>Creating new files and packages:</strong> Select the Source Packages node (or any of its subnodes), and press <kbd>Ctrl</kbd>+<kbd>N</kbd> (<code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">New File</b></span></code>): Use the <code>New File</code> wizard to create new Java classes, Java packages, Java beans, Swing forms, JUnit files, j3m Materials, j3o scenes, j3f filters, and many more.</p>
  495. </li>
  496. <li>
  497. <p><strong>Editing files:</strong> Open the Projects Explorer and double-click a Java file from the Source Packages to open it in the Editor. The <a href="code_editor.html" class="page">jMonkeyEngine SDK Code Editor</a> assists you in many ways, including syntactic and semantic code coloring, code completion, and javadoc.</p>
  498. </li>
  499. <li>
  500. <p><strong>Adding Assets:</strong></p>
  501. <div class="ulist">
  502. <ul>
  503. <li>
  504. <p>You can <a href="model_loader_and_viewer.html" class="page">import models, scenes, and materials</a> as assets into your project.</p>
  505. </li>
  506. <li>
  507. <p>To add sound files and images, use your operating system&#8217;s file explorer and copy the files into your project&#8217;s asset directory.</p>
  508. </li>
  509. </ul>
  510. </div>
  511. </li>
  512. <li>
  513. <p><strong>ToDo List:</strong> The tasks window automatically lists all lines containing errors and warnings, and all lines that you have marked with the comment keywords</p>
  514. <div class="listingblock">
  515. <div class="content">
  516. <pre class="highlightjs highlight"><code class="language-html hljs" data-lang="html">FIXME</code></pre>
  517. </div>
  518. </div>
  519. <div class="paragraph">
  520. <p>, @todo, or TODO.</p>
  521. </div>
  522. </li>
  523. <li>
  524. <p><strong>Integrated tools:</strong> <a href="debugging_profiling_testing.html" class="page">Debugging, Testing, Profiling</a>.</p>
  525. </li>
  526. </ul>
  527. </div>
  528. <div class="sect2">
  529. <h3 id="adding-external-jar-libraries"><a class="anchor" href="#adding-external-jar-libraries"></a>Adding external jar libraries</h3>
  530. <div class="paragraph">
  531. <p>You may want to use external Java libraries in your jME project, for example content generators or artificial intelligence implementations.</p>
  532. </div>
  533. <div class="paragraph">
  534. <p>Add the library to the global library list:</p>
  535. </div>
  536. <div class="ulist">
  537. <ul>
  538. <li>
  539. <p>Select <span class="menuseq"><b class="menu">Tools</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Libraries</b></span> in the main menu.</p>
  540. </li>
  541. <li>
  542. <p>Click &#8220;New Library&#8221;, enter a name for the library, and press <b class="button">OK</b>.</p>
  543. </li>
  544. <li>
  545. <p>In the &#8220;Classpath&#8221; tab, press &#8220;Add JAR/Folder&#8221; and select the jar file(s) needed for the library.</p>
  546. </li>
  547. <li>
  548. <p>(Optional) In the &#8220;JavaDoc&#8221; tab, press &#8220;Add ZIP/Folder&#8221; and select the javadoc for the library, as zip file or folder.</p>
  549. </li>
  550. <li>
  551. <p>(Optional) In the &#8220;Sources&#8221; tab you can select a folder or jar file containing the source files of the library.</p>
  552. </li>
  553. <li>
  554. <p>Press <b class="button">OK</b>.</p>
  555. </li>
  556. </ul>
  557. </div>
  558. <div class="paragraph">
  559. <p>Add the library to a project:</p>
  560. </div>
  561. <div class="ulist">
  562. <ul>
  563. <li>
  564. <p><b class="button">RMB</b> select your project and select &#8220;Properties&#8221;.</p>
  565. </li>
  566. <li>
  567. <p>Select &#8220;Libaries&#8221; on the left and then press &#8220;Add Library&#8221;.</p>
  568. </li>
  569. <li>
  570. <p>Select the library from the list and press <b class="button">OK</b>.</p>
  571. </li>
  572. </ul>
  573. </div>
  574. <div class="paragraph">
  575. <p>That&#8217;s it, your project can now use the external library. If you also linked the javadoc and sources, the SDK will assist you with javadoc popups, code completion (<kbd>Ctrl</kbd>+<kbd>Space</kbd>) and source navigation (<kbd>Ctrl</kbd>+<b class="button">LMB</b> ).</p>
  576. </div>
  577. </div>
  578. <div class="sect2">
  579. <h3 id="application-deployment"><a class="anchor" href="#application-deployment"></a>Application Deployment</h3>
  580. <div class="ulist">
  581. <ul>
  582. <li>
  583. <p>You can <a href="application_deployment.html" class="page">deploy</a> your game as desktop application (JAR), browser applet, WebStart (JNLP), or on the Android platform.</p>
  584. </li>
  585. </ul>
  586. </div>
  587. </div>
  588. </div>
  589. </div>
  590. <div class="sect1">
  591. <h2 id="running-sample-projects"><a class="anchor" href="#running-sample-projects"></a>Running Sample Projects</h2>
  592. <div class="sectionbody">
  593. <div class="paragraph">
  594. <p>The SDK contains <a href="sample_code.html" class="page">Sample Code</a> (read more).</p>
  595. </div>
  596. <div class="paragraph">
  597. <p>Open the Source Packages node of the JmeTests project.</p>
  598. </div>
  599. <div class="ulist">
  600. <ul>
  601. <li>
  602. <p><b class="button">RMB</b> select the <code>JME3Tests</code> project and choose Run.<br>
  603. Choose samples from the TestChooser and try out the included demos.</p>
  604. </li>
  605. <li>
  606. <p>Browse a demo&#8217;s source code in the SDK&#8217;s Project window to learn how a feature is implemented and used.</p>
  607. </li>
  608. <li>
  609. <p>Feel free to modify the code samples and experiment! If you break something, you can always recreate the packaged samples from the <code>JME3 Tests</code> template.</p>
  610. </li>
  611. </ul>
  612. </div>
  613. </div>
  614. </div>
  615. </article>
  616. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  617. <div class="toc-menu"></div>
  618. </aside>
  619. </div>
  620. </main>
  621. </div>
  622. <footer class="footer">
  623. <p>This page was built using the Antora default UI.</p>
  624. <p>The source code for this UI is licensed under the terms of the MPL-2.0 license.</p>
  625. </footer>
  626. <script src="../../_/js/site.js"></script>
  627. <script async src="../../_/js/vendor/highlight.js"></script>
  628. </body>
  629. </html>