introduction.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. <!DOCTYPE html>
  2. <html class="writer-html4" lang="en" >
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Introduction &mdash; Crown Manual 0.52.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  7. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  8. <!--[if lt IE 9]>
  9. <script src="_static/js/html5shiv.min.js"></script>
  10. <![endif]-->
  11. <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  12. <script type="text/javascript" src="_static/jquery.js"></script>
  13. <script type="text/javascript" src="_static/underscore.js"></script>
  14. <script type="text/javascript" src="_static/doctools.js"></script>
  15. <script type="text/javascript" src="_static/language_data.js"></script>
  16. <script src="_static/js/theme.js"></script>
  17. <link rel="index" title="Index" href="genindex.html" />
  18. <link rel="search" title="Search" href="search.html" />
  19. <link rel="copyright" title="Copyright" href="copyright.html" />
  20. <link rel="next" title="Basic concepts" href="basics.html" />
  21. <link rel="prev" title="Changelog" href="changelog.html" />
  22. </head>
  23. <body class="wy-body-for-nav">
  24. <div class="wy-grid-for-nav">
  25. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  26. <div class="wy-side-scroll">
  27. <div class="wy-side-nav-search" >
  28. <a href="index.html"><img src="_static/crown-logo-white.svg" class="logo" alt="Logo"/>
  29. </a>
  30. <div class="version">
  31. 0.52.0
  32. </div>
  33. <div role="search">
  34. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  35. <input type="text" name="q" placeholder="Search docs" />
  36. <input type="hidden" name="check_keywords" value="yes" />
  37. <input type="hidden" name="area" value="default" />
  38. </form>
  39. </div>
  40. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  41. <ul class="current">
  42. <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
  43. <li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
  44. <li class="toctree-l2"><a class="reference internal" href="#what-is-it">What is it?</a></li>
  45. <li class="toctree-l2"><a class="reference internal" href="#features">Features</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="#supported-platforms">Supported platforms</a></li>
  47. <li class="toctree-l2"><a class="reference internal" href="#contact">Contact</a></li>
  48. <li class="toctree-l2"><a class="reference internal" href="#contributors">Contributors</a></li>
  49. </ul>
  50. </li>
  51. <li class="toctree-l1"><a class="reference internal" href="basics.html">Basic concepts</a></li>
  52. <li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="lua_api.html">Lua API reference</a></li>
  54. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="copyright.html">License</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="hackers/index.html">Hackers</a></li>
  57. </ul>
  58. </div>
  59. </div>
  60. </nav>
  61. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  62. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  63. <a href="index.html">Crown Manual</a>
  64. </nav>
  65. <div class="wy-nav-content">
  66. <div class="rst-content">
  67. <div role="navigation" aria-label="Page navigation">
  68. <ul class="wy-breadcrumbs">
  69. <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
  70. <li>Introduction</li>
  71. <li class="wy-breadcrumbs-aside">
  72. <a href="_sources/introduction.rst.txt" rel="nofollow"> View page source</a>
  73. </li>
  74. </ul>
  75. <hr/>
  76. </div>
  77. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  78. <div itemprop="articleBody">
  79. <div class="section" id="introduction">
  80. <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
  81. <div class="section" id="what-is-it">
  82. <h2>What is it?<a class="headerlink" href="#what-is-it" title="Permalink to this headline">¶</a></h2>
  83. <p>Crown is a general purpose and data-driven game engine, written in <a class="reference external" href="https://gist.github.com/bkaradzic/2e39896bc7d8c34e042b">orthodox</a> C++ with a
  84. minimalistic and data-oriented design philosophy in mind.</p>
  85. <p>Crown isn’t tied to a particular game type or genre but instead it offers a set
  86. of generic primitives and facilities to help you create a wide gamut of
  87. interactive 2D and 3D products.</p>
  88. <p>Crown also offers a complete cross-platform editor to create and put together
  89. all the elements that make up your game.</p>
  90. <p>Crown is loosely inspired by the Bitsquid engine and many of its design
  91. principles.</p>
  92. </div>
  93. <div class="section" id="features">
  94. <h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
  95. <div class="admonition note">
  96. <p class="first admonition-title">Note</p>
  97. <p class="last">Crown is in active development and new features are added and improved all
  98. the time; you can check out the development efforts in real-time on
  99. <a class="reference external" href="https://github.com/crownengine/crown/issues">GitHub</a> and on the
  100. <a class="reference external" href="https://discord.com/invite/CeXVWCT">Discord</a> channel!</p>
  101. </div>
  102. <ul class="simple">
  103. <li><dl class="first docutils">
  104. <dt>Data-driven</dt>
  105. <dd>Every aspect of the game is controlled through text configuration files. Text
  106. files are human-readable for easy inspection and play nicely with traditional
  107. version control systems. Before shipping, configuration files are compiled to
  108. efficient platform-specific binary blobs.</dd>
  109. </dl>
  110. </li>
  111. <li><dl class="first docutils">
  112. <dt>Data-oriented</dt>
  113. <dd>Data in memory is organized to achieve the maximum performance possible on
  114. every platform.</dd>
  115. </dl>
  116. </li>
  117. <li><dl class="first docutils">
  118. <dt>Lightweight codebase and runtime</dt>
  119. <dd>Engine plus tools amounts to less than 50K LOC. Written in simple ‘C-style’
  120. C++. It is easy for anyone to understand and make modifications.</dd>
  121. </dl>
  122. </li>
  123. <li><dl class="first docutils">
  124. <dt>Editor</dt>
  125. <dd><ul class="first last">
  126. <li>Runs and looks equally well both on Linux and on Windows.</li>
  127. <li>Source data importers (meshes, sprites, sounds, textures etc.).</li>
  128. <li>All the editing data is held by the editor which runs in its own process, if the Runtime crashes you can restart it without losing your work.</li>
  129. <li>TCP/IP communication with Runtime allows editing to be mirrored to remote devices (phones, consoles etc.).</li>
  130. <li>Hot-reloading of every asset including code.</li>
  131. </ul>
  132. </dd>
  133. </dl>
  134. </li>
  135. <li><dl class="first docutils">
  136. <dt>Graphics</dt>
  137. <dd><ul class="first last">
  138. <li>High-level 2D and 3D objects: sprites, meshes and lights (directional, omni and spot).</li>
  139. <li>Cross-plaform GLSL-like shader programming language with data-driven definitions of render states and permutations.</li>
  140. <li>D3D11, GL 3.2 and GLES 2.0 render backends.</li>
  141. <li>PNG, TGA, DDS, KTX and PVR texture formats.</li>
  142. </ul>
  143. </dd>
  144. </dl>
  145. </li>
  146. <li><dl class="first docutils">
  147. <dt>Animation</dt>
  148. <dd><ul class="first last">
  149. <li>Animation state machine with events, variables and blending with simple expressions evaluator.</li>
  150. <li>Flipbook sprite animation.</li>
  151. </ul>
  152. </dd>
  153. </dl>
  154. </li>
  155. <li><dl class="first docutils">
  156. <dt>Physics</dt>
  157. <dd><ul class="first last">
  158. <li>Static, dynamic and keyframed rigid bodies, triggers and joints (fixed, spring and hinge).</li>
  159. <li>Spatial queries: ray-, sphere- and box-casts.</li>
  160. <li>Multiple collision geometries per rigid body.</li>
  161. <li>Collision geometry can be generated from mesh data, authored by artists or manually specified.</li>
  162. <li>Uniform scaling of physics objects.</li>
  163. </ul>
  164. </dd>
  165. </dl>
  166. </li>
  167. <li><dl class="first docutils">
  168. <dt>Audio</dt>
  169. <dd><ul class="first last">
  170. <li>3D audio sources with position and range-based attenuation.</li>
  171. <li>Volume control.</li>
  172. <li>WAV format supported.</li>
  173. </ul>
  174. </dd>
  175. </dl>
  176. </li>
  177. <li><dl class="first docutils">
  178. <dt>Scripting</dt>
  179. <dd><ul class="first last">
  180. <li>Integrated Lua runtime can be used to control every aspect of the game.</li>
  181. <li>LuaJIT is used on supported platforms for maximum performance.</li>
  182. <li>Integrated REPL to quickly test and experiment while the game is running.</li>
  183. <li>Live reloading of gameplay code without needing to restart the game.</li>
  184. </ul>
  185. </dd>
  186. </dl>
  187. </li>
  188. <li><dl class="first docutils">
  189. <dt>Debugging</dt>
  190. <dd><ul class="first last">
  191. <li>Integrated profiler.</li>
  192. <li>Callstack generation for C++ and Lua.</li>
  193. </ul>
  194. </dd>
  195. </dl>
  196. </li>
  197. <li><dl class="first docutils">
  198. <dt>Gui</dt>
  199. <dd><ul class="first last">
  200. <li>Immediate-mode GUI with custom materials.</li>
  201. <li>TrueType text rendering via texture atlas.</li>
  202. </ul>
  203. </dd>
  204. </dl>
  205. </li>
  206. <li><dl class="first docutils">
  207. <dt>Input</dt>
  208. <dd><ul class="first last">
  209. <li>Unified interface for accessing mice, keyboards, touchpads and joypads.</li>
  210. </ul>
  211. </dd>
  212. </dl>
  213. </li>
  214. <li><dl class="first docutils">
  215. <dt>Exporters</dt>
  216. <dd><ul class="first last">
  217. <li>Mesh exporter for Blender &gt;= 2.80.</li>
  218. </ul>
  219. </dd>
  220. </dl>
  221. </li>
  222. </ul>
  223. </div>
  224. <div class="section" id="supported-platforms">
  225. <h2>Supported platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this headline">¶</a></h2>
  226. <ul class="simple">
  227. <li><dl class="first docutils">
  228. <dt>Runtime</dt>
  229. <dd><ul class="first last">
  230. <li>Android 7.0+ (ARMv7-a, ARMv8-a)</li>
  231. <li>HTML5 (Wasm/Emscripten)</li>
  232. <li>Ubuntu 20.04+ (x86_64)</li>
  233. <li>Windows 7+ (x86_64)</li>
  234. </ul>
  235. </dd>
  236. </dl>
  237. </li>
  238. <li><dl class="first docutils">
  239. <dt>Editor</dt>
  240. <dd><ul class="first last">
  241. <li>Any 64-bit Linux with GTK+ 3.22 or newer (Ubuntu &gt;= 20.04+)</li>
  242. <li>Any 64-bit Windows 7+</li>
  243. <li>64-bit dual-core CPU or higher</li>
  244. <li>OpenGL 3.2+ graphics card with 512 MB of RAM, 1 GB recommended</li>
  245. <li>4 GB of RAM minimum, 8 GB recommended</li>
  246. <li>1366x768 display resolution minimum, 1920x1080 recommended</li>
  247. <li>Three-button mouse</li>
  248. </ul>
  249. </dd>
  250. </dl>
  251. </li>
  252. </ul>
  253. </div>
  254. <div class="section" id="contact">
  255. <h2>Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h2>
  256. <ul class="simple">
  257. <li>Website: <a class="reference external" href="https://www.crownengine.org">https://www.crownengine.org</a></li>
  258. <li>Project page: <a class="reference external" href="https://github.com/crownengine/crown">https://github.com/crownengine/crown</a></li>
  259. </ul>
  260. </div>
  261. <div class="section" id="contributors">
  262. <h2>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h2>
  263. <p>In chronological order.</p>
  264. <ul class="simple">
  265. <li>Daniele Bartolini (<a class="reference external" href="https://github.com/dbartolini">&#64;dbartolini</a>)</li>
  266. <li>Simone Boscaratto (<a class="reference external" href="https://github.com/Xed89">&#64;Xed89</a>)</li>
  267. <li>Michele Rossi (<a class="reference external" href="https://github.com/mikymod">&#64;mikymod</a>)</li>
  268. <li>Michela Iacchelli - Crown logo v1.</li>
  269. <li>Raphael de Vasconcelos Nascimento (<a class="reference external" href="https://github.com/vasconssa">&#64;vasconssa</a>)</li>
  270. <li>Giulia Gazzoli - Crown logo v2.</li>
  271. </ul>
  272. </div>
  273. </div>
  274. </div>
  275. </div>
  276. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  277. <a href="changelog.html" class="btn btn-neutral float-left" title="Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  278. <a href="basics.html" class="btn btn-neutral float-right" title="Basic concepts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  279. </div>
  280. <hr/>
  281. <div role="contentinfo">
  282. <p>&#169; <a href="copyright.html">Copyright</a> Except where otherwise noted, content on this page is licensed under a CC-BY-SA 4.0 Int. License.</p>
  283. </div>
  284. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  285. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  286. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  287. </footer>
  288. </div>
  289. </div>
  290. </section>
  291. </div>
  292. <script>
  293. jQuery(function () {
  294. SphinxRtdTheme.Navigation.enable(true);
  295. });
  296. </script>
  297. <!-- Theme Analytics -->
  298. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  299. <script>
  300. window.dataLayer = window.dataLayer || [];
  301. function gtag(){dataLayer.push(arguments);}
  302. gtag('js', new Date());
  303. gtag('config', 'G-XNVGCMNDZH', {
  304. 'anonymize_ip': true,
  305. });
  306. </script>
  307. </body>
  308. </html>