-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathhelp.html
More file actions
575 lines (526 loc) · 22.2 KB
/
Copy pathhelp.html
File metadata and controls
575 lines (526 loc) · 22.2 KB
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>LowPoly64 Help</title>
<style>
:root {
--bg: #0a0a0a;
--panel: #151515;
--panel-soft: #1f1f1f;
--text: #f5f5f5;
--muted: #a1a1aa;
--yellow: #ffcc00;
--cyan: #00e5ff;
--green: #00ff88;
--red: #ff5c5c;
--border: #2f2f2f;
--shadow: 0 0 0 2px var(--yellow) inset;
}
* { box-sizing: border-box; }
html { scroll-behavior: smooth; }
body {
margin: 0;
font-family: Consolas, "Courier New", monospace;
background:
radial-gradient(circle at top left, rgba(255, 204, 0, 0.15), transparent 25%),
radial-gradient(circle at top right, rgba(0, 229, 255, 0.12), transparent 20%),
linear-gradient(180deg, #101010 0%, var(--bg) 100%);
color: var(--text);
min-height: 100vh;
}
a { color: inherit; }
.shell {
max-width: 1180px;
margin: 0 auto;
padding: 24px;
}
.topbar {
display: flex;
gap: 12px;
align-items: center;
justify-content: space-between;
flex-wrap: wrap;
margin-bottom: 24px;
padding: 14px 16px;
background: rgba(0, 0, 0, 0.72);
border: 2px solid var(--yellow);
}
.brand {
display: flex;
align-items: center;
gap: 12px;
text-transform: uppercase;
letter-spacing: 0.18em;
}
.brand-mark {
color: var(--yellow);
font-size: 1.5rem;
}
.actions {
display: flex;
gap: 10px;
flex-wrap: wrap;
}
.button {
appearance: none;
border: 2px solid var(--yellow);
background: #111;
color: var(--yellow);
padding: 10px 14px;
text-decoration: none;
text-transform: uppercase;
letter-spacing: 0.08em;
font: inherit;
cursor: pointer;
}
.button:hover {
background: var(--yellow);
color: #000;
}
.button.alt {
border-color: var(--cyan);
color: var(--cyan);
}
.button.alt:hover {
background: var(--cyan);
color: #000;
}
.hero {
display: grid;
grid-template-columns: 1.2fr 0.8fr;
gap: 20px;
margin-bottom: 24px;
}
.panel {
background: rgba(12, 12, 12, 0.85);
border: 1px solid var(--border);
box-shadow: var(--shadow);
padding: 20px;
}
.hero h1, .section h2 {
margin: 0 0 12px;
text-transform: uppercase;
letter-spacing: 0.14em;
}
.lead {
color: var(--muted);
line-height: 1.7;
margin: 0;
}
.section {
margin-bottom: 20px;
}
.grid {
display: grid;
grid-template-columns: repeat(2, minmax(0, 1fr));
gap: 20px;
}
.card {
background: var(--panel);
border: 1px solid var(--border);
padding: 18px;
}
.card h3 {
margin: 0 0 10px;
text-transform: uppercase;
letter-spacing: 0.1em;
color: var(--yellow);
font-size: 0.95rem;
}
.list {
margin: 0;
padding-left: 18px;
color: var(--muted);
line-height: 1.7;
}
.list li + li {
margin-top: 8px;
}
.toc {
display: grid;
gap: 10px;
}
.toc a {
padding: 10px 12px;
text-decoration: none;
border: 1px solid var(--border);
background: var(--panel-soft);
color: var(--text);
}
.toc a:hover {
border-color: var(--yellow);
color: var(--yellow);
}
.note {
padding: 12px 14px;
border-left: 4px solid var(--cyan);
background: rgba(0, 229, 255, 0.08);
color: var(--muted);
line-height: 1.6;
}
.warning {
border-left-color: var(--red);
background: rgba(255, 92, 92, 0.08);
}
pre {
margin: 0;
padding: 16px;
background: #090909;
border: 1px solid var(--border);
overflow: auto;
line-height: 1.55;
color: #f8f8f2;
white-space: pre-wrap;
word-break: break-word;
}
code {
font-family: Consolas, "Courier New", monospace;
}
.code-toolbar {
display: flex;
align-items: center;
justify-content: space-between;
gap: 12px;
margin-bottom: 10px;
}
.code-toolbar strong {
text-transform: uppercase;
letter-spacing: 0.08em;
color: var(--yellow);
font-size: 0.9rem;
}
.copy {
border: 1px solid var(--green);
background: transparent;
color: var(--green);
padding: 8px 10px;
cursor: pointer;
text-transform: uppercase;
font: inherit;
}
.copy:hover {
background: var(--green);
color: #000;
}
.footer {
margin-top: 24px;
padding: 20px 0 8px;
color: var(--muted);
font-size: 0.92rem;
}
.pill {
display: inline-block;
padding: 4px 8px;
margin: 0 8px 8px 0;
border: 1px solid var(--border);
background: var(--panel-soft);
color: var(--muted);
}
@media (max-width: 900px) {
.hero,
.grid {
grid-template-columns: 1fr;
}
}
</style>
</head>
<body>
<div class="shell">
<div class="topbar">
<div class="brand">
<span class="brand-mark">▲</span>
<strong>LowPoly64 Help</strong>
</div>
<div class="actions">
<a class="button alt" href="./index.html" data-help="backToEditor">Back To Editor</a>
<button id="help-lang-toggle" class="button" type="button">EN 🇺🇸</button>
</div>
</div>
<div class="hero">
<section class="panel">
<h1 data-help="heroTitle">Build retro low-poly assets faster</h1>
<p class="lead" data-help="heroLead">
This page explains how to use the editor, how to prepare importable JSON, and how to ask any external LLM to generate assets and animations for LowPoly64.
</p>
</section>
<aside class="panel">
<div class="toc">
<a href="#workflow" data-help="tocWorkflow">Basic workflow</a>
<a href="#svg-workbench" data-help="tocSvgWorkbench">SVG workbench</a>
<a href="#avatar-forge" data-help="tocAvatarForge">Avatar Forge</a>
<a href="#ai-textures" data-help="tocAiTextures">AI textures</a>
<a href="#template-files" data-help="tocTemplateFiles">Template files</a>
<a href="#object-json" data-help="tocObjectJson">Object JSON</a>
<a href="#animation-json" data-help="tocAnimationJson">Animation JSON</a>
<a href="#prompts" data-help="tocPrompts">Ready prompts for LLMs</a>
<a href="#creation" data-help="tocCreation">Ways to create JSON</a>
<a href="#quality" data-help="tocQuality">Quality checklist</a>
</div>
</aside>
</div>
<section id="intro" class="section panel">
<h2 data-help="introTitle">What this app is</h2>
<p class="lead" data-help="introLead">
LowPoly64 is a retro 3D editor for building low-poly objects, character pieces and simple animations with JSON-first workflows.
</p>
<div style="margin-top: 12px;">
<a id="project-link" href="https://github.com/IAnMove/LowPoly64" target="_blank" rel="noreferrer">Project page: https://github.com/IAnMove/LowPoly64</a>
</div>
</section>
<section id="workflow" class="section panel">
<h2 data-help="workflowTitle">Basic workflow</h2>
<div class="grid">
<div class="card">
<h3 data-help="workflowCreateTitle">1. Create or import</h3>
<ul class="list" id="workflow-create-list"></ul>
</div>
<div class="card">
<h3 data-help="workflowEditTitle">2. Edit in the viewport</h3>
<ul class="list" id="workflow-edit-list"></ul>
</div>
<div class="card">
<h3 data-help="workflowAnimateTitle">3. Add animation when needed</h3>
<ul class="list" id="workflow-animate-list"></ul>
</div>
<div class="card">
<h3 data-help="workflowExportTitle">4. Export your result</h3>
<ul class="list" id="workflow-export-list"></ul>
</div>
</div>
</section>
<section id="svg-workbench" class="section panel">
<h2 data-help="svgWorkbenchTitle">SVG workbench</h2>
<p class="lead" data-help="svgWorkbenchLead">
Use the SVG workbench when you want to import raw SVG, a file, pixel art or text and keep the original source attached to the generated model.
</p>
<div class="grid">
<div class="card">
<h3 data-help="svgWorkbenchSourcesTitle">Source modes</h3>
<ul class="list" id="svg-workbench-sources-list"></ul>
</div>
<div class="card">
<h3 data-help="svgWorkbenchRoundtripTitle">Roundtrip and editing</h3>
<ul class="list" id="svg-workbench-roundtrip-list"></ul>
</div>
<div class="card">
<h3 data-help="svgWorkbenchHeadRecipeTitle">Inflated head recipe</h3>
<ul class="list" id="svg-workbench-head-recipe-list"></ul>
</div>
<div class="card">
<h3 data-help="svgWorkbenchLimitsTitle">Guardrails and limits</h3>
<ul class="list" id="svg-workbench-limits-list"></ul>
</div>
</div>
</section>
<section id="avatar-forge" class="section panel">
<h2 data-help="avatarForgeTitle">Avatar Forge</h2>
<p class="lead" data-help="avatarForgeLead">
Use Avatar Forge to assemble rig-ready humanoid avatars from curated body and face presets, then reopen those avatars later through the saved recipe.
</p>
<div class="grid">
<div class="card">
<h3 data-help="avatarForgeCreateTitle">Create and edit</h3>
<ul class="list" id="avatar-forge-create-list"></ul>
</div>
<div class="card">
<h3 data-help="avatarForgeRoundtripTitle">Roundtrip and persistence</h3>
<ul class="list" id="avatar-forge-roundtrip-list"></ul>
</div>
<div class="card">
<h3 data-help="avatarForgeRigTitle">Rig and export</h3>
<ul class="list" id="avatar-forge-rig-list"></ul>
</div>
<div class="card">
<h3 data-help="avatarForgeLimitsTitle">Scope and limits</h3>
<ul class="list" id="avatar-forge-limits-list"></ul>
</div>
</div>
</section>
<section id="ai-textures" class="section panel">
<h2 data-help="aiTexturesTitle">AI textures</h2>
<p class="lead" data-help="aiTexturesLead">
Use the AI texture workflow to configure a backend, write or enhance prompts, generate directly into the canvas or a tile, and keep local backups while you iterate.
</p>
<div class="grid">
<div class="card">
<h3 data-help="aiTexturesSetupTitle">Setup and backends</h3>
<ul class="list" id="ai-textures-setup-list"></ul>
</div>
<div class="card">
<h3 data-help="aiTexturesPromptTitle">Prompt workflow</h3>
<ul class="list" id="ai-textures-prompt-list"></ul>
</div>
<div class="card">
<h3 data-help="aiTexturesTilesTitle">Grid and tile editing</h3>
<ul class="list" id="ai-textures-tiles-list"></ul>
</div>
<div class="card">
<h3 data-help="aiTexturesSaveTitle">Auto-save and backups</h3>
<ul class="list" id="ai-textures-save-list"></ul>
</div>
</div>
</section>
<section id="template-files" class="section panel">
<h2 data-help="templateFilesTitle">Template files on disk</h2>
<p class="lead" data-help="templateFilesLead">
Reusable library assets now live as one JSON file per asset under src/data/templates.
</p>
<div class="note" data-help="templateFilesNote"></div>
<div class="grid" style="margin-top: 18px;">
<div class="card">
<h3 data-help="templateFilesPathsTitle">Folders</h3>
<ul class="list" id="template-files-paths-list"></ul>
</div>
<div class="card">
<h3 data-help="templateFilesRulesTitle">Rules</h3>
<ul class="list" id="template-files-rules-list"></ul>
</div>
</div>
<div style="margin-top: 18px;">
<div class="code-toolbar">
<strong data-help="templateExampleTitle">Template file example</strong>
<button class="copy" type="button" data-copy-target="template-file-example" data-help="copy">Copy</button>
</div>
<pre><code id="template-file-example"></code></pre>
</div>
</section>
<section id="object-json" class="section panel">
<h2 data-help="objectJsonTitle">Object JSON</h2>
<p class="lead" data-help="objectJsonLead">
LowPoly64 imports objects as a root object with a name and a pieces array. Each piece describes one visible part of the model.
</p>
<div class="note" data-help="objectJsonNote"></div>
<div class="grid" style="margin-top: 18px;">
<div class="card">
<h3 data-help="objectFieldsTitle">Important fields</h3>
<ul class="list" id="object-fields-list"></ul>
</div>
<div class="card">
<h3 data-help="objectTypesTitle">Supported geometry types</h3>
<div id="object-types-pills"></div>
</div>
<div class="card">
<h3 data-help="objectLimitsTitle">Validation limits</h3>
<ul class="list" id="object-limits-list"></ul>
</div>
</div>
<div style="margin-top: 18px;">
<div class="code-toolbar">
<strong data-help="objectExampleTitle">Object JSON example</strong>
<button class="copy" type="button" data-copy-target="object-json-example" data-help="copy">Copy</button>
</div>
<pre><code id="object-json-example"></code></pre>
</div>
</section>
<section id="animation-json" class="section panel">
<h2 data-help="animationJsonTitle">Animation JSON</h2>
<p class="lead" data-help="animationJsonLead">
Animations target piece names that already exist inside the selected group. Tracks can animate position, rotation, scale and visible.
</p>
<div class="note warning" data-help="animationJsonWarning"></div>
<div class="grid" style="margin-top: 18px;">
<div class="card">
<h3 data-help="animationFieldsTitle">Important fields</h3>
<ul class="list" id="animation-fields-list"></ul>
</div>
<div class="card">
<h3 data-help="animationFlowTitle">Import flow</h3>
<ul class="list" id="animation-flow-list"></ul>
</div>
<div class="card">
<h3 data-help="animationLimitsTitle">Validation limits</h3>
<ul class="list" id="animation-limits-list"></ul>
</div>
</div>
<div style="margin-top: 18px;">
<div class="code-toolbar">
<strong data-help="animationExampleTitle">Animation JSON example</strong>
<button class="copy" type="button" data-copy-target="animation-json-example" data-help="copy">Copy</button>
</div>
<pre><code id="animation-json-example"></code></pre>
</div>
</section>
<section id="prompts" class="section panel">
<h2 data-help="promptsTitle">Ready prompts for LLMs</h2>
<p class="lead" data-help="promptsLead">
These prompts are designed for ChatGPT, Claude, Gemini, DeepSeek, Mistral, Grok or similar tools. Paste the prompt, then add your asset description at the end.
</p>
<div class="grid" style="margin-top: 18px;">
<div class="card">
<div class="code-toolbar">
<strong data-help="objectPromptLightTitle">Light object prompt</strong>
<button class="copy" type="button" data-copy-target="object-prompt-light" data-help="copy">Copy</button>
</div>
<pre><code id="object-prompt-light"></code></pre>
</div>
<div class="card">
<div class="code-toolbar">
<strong data-help="objectPromptFullTitle">Full object prompt</strong>
<button class="copy" type="button" data-copy-target="object-prompt-full" data-help="copy">Copy</button>
</div>
<pre><code id="object-prompt-full"></code></pre>
</div>
<div class="card">
<div class="code-toolbar">
<strong data-help="svgHeadPromptTitle">SVG head prompt</strong>
<button class="copy" type="button" data-copy-target="svg-head-prompt" data-help="copy">Copy</button>
</div>
<pre><code id="svg-head-prompt"></code></pre>
</div>
<div class="card">
<div class="code-toolbar">
<strong data-help="animationPromptLightTitle">Light animation prompt</strong>
<button class="copy" type="button" data-copy-target="animation-prompt-light" data-help="copy">Copy</button>
</div>
<pre><code id="animation-prompt-light"></code></pre>
</div>
<div class="card">
<div class="code-toolbar">
<strong data-help="animationPromptFullTitle">Full animation prompt</strong>
<button class="copy" type="button" data-copy-target="animation-prompt-full" data-help="copy">Copy</button>
</div>
<pre><code id="animation-prompt-full"></code></pre>
</div>
</div>
</section>
<section id="creation" class="section panel">
<h2 data-help="creationTitle">Ways to create JSON</h2>
<p class="lead" data-help="creationLead">
There is no single best path. Choose the workflow that loses the least information for the asset type you are building.
</p>
<div class="grid">
<div class="card">
<h3 data-help="creationMethodsTitle">Practical options</h3>
<ul class="list" id="creation-methods-list"></ul>
</div>
<div class="card">
<h3 data-help="creationSequenceTitle">Recommended sequence</h3>
<ul class="list" id="creation-sequence-list"></ul>
</div>
</div>
</section>
<section id="quality" class="section panel">
<h2 data-help="qualityTitle">Quality checklist</h2>
<p class="lead" data-help="qualityLead">
Use this checklist when you want JSONs and animations that are good enough to keep, not just good enough to import.
</p>
<div class="grid">
<div class="card">
<h3 data-help="qualityObjectTitle">Object quality</h3>
<ul class="list" id="quality-object-list"></ul>
</div>
<div class="card">
<h3 data-help="qualityAnimationTitle">Animation quality</h3>
<ul class="list" id="quality-animation-list"></ul>
</div>
</div>
</section>
<div class="footer" data-help="footer">
Keep names stable between object pieces and animation targets. If the names do not match, animation tracks will be skipped.
</div>
</div>
<script type="module" src="/src/help.js"></script>
</body>
</html>