-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
162 lines (142 loc) · 9.92 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Welcome to ezEngine | ezEngine </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Welcome to ezEngine | ezEngine ">
<link rel="icon" href="assets/images/favicon.svg">
<link rel="stylesheet" href="public/docfx.min.css">
<link rel="stylesheet" href="public/main.css">
<meta name="docfx:navrel" content="toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="">
<meta name="docfx:docurl" content="https://github.com/ezEngine/docs-src/blob/main/index.md/#L1">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
<meta name="loc:searchNoResults" content="No results for "{query}"">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
</head>
<script type="module" src="./public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="index.html">
<!--
<img id="logo" class="svg" src="assets/images/EZ-text.svg" alt="ezEngine" >
ezEngine
-->
<img id="logo" src="assets/images/EZ-text.svg" style="width: 100px; height: 50px;" alt="ezEngine">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="">
<h1 id="welcome-to-ezengine">Welcome to ezEngine</h1>
<p>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">FMOD</a> or <a href="https://github.com/jrouwe/JoltPhysics">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>
<p><a href="https://www.youtube.com/watch?v=S342o8ZmPdA"><img src="https://img.youtube.com/vi/S342o8ZmPdA/0.jpg" alt="video"></a></p>
<p>Similarly, the EZ code base can be <a href="pages/docs/build/cmake-config.html#build-filter">built in multiple tiers</a>, where you either get the entire feature set, with a <a href="pages/getting-started/editor-overview.html">fully functional editor</a>, 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>
<h2 id="when-to-use-ezengine">When to use ezEngine</h2>
<p>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.html">container classes</a>, a <a href="pages/docs/runtime/world/world-overview.html">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.html">builds on Windows, Mac, Linux and Android</a>.</p>
<p>Out of the box EZ can be used to create games just with <a href="pages/docs/custom-code/custom-code-overview.html">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>
<p>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.html">contributions</a> in the form of code or art.</p>
<h2 id="when-not-to-use-ezengine">When not to use ezEngine</h2>
<p>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>
<p>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 TypeScript 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>
<h2 id="getting-started">Getting Started</h2>
<ul>
<li>You can download <a href="pages/getting-started/binaries.html">prebuilt binaries</a> or <a href="https://github.com/ezEngine/ezEngine">clone the latest dev branch</a>.</li>
<li>See the <a href="pages/docs/docs-overview.html">documentation</a> for <a href="pages/docs/build/building-ez.html">build instructions</a> and available <a href="pages/samples/samples-overview.html">samples</a>.</li>
<li>Check out the <a href="pages/getting-started/faq.html">FAQ</a>.</li>
<li>There are <a href="pages/getting-started/videos.html">videos</a> about various topics on our <a href="https://www.youtube.com/@ezEngine">YouTube channel</a>.</li>
<li>If you need help, <a href="pages/contact.html">contact us</a>.</li>
<li>Everyone is <a href="pages/getting-started/how-to-contribute.html">welcome to contribute</a>.</li>
</ul>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/ezEngine/docs-src/blob/main/index.md/#L1" class="edit-link">Edit this page</a>
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<!--
Hello
-->
<span class="pull-right">
<a href="/privacy-policy.html">Privacy Policy</a>
<a href="#top">Back to top</a>
</span>
<span class="footer-logo">
<a id="logo_ez" href="https://ezEngine.net"></a>
</span>
<span class="footer-logo">
<a id="logo_github" href="https://github.com/ezEngine/ezEngine" target="_blank"></a>
</span>
<span class="footer-logo">
<a id="logo_bluesky" href="https://bsky.app/profile/ezengine.bsky.social" target="_blank"></a>
</span>
<span class="footer-logo">
<a id="logo_twitter" href="https://twitter.com/ezengineproject" target="_blank"></a>
</span>
<span class="footer-logo">
<a id="logo_discord" href="https://discord.gg/rfJewc5khZ" target="_blank"></a>
</span>
<span class="footer-logo">
<a id="logo_youtube" href="https://www.youtube.com/@ezEngine" target="_blank"></a>
</span>
</div>
</div>
</footer>
</body>
</html>