index.html.view.json

{
  "conceptual": "\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"3\">ezEngine is a free, open source game engine written in C++. Its philosophy is to be modular and flexible, such that it can be adapted to many different use cases. EZ utilizes a plugin system to integrate features such as <a href=\"https://www.fmod.com\" sourcefile=\"index.md\" sourcestartlinenumber=\"3\">FMOD</a> or <a href=\"https://github.com/jrouwe/JoltPhysics\" sourcefile=\"index.md\" sourcestartlinenumber=\"3\">Jolt Physics</a>. This makes it possible to only include those features that you need, or to replace systems with a custom solution that works better for your requirements.</p>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"5\"><a href=\"https://www.youtube.com/watch?v=S342o8ZmPdA\" sourcefile=\"index.md\" sourcestartlinenumber=\"5\"><img src=\"https://img.youtube.com/vi/S342o8ZmPdA/0.jpg\" sourcefile=\"index.md\" sourcestartlinenumber=\"5\" alt=\"video\"></a></p>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"7\">Similarly, the EZ code base can be <a href=\"~/pages/docs/build/cmake-config.md#build-filter\" sourcefile=\"index.md\" sourcestartlinenumber=\"7\">built in multiple tiers</a>, where you either get the entire feature set, with a fully functional editor, asset management and renderer, or you can strip it down to just the base libraries and core engine functionality. This can be extremely useful if you need to build a lot of custom technology, but require a high-performance, reliable foundation. EZ has a strong emphasis on providing robust, easy to use and well-tested base functionality. It is successfully being used in such a capacity in commercial products.</p>\n<h2 id=\"when-to-use-ezengine\" sourcefile=\"index.md\" sourcestartlinenumber=\"9\">When to use ezEngine</h2>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"11\">ezEngine is designed to be a great basis for complicated projects. It provides you with lots of functionality that is tedious and difficult to build, such as efficient STL like <a href=\"~/pages/docs/appendix/container-usage.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"11\">container classes</a>, a <a href=\"~/pages/docs/runtime/world/world-overview.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"11\">high-performance scenegraph</a>, resource streaming and much more. It can be used to build the tech for games, as well as for industry applications. In many code bases the lower level functionality is messy and buggy, because it is hard (and boring) to build these parts, and game developers rather spend time on making pretty pictures. In EZ the base functionality is clean, consistent, efficient and fully unit-tested. It <a href=\"~/pages/docs/build/supported-platforms.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"11\">builds on Windows, Mac, Linux and Android</a>.</p>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"13\">Out of the box EZ can be used to create games just with <a href=\"~/pages/docs/custom-code/custom-code-overview.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"13\">scripting</a>. However, it is meant for people who need or want to build their own technology and are looking for a great foundation to build on top of. The ezEditor is a powerful and robust tool that enables quick iteration on ideas with fast startup-times and WYSIWYG real-time editing. It is also completely optional, in case you need a different kind of workflow.</p>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"15\">EZ is also a very good fit for students interested in learning how modern game engines work. It is easy to setup, compiles fast, is well documented, and straight-forward to extend. We also welcome <a href=\"~/pages/getting-started/how-to-contribute.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"15\">contributions</a> in the form of code or art.</p>\n<h2 id=\"when-not-to-use-ezengine\" sourcefile=\"index.md\" sourcestartlinenumber=\"17\">When not to use ezEngine</h2>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"19\">ezEngine is mainly developed on Windows. The renderer currently uses DX11. A Vulkan port is in development and the tools are being ported to Linux as well, however this is still in the early phase and not yet productively usable.</p>\n<p sourcefile=\"index.md\" sourcestartlinenumber=\"21\">It is also not comparable in feature completeness to commercial offerings such as Unreal or Unity. Although it does support scripting game logic both with AngelScript and Visual Scripting, it is not meant for low-code or no-code development. The scripting capabilities are limited, for many game ideas you need to be comfortable writing C++ code.</p>\n<h2 id=\"getting-started\" sourcefile=\"index.md\" sourcestartlinenumber=\"23\">Getting Started</h2>\n<ul sourcefile=\"index.md\" sourcestartlinenumber=\"25\">\n<li sourcefile=\"index.md\" sourcestartlinenumber=\"25\">You can download <a href=\"~/pages/getting-started/binaries.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"25\">prebuilt binaries</a> or <a href=\"https://github.com/ezEngine/ezEngine\" sourcefile=\"index.md\" sourcestartlinenumber=\"25\">clone the latest dev branch</a>.</li>\n<li sourcefile=\"index.md\" sourcestartlinenumber=\"26\">See the <a href=\"~/pages/docs/docs-overview.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"26\">documentation</a> for <a href=\"~/pages/docs/build/building-ez.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"26\">build instructions</a> and available <a href=\"~/pages/samples/samples-overview.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"26\">samples</a>.</li>\n<li sourcefile=\"index.md\" sourcestartlinenumber=\"27\">Check out the <a href=\"~/pages/getting-started/faq.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"27\">FAQ</a>.</li>\n<li sourcefile=\"index.md\" sourcestartlinenumber=\"28\">There are <a href=\"~/pages/getting-started/videos.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"28\">videos</a> about various topics on our <a href=\"https://www.youtube.com/@ezEngine\" sourcefile=\"index.md\" sourcestartlinenumber=\"28\">YouTube channel</a>.</li>\n<li sourcefile=\"index.md\" sourcestartlinenumber=\"29\">If you need help, <a href=\"~/pages/contact.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"29\">contact us</a>.</li>\n<li sourcefile=\"index.md\" sourcestartlinenumber=\"30\">Everyone is <a href=\"~/pages/getting-started/how-to-contribute.md\" sourcefile=\"index.md\" sourcestartlinenumber=\"30\">welcome to contribute</a>.</li>\n</ul>\n",
  "type": "Conceptual",
  "source": {
    "remote": {
      "path": "index.md",
      "branch": "main",
      "repo": "https://github.com/ezEngine/docs-src"
    },
    "startLine": 0,
    "endLine": 0
  },
  "path": "index.md",
  "documentation": {
    "remote": {
      "path": "index.md",
      "branch": "main",
      "repo": "https://github.com/ezEngine/docs-src"
    },
    "startLine": 0,
    "endLine": 0
  },
  "_appFaviconPath": "assets/images/favicon.svg",
  "_appFooter": "Hello",
  "_appLogoPath": "assets/images/EZ-text.svg",
  "_appName": "ezEngine",
  "_appTitle": "ezEngine",
  "_enableGoogleAnalytics": true,
  "_enableNewTab": true,
  "_enableSearch": true,
  "_gitContribute": {
    "repo": "https://github.com/ezEngine/docs-src",
    "branch": "main"
  },
  "_systemKeys": [
    "conceptual",
    "type",
    "source",
    "path",
    "documentation",
    "title",
    "rawTitle",
    "wordCount"
  ],
  "rawTitle": "<h1 id=\"welcome-to-ezengine\" sourcefile=\"index.md\" sourcestartlinenumber=\"1\">Welcome to ezEngine</h1>",
  "title": "Welcome to ezEngine",
  "wordCount": 538,
  "_key": "index.md",
  "_navKey": "~/toc.yml",
  "_navPath": "toc.html",
  "_navRel": "toc.html",
  "_path": "index.html",
  "_rel": "",
  "_tocKey": "~/toc.yml",
  "_tocPath": "toc.html",
  "_tocRel": "toc.html",
  "__global": {
    "namespacesInSubtitle": "Namespaces",
    "classesInSubtitle": "Classes",
    "structsInSubtitle": "Structs",
    "interfacesInSubtitle": "Interfaces",
    "enumsInSubtitle": "Enums",
    "delegatesInSubtitle": "Delegates",
    "constructorsInSubtitle": "Constructors",
    "fieldsInSubtitle": "Fields",
    "propertiesInSubtitle": "Properties",
    "methodsInSubtitle": "Methods",
    "eventsInSubtitle": "Events",
    "operatorsInSubtitle": "Operators",
    "eiisInSubtitle": "Explicit Interface Implementations",
    "functionsInSubtitle": "Functions",
    "variablesInSubtitle": "Variables",
    "typeAliasesInSubtitle": "Type Aliases",
    "membersInSubtitle": "Members",
    "improveThisDoc": "Edit this page",
    "viewSource": "View Source",
    "inheritance": "Inheritance",
    "derived": "Derived",
    "inheritedMembers": "Inherited Members",
    "package": "Package",
    "namespace": "Namespace",
    "assembly": "Assembly",
    "syntax": "Syntax",
    "overrides": "Overrides",
    "implements": "Implements",
    "remarks": "Remarks",
    "examples": "Examples",
    "seealso": "See Also",
    "declaration": "Declaration",
    "parameters": "Parameters",
    "typeParameters": "Type Parameters",
    "type": "Type",
    "name": "Name",
    "description": "Description",
    "returns": "Returns",
    "fieldValue": "Field Value",
    "propertyValue": "Property Value",
    "eventType": "Event Type",
    "variableValue": "Variable Value",
    "typeAliasType": "Type Alias Type",
    "exceptions": "Exceptions",
    "condition": "Condition",
    "extensionMethods": "Extension Methods",
    "note": "Note",
    "warning": "Warning",
    "tip": "Tip",
    "important": "Important",
    "caution": "Caution",
    "tocToggleButton": "Show / Hide Table of Contents",
    "tocFilter": "Filter by title",
    "search": "Search",
    "searchResults": "Search Results for",
    "searchResultsCount": "{count} results for \"{query}\"",
    "searchNoResults": "No results for \"{query}\"",
    "pageFirst": "First",
    "pagePrev": "Previous",
    "pageNext": "Next",
    "pageLast": "Last",
    "inThisArticle": "In this article",
    "nextArticle": "Next",
    "prevArticle": "Previous",
    "backToTop": "Back to top",
    "themeLight": "Light",
    "themeDark": "Dark",
    "themeAuto": "Auto",
    "changeTheme": "Change theme",
    "copy": "Copy",
    "downloadPdf": "Download PDF",
    "_shared": {}
  },
  "_disableToc": true,
  "docurl": "https://github.com/ezEngine/docs-src/blob/main/index.md/#L1"
}