index.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367
  1. <!DOCTYPE html>
  2. <html lang="en-us">
  3. <head>
  4. <title>jMonkeyEngine | Documentation</title>
  5. <meta name="viewport" content="width=device-width,minimum-scale=1">
  6. <link rel="stylesheet" href="/css/style.css">
  7. <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.1.9/p5.min.js" integrity="sha512-WIklPM6qPCIp6d3fSSr90j+1unQHUOoWDS4sdTiR8gxUTnyZ8S2Mr8e10sKKJ/bhJgpAa/qG068RDkg6fIlNFA==" crossorigin="anonymous"></script>
  8. <script src="/highlight/highlight.pack.js"></script>
  9. <script src="//cdnjs.cloudflare.com/ajax/libs/highlightjs-line-numbers.js/2.8.0/highlightjs-line-numbers.min.js"></script>
  10. <link rel="stylesheet" href="/highlight/styles/railscasts.css">
  11. <script type="text/javascript">
  12. hljs.initHighlightingOnLoad();
  13. hljs.initLineNumbersOnLoad();
  14. </script>
  15. <script src="/js/utils.js"></script>
  16. <script src="/js/showcase.js"></script>
  17. <script type="module" src="/js/Main.js"></script>
  18. <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
  19. </head>
  20. <body>
  21. <progress onload="startCyclingProgressBar()" max=100 value=0 id="pageLoadingProgress"></progress>
  22. <header> <nav class="responsiveWidth " id="topmenu">
  23. <div>
  24. <a href="/">
  25. <button class="genericCl responsiveIcon">
  26. <i class="fas fa-home"></i> <span>Home</span>
  27. </button>
  28. </a>
  29. <a href="https://hub.jmonkeyengine.org">
  30. <button class="genericCl responsiveIcon" >
  31. <i class="fab fa-discourse"></i> <span>Discussions</span>
  32. </button>
  33. </a>
  34. <a href="https://store.jmonkeyengine.org">
  35. <button class="genericCl responsiveIcon">
  36. <i class="fas fa-puzzle-piece"></i> <span>Store</span>
  37. </button>
  38. </a>
  39. <a href="/docs">
  40. <button class="genericCl responsiveIcon">
  41. <i class="fas fa-book"></i> <span>Docs</span>
  42. </button>
  43. </a>
  44. <a href="/license">
  45. <button class="genericCl responsiveIcon">
  46. <i class="fas fa-balance-scale-right"></i> <span>License</span>
  47. </button>
  48. </a>
  49. </div>
  50. <div>
  51. <a href="https://github.com/jMonkeyEngine/jmonkeyengine" rel='noopener noreferrer' target="_blank">
  52. <button class="icon codeCl" title="Github">
  53. <i class="fab fa-github-square"></i> <span>Github</span>
  54. </button>
  55. </a>
  56. <a href="https://twitter.com/jmonkeyengine" rel='noopener noreferrer' target="_blank">
  57. <button class="icon twitterCl" title="Follow on Twitter">
  58. <i class="fab fa-twitter"></i> <span>Twitter</span>
  59. </button>
  60. </a>
  61. <a href="https://www.youtube.com/channel/UC-Fs3R5Q6wW_XYspOXGZgPw" rel='noopener noreferrer' target="_blank">
  62. <button class="icon youtubeCl" title="Follow on Youtube">
  63. <i class="fab fa-youtube"></i> <span>Youtube</span>
  64. </button>
  65. </a>
  66. <a href="https://jmonkeyengine.itch.io/jMonkeyEngine" rel='noopener noreferrer' target="_blank">
  67. <button class="icon itchCl" title="Itch.io">
  68. <i class="fab fa-itch-io"></i> <span>Itch.io</span>
  69. </button>
  70. </a>
  71. <a href="https://discord.gg/Rv8sfVu" rel='noopener noreferrer' target="_blank">
  72. <button class="icon discordCl" title="Discord">
  73. <i class="fab fa-discord"></i> <span>Discord</span>
  74. </button>
  75. </a>
  76. <a href="https://opencollective.com/jmonkeyengine" rel='noopener noreferrer' target="_blank">
  77. <button class="icon donateCl" title="Donate">
  78. <i class="fas fa-donate"></i> <span>Donate!</span>
  79. </button>
  80. </a>
  81. </div>
  82. </nav>
  83. <div id="siteTitle" class="list hlist responsiveWidth">
  84. <div id="logo">
  85. <a href="/">
  86. <img src="/images/jme-logo.png" />
  87. </a>
  88. <i class="toggleNavOnPortraitButton fas fa-bars" toggle="topmenu"></i>
  89. </div>
  90. <div id="contributionsBanner">
  91. <div> <i class="fas fa-donate"></i>
  92. Backed by:
  93. <a rel='noopener nofollow noreferrer' target="_blank" id="backerName">The Community</a>
  94. <a rel='noopener nofollow noreferrer' target="_blank"
  95. href="https://opencollective.com/jmonkeyengine#section-contributors"> and more...</a>
  96. </div>
  97. <br />
  98. <div>
  99. <i class="fab fa-github-alt"></i>
  100. Contributed by:
  101. <a rel='noopener nofollow noreferrer' target="_blank" id="contributorName">The Community</a>
  102. <a rel='noopener nofollow noreferrer' target="_blank"
  103. href="https://github.com/jMonkeyEngine/jmonkeyengine/graphs/contributors">and more...</a>
  104. </div>
  105. </div>
  106. </div>
  107. </header>
  108. <main>
  109. <section id="showcase" mode="banner">
  110. <div class="showcaseElement" style='display: block ' >
  111. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/3.jpg'); " style=" "></div>
  112. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/3.jpg'); " style=" "></div>
  113. </div>
  114. <video class="showcaseElement cover" style='display: none ' preload="none" autoplay loop muted class="cover">
  115. <source src="https://steamcdn-a.akamaihd.net/steam/apps/256676876/movie_max.webm" type="video/webm">
  116. </video>
  117. <div class="showcaseElement" style='display: none ' >
  118. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/5.jpg'); " style=" "></div>
  119. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/5.jpg'); " style=" "></div>
  120. </div>
  121. <div class="showcaseElement" style='display: none ' >
  122. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/7.jpg'); " style=" "></div>
  123. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/7.jpg'); " style=" "></div>
  124. </div>
  125. <div class="showcaseElement" style='display: none ' >
  126. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/10.jpg'); " style=" "></div>
  127. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/10.jpg'); " style=" "></div>
  128. </div>
  129. <div class="showcaseElement" style='display: none ' >
  130. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/6.jpg'); " style=" "></div>
  131. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/6.jpg'); " style=" "></div>
  132. </div>
  133. <div class="showcaseElement" style='display: none ' >
  134. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/11.jpg'); " style=" "></div>
  135. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/11.jpg'); " style=" "></div>
  136. </div>
  137. <div class="showcaseElement" style='display: none ' >
  138. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/9.jpg'); " style=" "></div>
  139. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/9.jpg'); " style=" "></div>
  140. </div>
  141. <div class="showcaseElement" style='display: none ' >
  142. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/2.jpg'); " style=" "></div>
  143. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/2.jpg'); " style=" "></div>
  144. </div>
  145. <div class="showcaseElement" style='display: none ' >
  146. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/4.jpg'); " style=" "></div>
  147. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/4.jpg'); " style=" "></div>
  148. </div>
  149. <div class="showcaseElement" style='display: none ' >
  150. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/1.jpg'); " style=" "></div>
  151. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/1.jpg'); " style=" "></div>
  152. </div>
  153. <div class="showcaseElement" style='display: none ' >
  154. <div class="cover blur" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/8.jpg'); " style=" "></div>
  155. <div class="cover" lazy="true" lazy-style="background-image: url('/images/showcase/ls_frontier/8.jpg'); " style=" "></div>
  156. </div>
  157. <div class="responsiveWidth" id="engineDescription">
  158. jMonkeyEngine is a modern developer friendly game engine written primarily in Java.
  159. <br />
  160. Its minimalistic and code first approach makes it perfect for developers who want the support of a game engine
  161. while retaining full control over their code with the ability to extend and adapt the engine to their workflow.
  162. <br />
  163. <br />
  164. <br />
  165. <a href="/start/#content"><button id="startbtn" class="highlightedCl"><i class="fas fa-rocket"></i> Get Started... </button></a>
  166. <br />
  167. <br />
  168. </div>
  169. <div class="responsiveWidth" >
  170. <div id="gameDescription" >
  171. <h2><i class="far fa-images" ></i> Lightspeed Frontier powered by jMonkeyEngine</h2>
  172. Leave everything behind and try your hand at captaining a ship on the frontier of the galaxy. Customize it piece by piece to tackle whatever adventures await you. Take on crime lords and space pirates …
  173. <br />
  174. <a class="readMore" href="/showcase/ls_frontier/#showcase">See game page </a>
  175. </div>
  176. </div>
  177. </section>
  178. <br/>
  179. <section class="message list vlist">
  180. <div>
  181. <blockquote class="list vlist responsive">
  182. <span id="backerMessage">-</span>
  183. <i><a rel='noopener nofollow noreferrer' target="_blank" id="backerMessageName">-</a> </i>
  184. </blockquote>
  185. <a href="https://opencollective.com/jmonkeyengine">Become a
  186. backer and leave a message...</a>
  187. </div>
  188. </section>
  189. <br/>
  190. <section class="full responsiveWidth">
  191. <article>
  192. <h1 id="content">
  193. <i class="fas fa-paragraph useless"></i>
  194. Documentation</h1>
  195. <div class="content">
  196. <span>
  197. <p>Browse through our various forms of information to help you better understand the engine.</p>
  198. <h3 id="engine-wikihttpswikijmonkeyengineorg"><a href="https://wiki.jmonkeyengine.org">Engine Wiki</a></h3>
  199. <p>The wiki provides extended documentation as well as tutorials on how to develop your game effectively using jmonkey practices. Tutorials start from the basics all the way up to collision detection, input mapping and shaders, and will be your go-to place for most of the information you require.</p>
  200. <h3 id="javadochttpsjavadocjmonkeyengineorg"><a href="https://javadoc.jmonkeyengine.org">JavaDoc</a></h3>
  201. <p>JavaDocs are source-code documentation that help you understand what specific methods and classes do. These snippets of information describe the parameters and return values and other key information to help you understand the engine better.</p>
  202. <h3 id="community-hubhttpshubjmonkeyengineorg"><a href="https://hub.jmonkeyengine.org">Community Hub</a></h3>
  203. <p>Our community has an excellent standing in supporting developers that need help. We have a thriving collection of knowledgable users that are super-helpful. If you ever find yourself confused or wondering how something is done, head over to our community hub and create a new thread. Our ultra-helpful team and community will be more than happy to give you a hand in getting you back on track.</p>
  204. <p>To get the most helpful answers, it may be useful to understand <a href="https://www.mikeash.com/getting_answers.html">how to get the best answers</a> to your question. Providing source code, explaining what you have tried, why it didn&rsquo;t work and any other relevant details will speed up the process of giving you a relevant answer.</p>
  205. <h3 id="discordhttpsdiscordggjdjhsrw"><a href="https://discord.gg/JdjhsRw">Discord</a></h3>
  206. <p>Our official discord server is full of friendly members that can provide useful advice through chat. Whilst a chat server is not always the best place for comprehensive answers, it does serve as a great tool for quick solutions and getting to know the members better.</p>
  207. <h3 id="scene-graph-for-dummieshttpswikijmonkeyengineorgtutorialsscenegraphassetsfallbackindexhtml"><a href="https://wiki.jmonkeyengine.org/tutorials/scenegraph/assets/fallback/index.html">Scene Graph for Dummies</a></h3>
  208. <p>A slideshow explaining how to use the scene graph in jMonkey. This guide explains how to use the scene graph effectively and understand the relationships involved. <strong>Highly recommended</strong> for all new users to the gaming industry.</p>
  209. <ul>
  210. <li>What the scene graph is and what a <code>Spatial</code> is.</li>
  211. <li>What a <code>Geometry</code> is and how it&rsquo;s appearance is defined.</li>
  212. <li>What a <code>Node</code> is and what a parent-child relationship is.</li>
  213. <li>How to organize the scene graph visually and logically using nodes.</li>
  214. <li>How to hide single Spatials or whole parts of the scene graph.</li>
  215. </ul>
  216. <h3 id="math-for-dummies-jme-vector-mathhttpswikijmonkeyengineorgtutorialsmathassetsfallbackindexhtml"><a href="https://wiki.jmonkeyengine.org/tutorials/math/assets/fallback/index.html">Math For Dummies: JME Vector Math</a></h3>
  217. <p>A slideshow explaining how to use vectors and quaternions in jMonkey. This guide is extremely useful to new game developers trying to understand locations, directions and rotations. Recommended for all new users to the gaming industry.</p>
  218. <ul>
  219. <li>What vectors are and how to create them.</li>
  220. <li>How to add, subtract, multiply and normalize vectors.</li>
  221. <li>How to interpolate between vectors.</li>
  222. <li>What quaternions are and how to creat them.</li>
  223. <li>How to rotate a vector using a quaternion.</li>
  224. <li>How to combine rotations.</li>
  225. <li>How to use <code>lookAt</code> to create rotations.</li>
  226. </ul>
  227. <h3 id="transparency-for-dummieshttpshubjmonkeyengineorgtalpha-transparency-sorting-your-z-buffer-and-you33709"><a href="https://hub.jmonkeyengine.org/t/alpha-transparency-sorting-your-z-buffer-and-you/33709">Transparency for Dummies</a></h3>
  228. <p>This document explains some of the issues surrounding transparency, what sorting means and how to solve common problems surrounding transparency.</p>
  229. </span>
  230. <nav>
  231. <ul class="postedDate smaller">
  232. <h3 class="postedDate">Date</h3>
  233. <li><time datetime="0001-01-01 00:00:00 &#43;0000 UTC"><i class="fas fa-calendar"></i>01 January 0001</time> </li>
  234. </ul>
  235. <ul class="share">
  236. <h3 class="share">Share</h3>
  237. <li>
  238. <button><a href="https://twitter.com/share?ref_src=twsrc%5Etfw" ><i class="fab fa-twitter-square"></i> Share on Twitter</a></button></li>
  239. </ul>
  240. </nav>
  241. </div>
  242. </article>
  243. </section>
  244. </main>
  245. <footer></footer>
  246. </body>
  247. </html>