build_platform.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  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>build_platform :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/sdk/build_platform.html">
  8. <meta name="keywords" content="documentation, sdk, builds, project">
  9. <meta name="generator" content="Antora 2.3.3">
  10. <link rel="stylesheet" href="../../_/css/site.css">
  11. <meta property="og:image" content="https://mitm001.github.io/docs.jmonkeyengine.org/_/img/iconx128.png">
  12. <meta property="og:description" content="build_platform">
  13. <meta property="og:title" content="jMonkeyEngine Docs">
  14. <link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  15. </head>
  16. <body class="article">
  17. <header class="header">
  18. <nav class="navbar">
  19. <div class="navbar-brand">
  20. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  21. <img alt="" src="../../_/img/iconx128.png" width="32" type="image/x-icon" style="margin-right:16px">
  22. jMonkeyEngine Docs
  23. </a>
  24. <button class="navbar-burger" data-target="topbar-nav">
  25. <span></span>
  26. <span></span>
  27. <span></span>
  28. </button>
  29. </div>
  30. <div id="topbar-nav" class="navbar-menu">
  31. <div class="navbar-end">
  32. <div class="navbar-item theme-switch-wrapper">
  33. <label class="theme-switch" for="checkbox">
  34. <input type="checkbox" id="checkbox" />
  35. <div class="slider round"></div>
  36. </label>
  37. <p class="navlabel">Dark Mode</p>
  38. </div>
  39. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  40. </div>
  41. </div>
  42. </nav>
  43. </header>
  44. <div class="body">
  45. <div class="nav-container" data-component="docs" data-version="master">
  46. <aside class="nav">
  47. <div class="panels">
  48. <div class="nav-panel-menu is-active" data-panel="menu">
  49. <nav class="nav-menu">
  50. <h3 class="title"><a href="../jme3.html">Docs</a></h3>
  51. <ul class="nav-list">
  52. <li class="nav-item" data-depth="0">
  53. <ul class="nav-list">
  54. <li class="nav-item" data-depth="1">
  55. <a class="nav-link" href="../documentation.html">Getting Started</a>
  56. </li>
  57. <li class="nav-item" data-depth="1">
  58. <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  59. </li>
  60. <li class="nav-item" data-depth="1">
  61. <button class="nav-item-toggle"></button>
  62. <a class="nav-link" href="../jme3.html">jMonkeyEngine 3</a>
  63. <ul class="nav-list">
  64. <li class="nav-item" data-depth="2">
  65. <button class="nav-item-toggle"></button>
  66. <span class="nav-text">Beginner Tutorials</span>
  67. <ul class="nav-list">
  68. <li class="nav-item" data-depth="3">
  69. <a class="nav-link" href="../jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  70. </li>
  71. <li class="nav-item" data-depth="3">
  72. <a class="nav-link" href="../jme3/beginner/hello_node.html">Hello Node</a>
  73. </li>
  74. <li class="nav-item" data-depth="3">
  75. <a class="nav-link" href="../jme3/beginner/hello_asset.html">Hello Asset</a>
  76. </li>
  77. <li class="nav-item" data-depth="3">
  78. <a class="nav-link" href="../jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  79. </li>
  80. <li class="nav-item" data-depth="3">
  81. <a class="nav-link" href="../jme3/beginner/hello_input_system.html">Hello Input System</a>
  82. </li>
  83. <li class="nav-item" data-depth="3">
  84. <a class="nav-link" href="../jme3/beginner/hello_material.html">Hello Material</a>
  85. </li>
  86. <li class="nav-item" data-depth="3">
  87. <a class="nav-link" href="../jme3/beginner/hello_animation.html">Hello Animation</a>
  88. </li>
  89. <li class="nav-item" data-depth="3">
  90. <a class="nav-link" href="../jme3/beginner/hello_picking.html">Hello Picking</a>
  91. </li>
  92. <li class="nav-item" data-depth="3">
  93. <a class="nav-link" href="../jme3/beginner/hello_collision.html">Hello Collision</a>
  94. </li>
  95. <li class="nav-item" data-depth="3">
  96. <a class="nav-link" href="../jme3/beginner/hello_terrain.html">Hello Terrain</a>
  97. </li>
  98. <li class="nav-item" data-depth="3">
  99. <a class="nav-link" href="../jme3/beginner/hello_audio.html">Hello Audio</a>
  100. </li>
  101. <li class="nav-item" data-depth="3">
  102. <a class="nav-link" href="../jme3/beginner/hello_effects.html">Hello Effects</a>
  103. </li>
  104. <li class="nav-item" data-depth="3">
  105. <a class="nav-link" href="../jme3/beginner/hello_physics.html">Hello Physics</a>
  106. </li>
  107. </ul>
  108. </li>
  109. <li class="nav-item" data-depth="2">
  110. <button class="nav-item-toggle"></button>
  111. <span class="nav-text">Intermediate Tutorials</span>
  112. <ul class="nav-list">
  113. <li class="nav-item" data-depth="3">
  114. <button class="nav-item-toggle"></button>
  115. <span class="nav-text">Concepts</span>
  116. <ul class="nav-list">
  117. <li class="nav-item" data-depth="4">
  118. <a class="nav-link" href="../jme3/intermediate/best_practices.html">Best Practices</a>
  119. </li>
  120. <li class="nav-item" data-depth="4">
  121. <a class="nav-link" href="../jme3/intermediate/simpleapplication.html">Simple Application</a>
  122. </li>
  123. <li class="nav-item" data-depth="4">
  124. <a class="nav-link" href="../jme3/features.html">Features</a>
  125. </li>
  126. <li class="nav-item" data-depth="4">
  127. <a class="nav-link" href="../jme3/intermediate/optimization.html">Optimization</a>
  128. </li>
  129. <li class="nav-item" data-depth="4">
  130. <a class="nav-link" href="../jme3/faq.html">FAQ</a>
  131. </li>
  132. </ul>
  133. </li>
  134. <li class="nav-item" data-depth="3">
  135. <button class="nav-item-toggle"></button>
  136. <span class="nav-text">Math Concepts</span>
  137. <ul class="nav-list">
  138. <li class="nav-item" data-depth="4">
  139. <a class="nav-link" href="../jme3/math_for_dummies.html">Math For Dummies</a>
  140. </li>
  141. <li class="nav-item" data-depth="4">
  142. <a class="nav-link" href="../jme3/intermediate/math.html">Math</a>
  143. </li>
  144. <li class="nav-item" data-depth="4">
  145. <a class="nav-link" href="../jme3/math.html">More Math</a>
  146. </li>
  147. <li class="nav-item" data-depth="4">
  148. <a class="nav-link" href="../jme3/rotate.html">Rotate</a>
  149. </li>
  150. <li class="nav-item" data-depth="4">
  151. <a class="nav-link" href="../jme3/math_video_tutorials.html">Math Video Tutorials</a>
  152. </li>
  153. </ul>
  154. </li>
  155. <li class="nav-item" data-depth="3">
  156. <button class="nav-item-toggle"></button>
  157. <span class="nav-text">3D Graphics Concepts</span>
  158. <ul class="nav-list">
  159. <li class="nav-item" data-depth="4">
  160. <a class="nav-link" href="../jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  161. </li>
  162. <li class="nav-item" data-depth="4">
  163. <a class="nav-link" href="../jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  164. </li>
  165. <li class="nav-item" data-depth="4">
  166. <a class="nav-link" href="../jme3/beginner/hellovector.html">Hello Vector</a>
  167. </li>
  168. <li class="nav-item" data-depth="4">
  169. <a class="nav-link" href="../jme3/terminology.html">Terminology</a>
  170. </li>
  171. <li class="nav-item" data-depth="4">
  172. <a class="nav-link" href="../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  173. </li>
  174. <li class="nav-item" data-depth="4">
  175. <a class="nav-link" href="../jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  176. </li>
  177. <li class="nav-item" data-depth="4">
  178. <a class="nav-link" href="../jme3/external/blender.html">Importing from Blender</a>
  179. </li>
  180. <li class="nav-item" data-depth="4">
  181. <a class="nav-link" href="../jme3/external/3dsmax.html">Importing from 3DS Max</a>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </li>
  187. </ul>
  188. </li>
  189. <li class="nav-item" data-depth="1">
  190. <a class="nav-link" href="../logo.html">Logo Usage</a>
  191. </li>
  192. <li class="nav-item" data-depth="1">
  193. <a class="nav-link" href="../bsd_license.html">License</a>
  194. </li>
  195. <li class="nav-item" data-depth="1">
  196. <a class="nav-link" href="../github_tips.html">Github Tips</a>
  197. </li>
  198. </ul>
  199. </li>
  200. <li class="nav-item" data-depth="0">
  201. <button class="nav-item-toggle"></button>
  202. <span class="nav-text">SDK</span>
  203. <ul class="nav-list">
  204. <li class="nav-item" data-depth="1">
  205. <a class="nav-link" href="../sdk.html">jMonkeyEngine SDK</a>
  206. </li>
  207. </ul>
  208. </li>
  209. </ul>
  210. </nav>
  211. </div>
  212. <div class="nav-panel-explore" data-panel="explore">
  213. <div class="context">
  214. <span class="title">Docs</span>
  215. <span class="version">master</span>
  216. </div>
  217. <ul class="components">
  218. <li class="component is-current">
  219. <span class="title">Docs</span>
  220. <ul class="versions">
  221. <li class="version is-current is-latest">
  222. <a href="../jme3.html">master</a>
  223. </li>
  224. </ul>
  225. </li>
  226. <li class="component">
  227. <span class="title">Wiki UI</span>
  228. <ul class="versions">
  229. <li class="version is-latest">
  230. <a href="../../wiki-ui/index.html">master</a>
  231. </li>
  232. </ul>
  233. </li>
  234. </ul>
  235. </div>
  236. </div>
  237. </aside>
  238. </div>
  239. <main class="article">
  240. <div class="toolbar" role="navigation">
  241. <button class="nav-toggle"></button>
  242. <nav class="breadcrumbs" aria-label="breadcrumbs">
  243. <ul>
  244. <li><a href="../jme3.html">Docs</a></li>
  245. <li><a href="build_platform.html">build_platform</a></li>
  246. </ul>
  247. </nav>
  248. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/sdk/build_platform.adoc">Edit this Page</a></div>
  249. </div>
  250. <div class="content">
  251. <article class="doc">
  252. <h1 class="page">build_platform</h1>
  253. <div class="sect1">
  254. <h2 id="building-jmonkeyengine-sdk-yourself"><a class="anchor" href="#building-jmonkeyengine-sdk-yourself"></a>Building jMonkeyEngine SDK Yourself</h2>
  255. <div class="sectionbody">
  256. <div class="sect2">
  257. <h3 id="in-the-jmonkeyengine-sdk-or-netbeans"><a class="anchor" href="#in-the-jmonkeyengine-sdk-or-netbeans"></a>In the jMonkeyEngine SDK or NetBeans</h3>
  258. <div class="sect3">
  259. <h4 id="plugins"><a class="anchor" href="#plugins"></a>Plugins</h4>
  260. <div class="paragraph">
  261. <p>Make sure all necessary plugins are installed and active:</p>
  262. </div>
  263. <div class="ulist">
  264. <ul>
  265. <li>
  266. <p>From the menu bar, select <code>Tools</code> → <code>Plugins</code> to open a <code>Plugins</code> dialog.</p>
  267. </li>
  268. <li>
  269. <p>Select the <code>Available Plugins</code> tab.</p>
  270. </li>
  271. <li>
  272. <p>Sort the plugin list by category.</p>
  273. </li>
  274. <li>
  275. <p>Check the <code>Install</code> checkbox for any plugins in the <code>Developing NetBeans</code> category.</p>
  276. </li>
  277. <li>
  278. <p>Click on the <code>Install</code> button and complete the wizard.</p>
  279. </li>
  280. <li>
  281. <p>Select the <code>Installed</code> tab.</p>
  282. </li>
  283. <li>
  284. <p>Activate any inactive plugins in the <code>Developing NetBeans</code> category.</p>
  285. </li>
  286. <li>
  287. <p>Close the <code>Plugins</code> dialog.</p>
  288. </li>
  289. </ul>
  290. </div>
  291. </div>
  292. <div class="sect3">
  293. <h4 id="checkout"><a class="anchor" href="#checkout"></a>Checkout</h4>
  294. <div class="ulist">
  295. <ul>
  296. <li>
  297. <p>From the menu bar, select <code>Team</code> → <code>Git</code> → <code>Clone</code> to open a <code>Clone Repository</code> dialog.</p>
  298. </li>
  299. <li>
  300. <p>In the <code>Repository <abbr title="Uniform Resource Locator">URL</abbr>:</code> textbox, type <code><a href="https://github.com/jMonkeyEngine/jmonkeyengine">https://github.com/jMonkeyEngine/jmonkeyengine</a></code>.</p>
  301. </li>
  302. <li>
  303. <p>Clear the <code>User:</code> and <code>Password:</code> textboxes.</p>
  304. </li>
  305. <li>
  306. <p>Click on the <code>Next</code> button.</p>
  307. </li>
  308. <li>
  309. <p>Choose the remote branch, typically “master, and click the Next button.</p>
  310. </li>
  311. <li>
  312. <p>Click on the <code>Browse…</code> button to the right of the <code>Parent directory:</code> textbox to open a <code>Browse Local Folder</code> dialog.</p>
  313. </li>
  314. <li>
  315. <p>Select an empty or non-existent directory (folder) where you want to save the jMonkeyEngine sources on your hard drive.</p>
  316. </li>
  317. <li>
  318. <p>Click the <code>Finish</code> button.</p>
  319. </li>
  320. </ul>
  321. </div>
  322. <div class="paragraph">
  323. <p>Project checkout may take awhile. Do not proceed before the task is complete.</p>
  324. </div>
  325. </div>
  326. <div class="sect3">
  327. <h4 id="build"><a class="anchor" href="#build"></a>Build</h4>
  328. <div class="paragraph">
  329. <p>On the commandline:</p>
  330. </div>
  331. <div class="olist arabic">
  332. <ol class="arabic">
  333. <li>
  334. <p><code>cd jmonkeyengine</code></p>
  335. </li>
  336. <li>
  337. <p><code>./gradlew build</code></p>
  338. </li>
  339. </ol>
  340. </div>
  341. <div class="paragraph">
  342. <p>From the SDK:</p>
  343. </div>
  344. <div class="ulist">
  345. <ul>
  346. <li>
  347. <p>From the menu bar, select <code>File</code> → <code>Open project…</code> to open an <code>Open Project</code> dialog.</p>
  348. </li>
  349. <li>
  350. <p>Highlight the free-form project folder you used for checkout and click on the <code>Open Project</code> button.</p>
  351. <div class="ulist">
  352. <ul>
  353. <li>
  354. <p>A new free-form project named <code>jME3-SDK</code> should appear in the SDK&#8217;s <code>Projects</code> window.</p>
  355. </li>
  356. </ul>
  357. </div>
  358. </li>
  359. <li>
  360. <p>Build the free-form project by right-clicking on it and selecting <code>Build</code>.</p>
  361. </li>
  362. <li>
  363. <p>Wait until the <code>jME3-SDK (build)</code> task is complete. At one point, a web browser window may open.</p>
  364. </li>
  365. <li>
  366. <p>From the menu bar, select <code>File</code> → <code>Open project…</code> to open an <code>Open Project</code> dialog.</p>
  367. </li>
  368. <li>
  369. <p>Browse into the free-form project folder, highlight the <code>sdk</code> node, and click on the <code>Open Project</code> button.</p>
  370. <div class="ulist">
  371. <ul>
  372. <li>
  373. <p>A number of new projects should appear in the SDK&#8217;s <code>Projects</code> window.</p>
  374. </li>
  375. </ul>
  376. </div>
  377. </li>
  378. </ul>
  379. </div>
  380. <div class="paragraph">
  381. <p>Building the main freeform project copies the jME3 libraries to the sdk, so you should run its build script each time jME3 changes.</p>
  382. </div>
  383. </div>
  384. <div class="sect3">
  385. <h4 id="run"><a class="anchor" href="#run"></a>Run</h4>
  386. <div class="ulist">
  387. <ul>
  388. <li>
  389. <p>In the SDK&#8217;s <code>Projects</code> window, right-click on the <code>jMonkeyEngine SDK</code> project and select <code>Run</code>.</p>
  390. <div class="ulist">
  391. <ul>
  392. <li>
  393. <p>The SDK you just built will start executing in a new window.</p>
  394. </li>
  395. </ul>
  396. </div>
  397. </li>
  398. </ul>
  399. </div>
  400. </div>
  401. </div>
  402. </div>
  403. </div>
  404. </article>
  405. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  406. <div class="toc-menu"></div>
  407. </aside>
  408. </div>
  409. </main>
  410. </div>
  411. <footer class="footer">
  412. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  413. </footer>
  414. <script src="../../_/js/site.js"></script>
  415. <script async src="../../_/js/vendor/highlight.js"></script>
  416. </body>
  417. </html>