project_creation.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  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. <meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
  12. <meta property="og:description" content="jMonkeyEngine SDK: Creating Projects">
  13. <meta property="og:title" content="jMonkeyEngine Docs">
  14. <link rel="stylesheet" href="../../_/css/site-extra.css">
  15. <link rel="stylesheet" href="../../_/css/vendor/docsearch.min.css">
  16. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
  17. <link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  18. </head>
  19. <body class="article">
  20. <header class="header">
  21. <nav class="navbar">
  22. <div class="navbar-brand">
  23. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  24. <img alt="" src="../../_/img/jme-logo.png" height="32" type="image/x-icon">
  25. </a>
  26. <div class="navbar-item hide-for-print">
  27. <input id="search-input" type="text" placeholder="Search docs">
  28. </div>
  29. <button class="navbar-burger" data-target="topbar-nav">
  30. <span></span>
  31. <span></span>
  32. <span></span>
  33. </button>
  34. </div>
  35. <div id="topbar-nav" class="navbar-menu">
  36. <div class="navbar-end">
  37. <div class="navbar-item theme-switch-wrapper">
  38. <label class="theme-switch" for="checkbox">
  39. <input type="checkbox" id="checkbox" />
  40. <div class="slider round"></div>
  41. </label>
  42. </div>
  43. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  44. </div>
  45. </div>
  46. </nav>
  47. </header>
  48. <div class="body">
  49. <div class="nav-container" data-component="docs" data-version="master">
  50. <aside class="nav">
  51. <div class="panels">
  52. <div class="nav-panel-menu is-active" data-panel="menu">
  53. <nav class="nav-menu">
  54. <h3 class="title"><a href="../documentation.html">Docs</a></h3>
  55. <ul class="nav-list">
  56. <li class="nav-item" data-depth="0">
  57. <ul class="nav-list">
  58. <li class="nav-item" data-depth="1">
  59. <a class="nav-link" href="../documentation.html">Getting Started</a>
  60. </li>
  61. <li class="nav-item" data-depth="1">
  62. <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  63. </li>
  64. <li class="nav-item" data-depth="1">
  65. <button class="nav-item-toggle"></button>
  66. <a class="nav-link" href="../jme3.html">jMonkeyEngine 3</a>
  67. <ul class="nav-list">
  68. <li class="nav-item" data-depth="2">
  69. <button class="nav-item-toggle"></button>
  70. <span class="nav-text">Beginner Tutorials</span>
  71. <ul class="nav-list">
  72. <li class="nav-item" data-depth="3">
  73. <a class="nav-link" href="../jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  74. </li>
  75. <li class="nav-item" data-depth="3">
  76. <a class="nav-link" href="../jme3/beginner/hello_node.html">Hello Node</a>
  77. </li>
  78. <li class="nav-item" data-depth="3">
  79. <a class="nav-link" href="../jme3/beginner/hello_asset.html">Hello Asset</a>
  80. </li>
  81. <li class="nav-item" data-depth="3">
  82. <a class="nav-link" href="../jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  83. </li>
  84. <li class="nav-item" data-depth="3">
  85. <a class="nav-link" href="../jme3/beginner/hello_input_system.html">Hello Input System</a>
  86. </li>
  87. <li class="nav-item" data-depth="3">
  88. <a class="nav-link" href="../jme3/beginner/hello_material.html">Hello Material</a>
  89. </li>
  90. <li class="nav-item" data-depth="3">
  91. <a class="nav-link" href="../jme3/beginner/hello_animation.html">Hello Animation</a>
  92. </li>
  93. <li class="nav-item" data-depth="3">
  94. <a class="nav-link" href="../jme3/beginner/hello_picking.html">Hello Picking</a>
  95. </li>
  96. <li class="nav-item" data-depth="3">
  97. <a class="nav-link" href="../jme3/beginner/hello_collision.html">Hello Collision</a>
  98. </li>
  99. <li class="nav-item" data-depth="3">
  100. <a class="nav-link" href="../jme3/beginner/hello_terrain.html">Hello Terrain</a>
  101. </li>
  102. <li class="nav-item" data-depth="3">
  103. <a class="nav-link" href="../jme3/beginner/hello_audio.html">Hello Audio</a>
  104. </li>
  105. <li class="nav-item" data-depth="3">
  106. <a class="nav-link" href="../jme3/beginner/hello_effects.html">Hello Effects</a>
  107. </li>
  108. <li class="nav-item" data-depth="3">
  109. <a class="nav-link" href="../jme3/beginner/hello_physics.html">Hello Physics</a>
  110. </li>
  111. </ul>
  112. </li>
  113. <li class="nav-item" data-depth="2">
  114. <button class="nav-item-toggle"></button>
  115. <span class="nav-text">Intermediate Tutorials</span>
  116. <ul class="nav-list">
  117. <li class="nav-item" data-depth="3">
  118. <button class="nav-item-toggle"></button>
  119. <span class="nav-text">Concepts</span>
  120. <ul class="nav-list">
  121. <li class="nav-item" data-depth="4">
  122. <a class="nav-link" href="../jme3/intermediate/best_practices.html">Best Practices</a>
  123. </li>
  124. <li class="nav-item" data-depth="4">
  125. <a class="nav-link" href="../jme3/intermediate/simpleapplication.html">Simple Application</a>
  126. </li>
  127. <li class="nav-item" data-depth="4">
  128. <a class="nav-link" href="../jme3/features.html">Features</a>
  129. </li>
  130. <li class="nav-item" data-depth="4">
  131. <a class="nav-link" href="../jme3/intermediate/optimization.html">Optimization</a>
  132. </li>
  133. <li class="nav-item" data-depth="4">
  134. <a class="nav-link" href="../jme3/faq.html">FAQ</a>
  135. </li>
  136. </ul>
  137. </li>
  138. <li class="nav-item" data-depth="3">
  139. <button class="nav-item-toggle"></button>
  140. <span class="nav-text">Math Concepts</span>
  141. <ul class="nav-list">
  142. <li class="nav-item" data-depth="4">
  143. <a class="nav-link" href="../jme3/math_for_dummies.html">Math For Dummies</a>
  144. </li>
  145. <li class="nav-item" data-depth="4">
  146. <a class="nav-link" href="../jme3/intermediate/math.html">Math</a>
  147. </li>
  148. <li class="nav-item" data-depth="4">
  149. <a class="nav-link" href="../jme3/math.html">More Math</a>
  150. </li>
  151. <li class="nav-item" data-depth="4">
  152. <a class="nav-link" href="../jme3/rotate.html">Rotate</a>
  153. </li>
  154. <li class="nav-item" data-depth="4">
  155. <a class="nav-link" href="../jme3/math_video_tutorials.html">Math Video Tutorials</a>
  156. </li>
  157. </ul>
  158. </li>
  159. <li class="nav-item" data-depth="3">
  160. <button class="nav-item-toggle"></button>
  161. <span class="nav-text">3D Graphics Concepts</span>
  162. <ul class="nav-list">
  163. <li class="nav-item" data-depth="4">
  164. <a class="nav-link" href="../jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  165. </li>
  166. <li class="nav-item" data-depth="4">
  167. <a class="nav-link" href="../jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  168. </li>
  169. <li class="nav-item" data-depth="4">
  170. <a class="nav-link" href="../jme3/beginner/hellovector.html">Hello Vector</a>
  171. </li>
  172. <li class="nav-item" data-depth="4">
  173. <a class="nav-link" href="../jme3/terminology.html">Terminology</a>
  174. </li>
  175. <li class="nav-item" data-depth="4">
  176. <a class="nav-link" href="../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  177. </li>
  178. <li class="nav-item" data-depth="4">
  179. <a class="nav-link" href="../jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  180. </li>
  181. <li class="nav-item" data-depth="4">
  182. <a class="nav-link" href="../jme3/external/blender.html">Importing from Blender</a>
  183. </li>
  184. <li class="nav-item" data-depth="4">
  185. <a class="nav-link" href="../jme3/external/3dsmax.html">Importing from 3DS Max</a>
  186. </li>
  187. </ul>
  188. </li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </li>
  193. <li class="nav-item" data-depth="1">
  194. <a class="nav-link" href="../logo.html">Logo Usage</a>
  195. </li>
  196. <li class="nav-item" data-depth="1">
  197. <a class="nav-link" href="../bsd_license.html">License</a>
  198. </li>
  199. <li class="nav-item" data-depth="1">
  200. <a class="nav-link" href="../github_tips.html">Github Tips</a>
  201. </li>
  202. </ul>
  203. </li>
  204. <li class="nav-item" data-depth="0">
  205. <button class="nav-item-toggle"></button>
  206. <span class="nav-text">SDK</span>
  207. <ul class="nav-list">
  208. <li class="nav-item" data-depth="1">
  209. <a class="nav-link" href="../sdk.html">jMonkeyEngine SDK</a>
  210. </li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </nav>
  215. </div>
  216. <div class="nav-panel-explore" data-panel="explore">
  217. <div class="context">
  218. <span class="title">Docs</span>
  219. <span class="version">master</span>
  220. </div>
  221. <ul class="components">
  222. <li class="component is-current">
  223. <span class="title">Docs</span>
  224. <ul class="versions">
  225. <li class="version is-current is-latest">
  226. <a href="../documentation.html">master</a>
  227. </li>
  228. </ul>
  229. </li>
  230. <li class="component">
  231. <span class="title">Wiki UI</span>
  232. <ul class="versions">
  233. <li class="version is-latest">
  234. <a href="../../wiki-ui/index.html">master</a>
  235. </li>
  236. </ul>
  237. </li>
  238. </ul>
  239. </div>
  240. </div>
  241. </aside>
  242. </div>
  243. <main class="article">
  244. <div class="toolbar" role="navigation">
  245. <button class="nav-toggle"></button>
  246. <nav class="breadcrumbs" aria-label="breadcrumbs">
  247. <ul>
  248. <li><a href="../documentation.html">Docs</a></li>
  249. <li><a href="project_creation.html">jMonkeyEngine SDK: Creating Projects</a></li>
  250. </ul>
  251. </nav>
  252. <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>
  253. </div>
  254. <div class="content">
  255. <article class="doc">
  256. <h1 class="page">jMonkeyEngine SDK: Creating Projects</h1>
  257. <div id="preamble">
  258. <div class="sectionbody">
  259. <div class="paragraph">
  260. <p>The jMonkeyEngine SDK makes it easy to get started with developing 3-D games based on the jMonkeyEngine.</p>
  261. </div>
  262. </div>
  263. </div>
  264. <div class="sect1">
  265. <h2 id="creating-a-new-jmonkeyengine-project"><a class="anchor" href="#creating-a-new-jmonkeyengine-project"></a>Creating a New jMonkeyEngine Project</h2>
  266. <div class="sectionbody">
  267. <div class="olist arabic">
  268. <ol class="arabic">
  269. <li>
  270. <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>
  271. </li>
  272. <li>
  273. <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>
  274. </li>
  275. <li>
  276. <p>Click next to specify a project name, and the path where to store your new project.</p>
  277. </li>
  278. <li>
  279. <p>Click Finish. A skeleton application is created and opens in the Project Explorer.</p>
  280. <div class="ulist">
  281. <ul>
  282. <li>
  283. <p>This basic jme3 application is based on the SimpleApplication class to allow an easy start with jme3.</p>
  284. </li>
  285. <li>
  286. <p>You can click the run button to run it: You will see a blue cube.</p>
  287. </li>
  288. </ul>
  289. </div>
  290. </li>
  291. </ol>
  292. </div>
  293. <div class="sect2">
  294. <h3 id="project-structure"><a class="anchor" href="#project-structure"></a>Project Structure</h3>
  295. <div class="imageblock text-center">
  296. <div class="content">
  297. <img src="../_images/sdk/jmonkeyplatform-docu-4.png" alt="jmonkeyplatform-docu-4.png" width="421" height="298">
  298. </div>
  299. </div>
  300. <div class="paragraph">
  301. <p>Let&#8217;s have a look at the abstract project structure in the Project Explorer. (<kbd>Ctrl</kbd>+<kbd>1</kbd>).</p>
  302. </div>
  303. <div class="ulist">
  304. <ul>
  305. <li>
  306. <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>
  307. </li>
  308. <li>
  309. <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>
  310. </li>
  311. <li>
  312. <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>
  313. </li>
  314. </ul>
  315. </div>
  316. </div>
  317. <div class="sect2">
  318. <h3 id="directory-structure"><a class="anchor" href="#directory-structure"></a>Directory Structure</h3>
  319. <div class="paragraph">
  320. <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>
  321. </div>
  322. <div class="ulist">
  323. <ul>
  324. <li>
  325. <p><strong>assets</strong> – This directory corresponds to the Project Assets node. It is needed for the assetManager.</p>
  326. <div class="paragraph">
  327. <p>This is the recommended internal structure:</p>
  328. </div>
  329. <div class="ulist">
  330. <ul>
  331. <li>
  332. <p><code>assets/Interface</code></p>
  333. </li>
  334. <li>
  335. <p><code>assets/MatDefs</code></p>
  336. </li>
  337. <li>
  338. <p><code>assets/Materials</code></p>
  339. </li>
  340. <li>
  341. <p><code>assets/Models</code></p>
  342. </li>
  343. <li>
  344. <p><code>assets/Scenes</code></p>
  345. </li>
  346. <li>
  347. <p><code>assets/Shaders</code></p>
  348. </li>
  349. <li>
  350. <p><code>assets/Sounds</code></p>
  351. </li>
  352. <li>
  353. <p><code>assets/Textures</code></p>
  354. </li>
  355. </ul>
  356. </div>
  357. </li>
  358. <li>
  359. <p><strong>src</strong> – This directory corresponds to the Source Packages node. Your sources code goes here.</p>
  360. </li>
  361. <li>
  362. <p><strong>nbproject</strong> – This is meta data used by the jMonkeyEngine SDK (don&#8217;t edit).</p>
  363. </li>
  364. <li>
  365. <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>
  366. </li>
  367. <li>
  368. <p><strong>build</strong> – This directory contains the compiled classes. (Will be generated by the jMonkeyEngine SDK when you build the project.)</p>
  369. </li>
  370. <li>
  371. <p><strong>dist</strong> – This directory contains the executable JAR files. (Will be generated by the jMonkeyEngine SDK when you build the project.)</p>
  372. </li>
  373. <li>
  374. <p><strong>test</strong> – The jMonkeyEngine SDK will store JUnit tests here if you create any. (Optional.)</p>
  375. </li>
  376. </ul>
  377. </div>
  378. </div>
  379. <div class="sect2">
  380. <h3 id="project-configuration"><a class="anchor" href="#project-configuration"></a>Project Configuration</h3>
  381. <div class="paragraph">
  382. <p>[RMB] select the project and from the menu open the project <code>Properties</code>.</p>
  383. </div>
  384. <div class="ulist">
  385. <ul>
  386. <li>
  387. <p>In the <code>Run</code> section:</p>
  388. <div class="ulist">
  389. <ul>
  390. <li>
  391. <p>Specify the main class of your project. (Pressing <kbd>F6</kbd> runs this main class.)</p>
  392. </li>
  393. <li>
  394. <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>
  395. <div class="ulist">
  396. <ul>
  397. <li>
  398. <p>For example (-Xms500m).</p>
  399. </li>
  400. <li>
  401. <p>see <a href="http://performance.netbeans.org/howto/jvmswitches/">http://performance.netbeans.org/howto/jvmswitches/</a>).</p>
  402. </li>
  403. </ul>
  404. </div>
  405. </li>
  406. </ul>
  407. </div>
  408. </li>
  409. <li>
  410. <p>In the Application section:</p>
  411. <div class="ulist">
  412. <ul>
  413. <li>
  414. <p>Specify the game title (by default the game will be named <code>BasicGame</code>).</p>
  415. </li>
  416. <li>
  417. <p>Specify the vendor name (your name), a short description, your project&#8217;s homepage, and a splash screen.</p>
  418. </li>
  419. </ul>
  420. </div>
  421. </li>
  422. </ul>
  423. </div>
  424. </div>
  425. <div class="sect2">
  426. <h3 id="clean-build-and-run-cycle"><a class="anchor" href="#clean-build-and-run-cycle"></a>Clean, Build and Run Cycle</h3>
  427. <div class="imageblock text-center">
  428. <div class="content">
  429. <img src="../_images/sdk/jmonkeyplatform-docu-5.png" alt="jmonkeyplatform-docu-5.png" width="421" height="298">
  430. </div>
  431. </div>
  432. <div class="admonitionblock important">
  433. <table>
  434. <tr>
  435. <td class="icon">
  436. <i class="fa icon-important" title="Important"></i>
  437. </td>
  438. <td class="content">
  439. <div class="paragraph">
  440. <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>
  441. </div>
  442. <div class="paragraph">
  443. <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>
  444. </div>
  445. </td>
  446. </tr>
  447. </table>
  448. </div>
  449. <div class="ulist">
  450. <ul>
  451. <li>
  452. <p><b class="button">RMB</b> select the project and use the context-menu to clean all generated classes and JARs.</p>
  453. </li>
  454. <li>
  455. <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>
  456. </li>
  457. <li>
  458. <p>Press the <b class="button">Run</b> button (green arrow in the toolbar) to build and run the project. (<kbd>F6</kbd>)</p>
  459. </li>
  460. </ul>
  461. </div>
  462. <div class="paragraph">
  463. <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>
  464. </div>
  465. <div class="paragraph">
  466. <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>
  467. </div>
  468. <div class="listingblock">
  469. <div class="content">
  470. <pre class="highlightjs highlight"><code>ant clean; ant jar; ant run;</code></pre>
  471. </div>
  472. </div>
  473. </div>
  474. </div>
  475. </div>
  476. <div class="sect1">
  477. <h2 id="development-process"><a class="anchor" href="#development-process"></a>Development Process</h2>
  478. <div class="sectionbody">
  479. <div class="ulist">
  480. <ul>
  481. <li>
  482. <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>
  483. </li>
  484. <li>
  485. <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>
  486. </li>
  487. <li>
  488. <p><strong>Adding Assets:</strong></p>
  489. <div class="ulist">
  490. <ul>
  491. <li>
  492. <p>You can <a href="model_loader_and_viewer.html" class="page">import models, scenes, and materials</a> as assets into your project.</p>
  493. </li>
  494. <li>
  495. <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>
  496. </li>
  497. </ul>
  498. </div>
  499. </li>
  500. <li>
  501. <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>
  502. <div class="listingblock">
  503. <div class="content">
  504. <pre class="highlightjs highlight"><code class="language-html hljs" data-lang="html">FIXME</code></pre>
  505. </div>
  506. </div>
  507. <div class="paragraph">
  508. <p>, @todo, or TODO.</p>
  509. </div>
  510. </li>
  511. <li>
  512. <p><strong>Integrated tools:</strong> <a href="debugging_profiling_testing.html" class="page">Debugging, Testing, Profiling</a>.</p>
  513. </li>
  514. </ul>
  515. </div>
  516. <div class="sect2">
  517. <h3 id="adding-external-jar-libraries"><a class="anchor" href="#adding-external-jar-libraries"></a>Adding external jar libraries</h3>
  518. <div class="paragraph">
  519. <p>You may want to use external Java libraries in your jME project, for example content generators or artificial intelligence implementations.</p>
  520. </div>
  521. <div class="paragraph">
  522. <p>Add the library to the global library list:</p>
  523. </div>
  524. <div class="ulist">
  525. <ul>
  526. <li>
  527. <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>
  528. </li>
  529. <li>
  530. <p>Click &#8220;New Library&#8221;, enter a name for the library, and press <b class="button">OK</b>.</p>
  531. </li>
  532. <li>
  533. <p>In the &#8220;Classpath&#8221; tab, press &#8220;Add JAR/Folder&#8221; and select the jar file(s) needed for the library.</p>
  534. </li>
  535. <li>
  536. <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>
  537. </li>
  538. <li>
  539. <p>(Optional) In the &#8220;Sources&#8221; tab you can select a folder or jar file containing the source files of the library.</p>
  540. </li>
  541. <li>
  542. <p>Press <b class="button">OK</b>.</p>
  543. </li>
  544. </ul>
  545. </div>
  546. <div class="paragraph">
  547. <p>Add the library to a project:</p>
  548. </div>
  549. <div class="ulist">
  550. <ul>
  551. <li>
  552. <p><b class="button">RMB</b> select your project and select &#8220;Properties&#8221;.</p>
  553. </li>
  554. <li>
  555. <p>Select &#8220;Libaries&#8221; on the left and then press &#8220;Add Library&#8221;.</p>
  556. </li>
  557. <li>
  558. <p>Select the library from the list and press <b class="button">OK</b>.</p>
  559. </li>
  560. </ul>
  561. </div>
  562. <div class="paragraph">
  563. <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>
  564. </div>
  565. </div>
  566. <div class="sect2">
  567. <h3 id="application-deployment"><a class="anchor" href="#application-deployment"></a>Application Deployment</h3>
  568. <div class="ulist">
  569. <ul>
  570. <li>
  571. <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>
  572. </li>
  573. </ul>
  574. </div>
  575. </div>
  576. </div>
  577. </div>
  578. <div class="sect1">
  579. <h2 id="running-sample-projects"><a class="anchor" href="#running-sample-projects"></a>Running Sample Projects</h2>
  580. <div class="sectionbody">
  581. <div class="paragraph">
  582. <p>The SDK contains <a href="sample_code.html" class="page">Sample Code</a> (read more).</p>
  583. </div>
  584. <div class="paragraph">
  585. <p>Open the Source Packages node of the JmeTests project.</p>
  586. </div>
  587. <div class="ulist">
  588. <ul>
  589. <li>
  590. <p><b class="button">RMB</b> select the <code>JME3Tests</code> project and choose Run.<br>
  591. Choose samples from the TestChooser and try out the included demos.</p>
  592. </li>
  593. <li>
  594. <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>
  595. </li>
  596. <li>
  597. <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>
  598. </li>
  599. </ul>
  600. </div>
  601. </div>
  602. </div>
  603. </article>
  604. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  605. <div class="toc-menu"></div>
  606. </aside>
  607. </div>
  608. </main>
  609. </div>
  610. <footer class="footer">
  611. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  612. </footer>
  613. <script src="../../_/js/vendor/docsearch.min.js"></script>
  614. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
  615. <script>
  616. var search = docsearch({
  617. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  618. indexName: 'jmonkeyengine',
  619. inputSelector: '#search-input',
  620. autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  621. algoliaOptions: { hitsPerPage: 10 }
  622. }).autocomplete
  623. search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
  624. function focusSearchInput () { document.querySelector('#search-input').focus() }
  625. if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
  626. </script>
  627. <script src="../../_/js/site.js"></script>
  628. <script async src="../../_/js/vendor/highlight.js"></script>
  629. </body>
  630. </html>