cpp
/
crown-engine
зеркало из https://github.com/crownengine/crown.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
							<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

    <meta property="article:modified_time" content="2025-11-27T16:23:47+00:00" /><meta property="og:title" content="Basic Concepts" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://docs.crownengine.org/html/latest/getting_started/basic_concepts.html" />
<meta property="og:site_name" content="Crown 0.60.0 Manual" />
<meta property="og:description" content="This page describes basic concepts and terminology commonly used when working with Crown. Project: A project in Crown is a folder that contains all the resources that describe your game. Resources are plain-text files (with some exceptions) identified by their relative path (t..." />
<meta name="description" content="This page describes basic concepts and terminology commonly used when working with Crown. Project: A project in Crown is a folder that contains all the resources that describe your game. Resources are plain-text files (with some exceptions) identified by their relative path (t..." />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Basic Concepts &mdash; Crown 0.60.0 Manual 0.61.0 documentation</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
    <link rel="shortcut icon" href="../_static/org.crownengine.Crown.svg"/>
    <link rel="canonical" href="https://docs.crownengine.org/html/latest/getting_started/basic_concepts.html" />
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="copyright" title="Copyright" href="../copyright.html" />
    <link rel="next" title="Importing Resources" href="../importing_resources/index.html" />
    <link rel="prev" title="Level Editor" href="level_editor.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="../index.html">
            <img src="../_static/org.crownengine.Crown.svg" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                Crown 0.60.0 Manual
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installing_crown/index.html">Installing Crown</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="create_new_project.html">Creating a new project</a></li>
<li class="toctree-l2"><a class="reference internal" href="import_existing_project.html">Importing an existing project</a></li>
<li class="toctree-l2"><a class="reference internal" href="level_editor.html">Level Editor</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Basic Concepts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#project">Project</a></li>
<li class="toctree-l3"><a class="reference internal" href="#resource-paths-and-names">Resource paths and names</a></li>
<li class="toctree-l3"><a class="reference internal" href="#unit-and-components">Unit and Components</a></li>
<li class="toctree-l3"><a class="reference internal" href="#unit-prefab">Unit Prefab</a></li>
<li class="toctree-l3"><a class="reference internal" href="#world">World</a></li>
<li class="toctree-l3"><a class="reference internal" href="#level">Level</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../importing_resources/index.html">Importing Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
<li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Hackers</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">Crown 0.60.0 Manual</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="index.html">Getting Started</a> &raquo;</li>
      <li>Basic Concepts</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/getting_started/basic_concepts.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="basic-concepts">
<h1>Basic Concepts<a class="headerlink" href="#basic-concepts" title="Permalink to this headline">¶</a></h1>
<p>This page describes basic concepts and terminology commonly used when working
with Crown.</p>
<section id="project">
<span id="id1"></span><h2>Project<a class="headerlink" href="#project" title="Permalink to this headline">¶</a></h2>
<p>A project in Crown is a folder that contains all the resources that describe
your game. Resources are plain-text files (with some exceptions) identified
by their relative path (to the project’s root).</p>
<p>You are free to organize resources in a project however you like. However, to
avoid confusion it is recommended to put units in their own folder because
they often consist of multiple files (e.g. a resource for a tree may consist
of a <code class="docutils literal notranslate"><span class="pre">tree.unit</span></code>, <code class="docutils literal notranslate"><span class="pre">tree.material</span></code> and <code class="docutils literal notranslate"><span class="pre">tree.lua</span></code> files).</p>
</section>
<section id="resource-paths-and-names">
<h2>Resource paths and names<a class="headerlink" href="#resource-paths-and-names" title="Permalink to this headline">¶</a></h2>
<p>All paths in Crown are unix-style (forward slashes). Only canonical/normalized
paths are allowed.</p>
<p>Resources in a project are identified by their relative path to the project’s
folder, without extension.</p>
<p>For example, to refer to the unit named “units/player/player.unit” you will
use the string “units/player/player”.</p>
</section>
<section id="unit-and-components">
<h2>Unit and Components<a class="headerlink" href="#unit-and-components" title="Permalink to this headline">¶</a></h2>
<p>Units are the fundamental building blocks in Crown. Units can be used to
represent any object that exists in a game world - a character, a tree, a
vehicle, a light etc.</p>
<p>By default, units are empty. You add functionality to a Unit by adding
Components to it. No component is mandatory, units can be just empty IDs.</p>
<p>Crown includes a number of predefined components, some examples are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Transform</span></code> - specifies a position, rotation and scale in the world</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">MeshRenderer</span></code> - draws a 3D mesh</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Actor</span></code> - specifies physics properties for a collider, such as mass, filter etc.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Script</span></code> - adds logic via a Lua script</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Light</span></code>, <code class="docutils literal notranslate"><span class="pre">Camera</span></code>, <code class="docutils literal notranslate"><span class="pre">Fog</span></code>, <code class="docutils literal notranslate"><span class="pre">Bloom</span></code> etc.</p></li>
</ul>
<p>Components can be added or removed at any time in the editor or at runtime.</p>
<p>Units support parent-child relationships, allowing complex hierarchies of
objects to be built from many smaller units (e.g. a car with wheels, body,
lights etc.).</p>
</section>
<section id="unit-prefab">
<h2>Unit Prefab<a class="headerlink" href="#unit-prefab" title="Permalink to this headline">¶</a></h2>
<p>Units can be saved to disk as a <em>.unit</em> resource, creating a prefab. Other
units can then reference this prefab, instantly inheriting all of its
components and hierarchy. Changes to a prefab are automatically propagated to
every instance of that prefab.</p>
<p>Unit Prefabs are created by saving existing units inside
the <a class="reference internal" href="level_editor.html#level-editor"><span class="std std-ref">Level Editor</span></a>, or, more commonly, by importing them from
a <a class="reference internal" href="../importing_resources/importing_meshes.html#importing-meshes"><span class="std std-ref">meshes</span></a> or <a class="reference internal" href="../importing_resources/importing_sprites.html#importing-sprites"><span class="std std-ref">sprites</span></a>.</p>
</section>
<section id="world">
<h2>World<a class="headerlink" href="#world" title="Permalink to this headline">¶</a></h2>
<p>A World is the runtime container that holds Units and other objects and
advances the game simulation. When a World is running it:</p>
<ul class="simple">
<li><p>updates animations/audio/particles;</p></li>
<li><p>steps physics and handles collisions;</p></li>
<li><p>dispatches logic events to script components;</p></li>
<li><p>renders the visible scene;</p></li>
<li><p>etc.</p></li>
</ul>
<p>A World can be populated manually via code or automatically by loading Level
resources into it.</p>
<p>A game always has at least one active world. Multiple worlds can exist
simultaneously (for example, one for the main game and one for a UI overlay),
though this is uncommon.</p>
</section>
<section id="level">
<h2>Level<a class="headerlink" href="#level" title="Permalink to this headline">¶</a></h2>
<p>A Level (<em>.level</em> resource) is a saved collection of units, sounds and other
objects.</p>
<p>Levels are authored in the <a class="reference internal" href="level_editor.html#level-editor"><span class="std std-ref">Level Editor</span></a>. A world can load any number of levels
at the same time, enabling complex multi-layered scenes.</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="level_editor.html" class="btn btn-neutral float-left" title="Level Editor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="../importing_resources/index.html" class="btn btn-neutral float-right" title="Importing Resources" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <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.
      <span class="lastupdated">Last updated on Nov 27, 2025.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>
    <!-- Theme Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-XNVGCMNDZH', {
          'anonymize_ip': true,
      });
    </script> 

</body>
</html>