-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc-design-principles.html
297 lines (287 loc) · 14.5 KB
/
doc-design-principles.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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="icon" href="images/TotalAILogoTrans32.png" type="image/x-icon">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600|Roboto Mono&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Goldman&display=swap" rel="stylesheet">
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
<link rel="stylesheet" href="main.css">
<title>Total AI</title>
</head>
<body>
<nav class="navbar sticky-top tai-navbar">
<a class="navbar-brand" style="margin-top: -8px; margin-bottom: -8px;" href="index.html">
<img src="images/TotalAILogoTrans.png" height="40" alt="" loading="lazy">
</a>
<ul class="nav mr-auto">
<li class="nav-item">
<a class="nav-link" href="index.html">Home <span class="sr-only">(current)</span></a>
</li>
<li class="nav-item">
<a class="nav-link active" href="doc-introduction.html">Guide</a>
</li>
<li class="nav-item">
<a class="nav-link" href="insp-introduction.html">Inspectors</a>
</li>
<li class="nav-item">
<a class="nav-link" href="script-introduction.html">Scripts</a>
</li>
<li class="nav-item">
<a class="nav-link" href="videos.html">Videos</a>
</li>
<li class="nav-item">
<a class="nav-link" href="contributors.html">Contributors</a>
</li>
<li class="nav-item">
<a class="nav-link" href="about.html">About</a>
</li>
<li class="nav-item" style="padding-left: 25px;">
<a class="nav-link" href="contrib-introduction.html">Contribute</a>
</li>
</ul>
<ul class="nav justify-content-end">
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://discord.gg/PfKUm42Zax">
Discord
<svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
</svg>
</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://github.com/TotalAI/TotalAI">
GitHub
<svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
</svg>
</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://patreon.com/zacwarren">
Patreon
<svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
<path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
</svg>
</a>
</li>
</ul>
</nav>
<main style="width: 100%">
<div class="container-fluid">
<div class="row flex-xl-nowrap">
<div class="col-md-3 col-xl-2" style="position: sticky; top: 0; z-index: 1000; height: calc(100vh - 4rem); order: 0; overflow-y: auto; padding-top: 10px; padding-bottom: 40px;">
<h3 class="nav-header">Getting Started</h3>
<ul class="nav flex-column">
<li class="nav-item">
<a class="nav-link" href="doc-introduction.html">Introduction</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-installation.html">Install & Setup</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-demo.html">Demo Worlds</a>
</li>
</ul>
<h3 class="nav-header">Entities</h3>
<ul class="nav flex-column navbar-light">
<li class="nav-item">
<a class="nav-link" href="doc-agent.html">Agent</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-worldobject.html">WorldObject</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-agentevent.html">AgentEvent</a>
</li>
</ul>
<h3 class="nav-header">Levels</h3>
<ul class="nav flex-column navbar-light">
<li class="nav-item">
<a class="nav-link" href="doc-drive.html">Drive</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-action.html">Action</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-attribute.html">Attribute</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-tag.html">Tag</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-role.html">Role</a>
</li>
<h3 class="nav-header">Agent</h3>
<ul class="nav flex-column navbar-light">
<li class="nav-item">
<a class="nav-link" href="doc-agent-main-loop.html">Main Loop</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-movementtype.html">Movement Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-animationtype.html">Animation Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-sensortype.html">Sensor Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-memorytype.html">Memory Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-decider.html">Decider</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-plannertype.html">Planner Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-mapping.html">Plans & Mappings</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-behavior.html">Behavior</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-historytype.html">History Type</a>
</li>
</ul>
<h3 class="nav-header">AI Types</h3>
<ul class="nav flex-column navbar-light">
<li class="nav-item">
<a class="nav-link" href="doc-fsm.html">FSM</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-goap.html">GOAP</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-utility-ai.html">Utility AI</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-deep-rl.html">Deep RL</a>
</li>
</ul>
<h3 class="nav-header">Other</h3>
<ul class="nav flex-column navbar-light">
<li class="nav-item">
<a class="nav-link" href="doc-typematching.html">Type Matching</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-inventory.html">Inventory</a>
</li>
<li class="nav-item">
<a class="nav-link active" href="doc-design-principles.html">Design Principles</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-scriptableobjects.html">ScriptableObjects</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-selector.html">Selector</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-utility-curve.html">Utility Curve</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-utility-function.html">Utility Function Type</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-included-ui.html">UI & Placement</a>
</li>
<li class="nav-item">
<a class="nav-link" href="doc-more-resources.html">External Links</a>
</li>
</ul>
</div>
<div class="col-md-1">
</div>
<div class="col content" style="padding-top: 40px; padding-bottom: 40px; line-height: 1.6em; color: #304455; font-size: 1rem;">
<h1>Design Principles</h1>
<h3>What are the high level design principles of Total AI?</h3>
<hr>
<ul>
<li>Simple</li>
<li>Easy To Prototype</li>
<li>Flexible</li>
<li>Customizable</li>
<li>Performant</li>
</ul>
<h3>Simple</h3>
<hr>
<p>
Assuming the requirements are met <b>simple is always better</b>. This is true in all areas. Whether it is in code,
UI, game design, or even this documentation. <b>Simple is not easy</b>. Usually initial "easy" solutions are overly complex.
Only after multiple refactors does a solution begin to be simple. This is because the problem can't possible be understood
until multiple passes of implementation are made along with feedback at each stage. This can be seen in TAI as almost
all areas of TAI are at three or more revisions from their initial code/design. Over time even more revisions
will be made to simplify it. The overall gains of simplicity for code is particularly great since simple means less bugs,
easier bug fixes, easier for new developers to learn the code, more stable code, and code that is easier to extend.
<br><br>
Performance is probably the most obvious counter to this argument. Certain areas might need to be overly complex in
order to reduce a performance bottleneck. The key is be be 100% sure that its worth the complexity, so measure
performance gains when deciding to introduce complexity.
</p>
<h3>Easy To Prototype</h3>
<hr>
<p>
Video games are complex creations especially ones that attempt complex AI. NPC behavior is a very hard problem and must be
carefully balanced with the gameplay. Prototyping different systems quickly before major costs have gone into them is
critical. AI in particular can be difficult to prototype with switching between various AIs time consuming. TAI
attempts to remove this barrier by providing one framework that allows many diverse styles of AI to be tried and
also mix and matched between Agents.
</p>
<h3>Flexible</h3>
<hr>
<p>
Creating a usable AI Framework for Unity is a challenging task due to the incredible variety of games. TAI tries to
provide a fully featured framework for a large chunk of these games by creating a general AI framework that a user
can easily plug in different logic. TAI also makes it easy to use some features and not others.
</p>
<h3>Customizable</h3>
<hr>
<p>
Customization is at the heart of TAI. TAI attempts to put all key logic inside types that inherit from ScriptableObjects.
These types can then be easily extended to either expand on the current logic or create new logic. These new types can
then be easily set into other ScriptablObject Types or into Components.
</p>
<h3>Performant</h3>
<hr>
<p>
TAI uses two main pathways for performance.
<br><br>
One is in the core code using the latest in Unity performance technology such as the Jobs System and
is received for free. <b>TAI currently does NOT use the Jobs System.</b> This is currently an area
in need of improvement for Total AI.
<br><br>
The second one is design options for reducing and redirecting
available computation to the areas of your game that need it. This one is more powerful but takes careful design
by the game designer. TAI provides many options here and the documentation tries to aid game designers with how to
get the most out of their available AI compute.
</p>
</div>
<div class="col-md-3">
</div>
</div>
</main>
<script>
$(document).ready(function() {
$(window).resize(function() {
resize();
});
function resize() {
var myheight = $(window).outerHeight(true) - 0;
$('.main').outerHeight(myheight);
}
resize();
});
</script>
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
</body>
</html>