multiplayer_template.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  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>multiplayer_template :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/multiplayer_template.html">
  8. <meta name="generator" content="Antora 2.3.3">
  9. <link rel="stylesheet" href="../_/css/site.css">
  10. <meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
  11. <meta property="og:description" content="multiplayer_template">
  12. <meta property="og:title" content="jMonkeyEngine Docs">
  13. <link rel="stylesheet" href="../_/css/site-extra.css">
  14. <link rel="stylesheet" href="../_/css/vendor/docsearch.min.css">
  15. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
  16. <link rel="icon" href="../_/img/favicon.ico" type="image/x-icon">
  17. </head>
  18. <body class="article">
  19. <header class="header">
  20. <nav class="navbar">
  21. <div class="navbar-brand">
  22. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  23. <img alt="" src="../_/img/jme-logo.png" height="32" type="image/x-icon">
  24. </a>
  25. <div class="navbar-item hide-for-print">
  26. <input id="search-input" type="text" placeholder="Search docs">
  27. </div>
  28. <button class="navbar-burger" data-target="topbar-nav">
  29. <span></span>
  30. <span></span>
  31. <span></span>
  32. </button>
  33. </div>
  34. <div id="topbar-nav" class="navbar-menu">
  35. <div class="navbar-end">
  36. <div class="navbar-item theme-switch-wrapper">
  37. <label class="theme-switch" for="checkbox">
  38. <input type="checkbox" id="checkbox" />
  39. <div class="slider round"></div>
  40. </label>
  41. </div>
  42. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  43. </div>
  44. </div>
  45. </nav>
  46. </header>
  47. <div class="body">
  48. <div class="nav-container" data-component="docs" data-version="master">
  49. <aside class="nav">
  50. <div class="panels">
  51. <div class="nav-panel-menu is-active" data-panel="menu">
  52. <nav class="nav-menu">
  53. <h3 class="title"><a href="documentation.html">Docs</a></h3>
  54. <ul class="nav-list">
  55. <li class="nav-item" data-depth="0">
  56. <ul class="nav-list">
  57. <li class="nav-item" data-depth="1">
  58. <a class="nav-link" href="documentation.html">Getting Started</a>
  59. </li>
  60. <li class="nav-item" data-depth="1">
  61. <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  62. </li>
  63. <li class="nav-item" data-depth="1">
  64. <button class="nav-item-toggle"></button>
  65. <a class="nav-link" href="jme3.html">jMonkeyEngine 3</a>
  66. <ul class="nav-list">
  67. <li class="nav-item" data-depth="2">
  68. <button class="nav-item-toggle"></button>
  69. <span class="nav-text">Beginner Tutorials</span>
  70. <ul class="nav-list">
  71. <li class="nav-item" data-depth="3">
  72. <a class="nav-link" href="jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  73. </li>
  74. <li class="nav-item" data-depth="3">
  75. <a class="nav-link" href="jme3/beginner/hello_node.html">Hello Node</a>
  76. </li>
  77. <li class="nav-item" data-depth="3">
  78. <a class="nav-link" href="jme3/beginner/hello_asset.html">Hello Asset</a>
  79. </li>
  80. <li class="nav-item" data-depth="3">
  81. <a class="nav-link" href="jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  82. </li>
  83. <li class="nav-item" data-depth="3">
  84. <a class="nav-link" href="jme3/beginner/hello_input_system.html">Hello Input System</a>
  85. </li>
  86. <li class="nav-item" data-depth="3">
  87. <a class="nav-link" href="jme3/beginner/hello_material.html">Hello Material</a>
  88. </li>
  89. <li class="nav-item" data-depth="3">
  90. <a class="nav-link" href="jme3/beginner/hello_animation.html">Hello Animation</a>
  91. </li>
  92. <li class="nav-item" data-depth="3">
  93. <a class="nav-link" href="jme3/beginner/hello_picking.html">Hello Picking</a>
  94. </li>
  95. <li class="nav-item" data-depth="3">
  96. <a class="nav-link" href="jme3/beginner/hello_collision.html">Hello Collision</a>
  97. </li>
  98. <li class="nav-item" data-depth="3">
  99. <a class="nav-link" href="jme3/beginner/hello_terrain.html">Hello Terrain</a>
  100. </li>
  101. <li class="nav-item" data-depth="3">
  102. <a class="nav-link" href="jme3/beginner/hello_audio.html">Hello Audio</a>
  103. </li>
  104. <li class="nav-item" data-depth="3">
  105. <a class="nav-link" href="jme3/beginner/hello_effects.html">Hello Effects</a>
  106. </li>
  107. <li class="nav-item" data-depth="3">
  108. <a class="nav-link" href="jme3/beginner/hello_physics.html">Hello Physics</a>
  109. </li>
  110. </ul>
  111. </li>
  112. <li class="nav-item" data-depth="2">
  113. <button class="nav-item-toggle"></button>
  114. <span class="nav-text">Intermediate Tutorials</span>
  115. <ul class="nav-list">
  116. <li class="nav-item" data-depth="3">
  117. <button class="nav-item-toggle"></button>
  118. <span class="nav-text">Concepts</span>
  119. <ul class="nav-list">
  120. <li class="nav-item" data-depth="4">
  121. <a class="nav-link" href="jme3/intermediate/best_practices.html">Best Practices</a>
  122. </li>
  123. <li class="nav-item" data-depth="4">
  124. <a class="nav-link" href="jme3/intermediate/simpleapplication.html">Simple Application</a>
  125. </li>
  126. <li class="nav-item" data-depth="4">
  127. <a class="nav-link" href="jme3/features.html">Features</a>
  128. </li>
  129. <li class="nav-item" data-depth="4">
  130. <a class="nav-link" href="jme3/intermediate/optimization.html">Optimization</a>
  131. </li>
  132. <li class="nav-item" data-depth="4">
  133. <a class="nav-link" href="jme3/faq.html">FAQ</a>
  134. </li>
  135. </ul>
  136. </li>
  137. <li class="nav-item" data-depth="3">
  138. <button class="nav-item-toggle"></button>
  139. <span class="nav-text">Math Concepts</span>
  140. <ul class="nav-list">
  141. <li class="nav-item" data-depth="4">
  142. <a class="nav-link" href="jme3/math_for_dummies.html">Math For Dummies</a>
  143. </li>
  144. <li class="nav-item" data-depth="4">
  145. <a class="nav-link" href="jme3/intermediate/math.html">Math</a>
  146. </li>
  147. <li class="nav-item" data-depth="4">
  148. <a class="nav-link" href="jme3/math.html">More Math</a>
  149. </li>
  150. <li class="nav-item" data-depth="4">
  151. <a class="nav-link" href="jme3/rotate.html">Rotate</a>
  152. </li>
  153. <li class="nav-item" data-depth="4">
  154. <a class="nav-link" href="jme3/math_video_tutorials.html">Math Video Tutorials</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-item" data-depth="3">
  159. <button class="nav-item-toggle"></button>
  160. <span class="nav-text">3D Graphics Concepts</span>
  161. <ul class="nav-list">
  162. <li class="nav-item" data-depth="4">
  163. <a class="nav-link" href="jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  164. </li>
  165. <li class="nav-item" data-depth="4">
  166. <a class="nav-link" href="jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  167. </li>
  168. <li class="nav-item" data-depth="4">
  169. <a class="nav-link" href="jme3/beginner/hellovector.html">Hello Vector</a>
  170. </li>
  171. <li class="nav-item" data-depth="4">
  172. <a class="nav-link" href="jme3/terminology.html">Terminology</a>
  173. </li>
  174. <li class="nav-item" data-depth="4">
  175. <a class="nav-link" href="jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  176. </li>
  177. <li class="nav-item" data-depth="4">
  178. <a class="nav-link" href="jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  179. </li>
  180. <li class="nav-item" data-depth="4">
  181. <a class="nav-link" href="jme3/external/blender.html">Importing from Blender</a>
  182. </li>
  183. <li class="nav-item" data-depth="4">
  184. <a class="nav-link" href="jme3/external/3dsmax.html">Importing from 3DS Max</a>
  185. </li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </li>
  192. <li class="nav-item" data-depth="1">
  193. <a class="nav-link" href="logo.html">Logo Usage</a>
  194. </li>
  195. <li class="nav-item" data-depth="1">
  196. <a class="nav-link" href="bsd_license.html">License</a>
  197. </li>
  198. <li class="nav-item" data-depth="1">
  199. <a class="nav-link" href="github_tips.html">Github Tips</a>
  200. </li>
  201. </ul>
  202. </li>
  203. <li class="nav-item" data-depth="0">
  204. <button class="nav-item-toggle"></button>
  205. <span class="nav-text">SDK</span>
  206. <ul class="nav-list">
  207. <li class="nav-item" data-depth="1">
  208. <a class="nav-link" href="sdk.html">jMonkeyEngine SDK</a>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </nav>
  214. </div>
  215. <div class="nav-panel-explore" data-panel="explore">
  216. <div class="context">
  217. <span class="title">Docs</span>
  218. <span class="version">master</span>
  219. </div>
  220. <ul class="components">
  221. <li class="component is-current">
  222. <span class="title">Docs</span>
  223. <ul class="versions">
  224. <li class="version is-current is-latest">
  225. <a href="documentation.html">master</a>
  226. </li>
  227. </ul>
  228. </li>
  229. <li class="component">
  230. <span class="title">Wiki UI</span>
  231. <ul class="versions">
  232. <li class="version is-latest">
  233. <a href="../wiki-ui/index.html">master</a>
  234. </li>
  235. </ul>
  236. </li>
  237. </ul>
  238. </div>
  239. </div>
  240. </aside>
  241. </div>
  242. <main class="article">
  243. <div class="toolbar" role="navigation">
  244. <button class="nav-toggle"></button>
  245. <nav class="breadcrumbs" aria-label="breadcrumbs">
  246. <ul>
  247. <li><a href="documentation.html">Docs</a></li>
  248. <li><a href="multiplayer_template.html">multiplayer_template</a></li>
  249. </ul>
  250. </nav>
  251. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/multiplayer_template.adoc">Edit this Page</a></div>
  252. </div>
  253. <div class="content">
  254. <article class="doc">
  255. <h1 class="page">multiplayer_template</h1>
  256. <div class="paragraph">
  257. <p>This page is to make your own multiplayer game, mainly by using a template and understanding how it works.</p>
  258. </div>
  259. <div class="paragraph">
  260. <p>The template for a multiplayer project can be found here:
  261. <a href="http://hub.jmonkeyengine.org/forum/topic/multiplayer-game-template/">http://hub.jmonkeyengine.org/forum/topic/multiplayer-game-template/</a></p>
  262. </div>
  263. <div class="paragraph">
  264. <p>Additional information e.g. links to jars can be found here:
  265. <a href="http://hub.jmonkeyengine.org/forum/topic/need-help-need-jar-files-for-a-project/#post-292081">http://hub.jmonkeyengine.org/forum/topic/need-help-need-jar-files-for-a-project/#post-292081</a></p>
  266. </div>
  267. <div class="paragraph">
  268. <p>Class diagram (template only):
  269. <a href="http://puu.sh/a4azI/8c37cd8cf4.png">http://puu.sh/a4azI/8c37cd8cf4.png</a></p>
  270. </div>
  271. <div class="paragraph">
  272. <p>A lot of work has to be done, but the best thing to start with, is summing up the classes, with the variables and explaining what the use is of those.</p>
  273. </div>
  274. <div class="paragraph">
  275. <p>Classes (by package):</p>
  276. </div>
  277. <div class="paragraph">
  278. <p>NetworkRpg:</p>
  279. </div>
  280. <div class="olist arabic">
  281. <ol class="arabic">
  282. <li>
  283. <p>GameClient (Interface)</p>
  284. </li>
  285. <li>
  286. <p>GameConstants</p>
  287. </li>
  288. <li>
  289. <p>GameGuiController</p>
  290. </li>
  291. <li>
  292. <p>Main</p>
  293. </li>
  294. </ol>
  295. </div>
  296. <div class="literalblock">
  297. <div class="content">
  298. <pre> private AppSettings settings; sets the resolution
  299. private boolean isFullScreen = false; obvious: fullscreen</pre>
  300. </div>
  301. </div>
  302. <div class="olist arabic">
  303. <ol class="arabic">
  304. <li>
  305. <p>MenuInputMapping (No variables)</p>
  306. </li>
  307. <li>
  308. <p>RemoteGameClient</p>
  309. </li>
  310. <li>
  311. <p>ServerMain</p>
  312. </li>
  313. <li>
  314. <p>ThirdPersonCamera</p>
  315. </li>
  316. <li>
  317. <p>TimeProvider (Interface)</p>
  318. </li>
  319. </ol>
  320. </div>
  321. <div class="paragraph">
  322. <p>NetworkRpg.AppStates:</p>
  323. </div>
  324. <div class="olist arabic">
  325. <ol class="arabic">
  326. <li>
  327. <p>BaseAppState</p>
  328. </li>
  329. <li>
  330. <p>ConnectionState</p>
  331. </li>
  332. <li>
  333. <p>EntityDataState</p>
  334. </li>
  335. <li>
  336. <p>ErrorState</p>
  337. </li>
  338. <li>
  339. <p>GamePlayState</p>
  340. </li>
  341. <li>
  342. <p>MainMenuState</p>
  343. </li>
  344. <li>
  345. <p>ModelState</p>
  346. </li>
  347. <li>
  348. <p>WorldState</p>
  349. </li>
  350. </ol>
  351. </div>
  352. <div class="paragraph">
  353. <p>NetworkRpg.Components:</p>
  354. </div>
  355. <div class="olist arabic">
  356. <ol class="arabic">
  357. <li>
  358. <p>ModelType</p>
  359. </li>
  360. <li>
  361. <p>Position</p>
  362. </li>
  363. <li>
  364. <p>walkDirection (No variables)</p>
  365. </li>
  366. </ol>
  367. </div>
  368. <div class="paragraph">
  369. <p>NetworkRpg.Factories:</p>
  370. </div>
  371. <div class="olist arabic">
  372. <ol class="arabic">
  373. <li>
  374. <p>EntityFactories</p>
  375. </li>
  376. <li>
  377. <p>GameModelFactory</p>
  378. </li>
  379. <li>
  380. <p>ModelFactory</p>
  381. </li>
  382. </ol>
  383. </div>
  384. <div class="paragraph">
  385. <p>NetworkRpgt.Handlers:</p>
  386. </div>
  387. <div class="olist arabic">
  388. <ol class="arabic">
  389. <li>
  390. <p>GameMessageHandler</p>
  391. </li>
  392. </ol>
  393. </div>
  394. <div class="paragraph">
  395. <p>NetworkRpg.Networking:</p>
  396. </div>
  397. <div class="olist arabic">
  398. <ol class="arabic">
  399. <li>
  400. <p>Util</p>
  401. </li>
  402. </ol>
  403. </div>
  404. <div class="literalblock">
  405. <div class="content">
  406. <pre> public static final int tcpPort = 1337; portnumber used for tcp connections
  407. public static final int udpPort = 1337; portnumber used for udp connections (http://www.diffen.com/difference/TCP_vs_UDP)
  408. public static final String GAME_NAME ="Network RPG"; name of the game
  409. public static final int PROTOCOL_VERSION = 1; version of the udp/tcp protocol being used</pre>
  410. </div>
  411. </div>
  412. <div class="paragraph">
  413. <p>NetworkRpg.Networking.Msg:</p>
  414. </div>
  415. <div class="olist arabic">
  416. <ol class="arabic">
  417. <li>
  418. <p>ChatMessage</p>
  419. </li>
  420. <li>
  421. <p>CommandSet</p>
  422. </li>
  423. <li>
  424. <p>GameTimeMessage</p>
  425. </li>
  426. <li>
  427. <p>PlayerInfoMessage</p>
  428. </li>
  429. <li>
  430. <p>ViewDirection</p>
  431. </li>
  432. </ol>
  433. </div>
  434. <div class="paragraph">
  435. <p>NetworkRpg.Objects:</p>
  436. </div>
  437. <div class="olist arabic">
  438. <ol class="arabic">
  439. <li>
  440. <p>Avatar</p>
  441. </li>
  442. </ol>
  443. </div>
  444. <div class="literalblock">
  445. <div class="content">
  446. <pre> public Spatial avatarSpatial; holds information about the character
  447. private Node avatarNode; a node which contains the modelnode
  448. private Node model; a node which contains your character (the green thing on the map)
  449. public BetterCharacterControl avatarControl; this is used to set the gravity
  450. private SimpleApplication App; we need this to get the rootnode
  451. private BulletAppState bulletAppState; allows using bullet physics in an Application.
  452. private Node rootNode; the node which gets all the nodes (add to this one, and it'll be visible)
  453. private AnimChannel animChannel; used to change the current anitmation
  454. private AnimControl animControl; this is needed to create an animchannel
  455. private BitmapText label; label where we add a the textnode to
  456. private Node textNode; name above the head of the player
  457. private String idleAnim = "IdleBase"; name of the animation (not 100% sure)
  458. private String walkAnim = "RunBase";
  459. private String attackAnim = "SliceHorizontal";
  460. private String jumpAnim = "JumpLoop";
  461. private BitmapFont guiFont; the font
  462. private String playerName; name above the avatar</pre>
  463. </div>
  464. </div>
  465. <div class="paragraph">
  466. <p>NetworkRpg.Services:</p>
  467. </div>
  468. <div class="olist arabic">
  469. <ol class="arabic">
  470. <li>
  471. <p>EntityDataService</p>
  472. </li>
  473. <li>
  474. <p>GameSystems</p>
  475. </li>
  476. <li>
  477. <p>MovementService</p>
  478. </li>
  479. <li>
  480. <p>Service (Interface)</p>
  481. </li>
  482. </ol>
  483. </div>
  484. <div class="paragraph">
  485. <p>This is a total of 35 classes.</p>
  486. </div>
  487. </article>
  488. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  489. <div class="toc-menu"></div>
  490. </aside>
  491. </div>
  492. </main>
  493. </div>
  494. <footer class="footer">
  495. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  496. </footer>
  497. <script src="../_/js/vendor/docsearch.min.js"></script>
  498. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
  499. <script>
  500. var search = docsearch({
  501. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  502. indexName: 'jmonkeyengine',
  503. inputSelector: '#search-input',
  504. autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  505. algoliaOptions: { hitsPerPage: 10 }
  506. }).autocomplete
  507. search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
  508. function focusSearchInput () { document.querySelector('#search-input').focus() }
  509. if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
  510. </script>
  511. <script src="../_/js/site.js"></script>
  512. <script async src="../_/js/vendor/highlight.js"></script>
  513. </body>
  514. </html>