-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.html
383 lines (363 loc) · 17.5 KB
/
docs.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
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="keywords"
content="DS Creator, DS, Creator, ds, ds game maker, DS Game Maker, make ds games, dsgm, ds game maker, nds, homebrew, ds homebrew, nds homebrew, 3ds, 3ds homebrew, ds games, ds game, make your own ds game">
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" type="image/png" sizes="2500x2500" href="./public/imgs/DSC_Logo.png">
<!-- Change the description wrt project -->
<meta name="description"
content="A game engine for Windows, Linux, and macOS that allows anyone to make DS games with ease!" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<!-- You can add your own fonts from fonts.google.com -->
<link href="https://fonts.googleapis.com/css2?family=Poppins&display=swap" rel="stylesheet" />
<!-- Default Script tags -->
<script src="https://cdn.tailwindcss.com"></script>
<script src="./public/js/index.js"></script>
<!-- Replace the title name -->
<title>DS Creator Docs : Docs</title>
</head>
<body style="font-family: 'Poppins', sans-serif">
<!-- Header start here -->
<header class="w-full p-3 border flex" style="background-color:lightgray;">
<nav
class="w-full flex flex-col lg:flex-row md:flex-row sm:flex-row items-start lg:item-center md:item-center sm:item-center lg:justify-between md:justify-between sm:justify-between justify-start">
<ul>
<!-- You can change your logo name -->
<li class="font-mono text-xl">DS Creator</li>
</ul>
<ul id="header-nav" class="mr-6 sm:flex md:flex lg:flex hidden">
<li class="mr-5 mb-3 mt-5 sm:mb-0 sm:mt-0 md:mb-0 md:mt-0 lg:mb-0 lg:mt-0">
<a href="./index.html">Home</a>
</li>
<div>
<ul class="flex">
<li class="mr-5">
<a href="https://discord.com/invite/CqrXmqxAf8"><img src="./public/svgs/discord.svg"
alt="Discord Link" /></a>
</li>
<li class="mr-5">
<a href="https://github.com/DS-Creator-Dev/DS-Creator"><img src="./public/svgs/github.svg"
alt="GitHub Link" /></a>
</li>
<li class="mr-0">
<a href="https://www.youtube.com/channel/UCpPIw9q3QlrpsNsurh2Tzjw"><img src="./public/svgs/youtube.svg"
alt="YouTube Link" /></a>
</li>
</ul>
</div>
</ul>
</nav>
<div class="sm:hidden flex" onclick="OnclickOpenMenu()" id="open-menu">
<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" viewBox="0 0 20 20" fill="currentColor">
<path fill-rule="evenodd"
d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z"
clip-rule="evenodd" />
</svg>
</div>
<div class="hidden" onclick="OnclickCloseMenu()" id="close-menu">
<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M6 18L18 6M6 6l12 12" />
</svg>
</div>
</header>
<!-- Header ends here -->
<div class="flex flex-col md:flex-row lg:flex-row">
<!-- Side menu starts here -->
<nav class="flex ml-10 mt-7 md:fixed lg:fixed" data-spy="affix" data-offset-top="300" data-offset-bottom="200"
role="navigation">
<ul class="nav">
<li class="font-medium"><a href="#Get_Start">Getting Started</a></li>
<li class="font-medium">
<a href="#Install">Installation</a>
<ul class="nav">
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#Install_Win">Windows</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#Install_Mac">macOS</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#Install_LinDeb">Debian Linux</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#Install_LinHat">Red Hat Linux</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#Install_LinRas">Raspberry Pi OS</a>
</li>
</ul>
</li>
<li class="font-medium">
<a href="#Assets">Assets</a>
<ul class="nav">
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#bcgrn">Backgrounds</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#spr">Sprites</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#msc">Music</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#sfx">Sound Effects</a>
</li>
</ul>
</li>
<li class="font-medium">
<a href="#ActScn">Actors & Scenes</a>
<ul class="nav">
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#act">Actors</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#scn">Scenes</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#evts">Events</a>
</li>
</ul>
</li>
<li class="font-medium">
<a href="#DSCEL">DSCEngine</a>
<ul class="nav">
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#DSCELA">About</a>
</li>
<li class="text-[#111] pl-[20px] font-[400] border-l-[2px]">
<a href="#DSCELD">Docs</a>
</li>
</ul>
</li>
<li class="font-medium"><a href="#bugs">Issues</a></li>
</ul>
</nav>
<!-- Side Menu ends here -->
<div class="pl-5 md:pl-[250px] lg:pl-[250px]">
<section id="Get_Start">
<div class="h-full mt-10">
<p class="font-normal text-2xl">Getting Started</p>
<p class="leading-0 w-3/4">
DS Creator is a game engine that allows users to create their very own DS games! DS Creator is easy to use.
</p>
</div>
</section>
<section id="Install">
<div class="h-full mt-5">
<p class="font-normal text-2xl">Installation</p>
</div>
<section id="Install_Win" class="border-l-[2px]">
<div class="h-full mt-3 ml-5">
<p class="font-normal text-xl">Windows</p>
<p>Start by downloading and extracting DS Creator for Windows.</p>
<a href="https://bowersindustry.itch.io/ds-creator" style="color:blue;"
target="_blank">https://bowersindustry.itch.io/ds-creator</a>
<br><br>
<p>Next, go to the devkitPro GitHub releases and download the "devkitProUpdater-3.0.3.exe" from under
"devkitPro Updater v3.0.3".</p>
<a href="https://github.com/devkitPro/installer/releases" style="color:blue;"
target="_blank">https://github.com/devkitPro/installer/releases</a>
<br><br>
<p>Once that is done downloading, run it.<br>Click on "Next".</p>
<img src="./public/imgs/Win_devkitPro_1.png" />
<br><br>
<p>Make sure the "Remove downloaded files" option is checked. Then click "Next".</p>
<img src="./public/imgs/Win_devkitPro_2.png" />
<br><br>
<p>Make sure only "NDS Development" is checked. Then click "Next".</p>
<img src="./public/imgs/Win_devkitPro_3.png" />
<br><br>
<p>It will then start installing.<br>Once it is done, you will see this,</p>
<img src="./public/imgs/Win_devkitPro_4.png" />
<p>Click "Next". You are finished installing libnds!</p>
<br><br>
<p>It will ask you if you want to donate. (If you donate, it will not support me. It supports devkitPro, but
I highly recommend donating!) Click "Finish" and it will close.</p>
<img src="./public/imgs/Win_devkitPro_5.png" />
<br><br>
<p>Next, open the folder with the extracted DS Creator in it. Then, open "DS Creator.exe" and have fun
making your DS game!</p>
</div>
</section>
<section id="Install_Mac" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">macOS</p>
<p class="text-sm pb-4">Coming Soon</p>
</div>
</section>
<section id="Install_LinDeb" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Debian Linux</p>
<p>Start by downloading and installing DS Creator for Debian.</p>
<a href="https://bowersindustry.itch.io/ds-creator" style="color:blue;"
target="_blank">https://bowersindustry.itch.io/ds-creator</a>
<br><br>
<p>Next, open up the terminal. Then, run these commands. Put in your password if prompted.</p>
<script src="https://gist.github.com/BowersIndustry/dff95aa1d62016aa6ae0e4e2e785b029.js"></script>
<br><br>
<p>Then download either the "devkitpro-pacman.amd64.deb" or "devkitpro-pacman.arm64.deb" based on your Linux
distro.</p>
<a href="https://github.com/BowersIndustry/devkitPro-for-linux/releases/tag/not_Rpi" style="color:blue;"
target="_blank">https://github.com/BowersIndustry/devkitPro-for-linux/releases/tag/not_Rpi</a>
<br><br>
<p>Next, run this command. Be sure to replace "path_to_downloaded_.deb_file" is replaced with the path to
the real .deb file you downloaded.</p>
<script src="https://gist.github.com/BowersIndustry/250a5a8686069ec97625edcca0b43b9a.js"></script>
<br><br>
<p>After that, run this command,</p>
<script src="https://gist.github.com/BowersIndustry/eaa3f87f02f07ebb04868ddb6b94c877.js"></script>
<br><br>
<p>Then, run this last command. Be sure to type "Y" anytime it prompts you to.</p>
<script src="https://gist.github.com/BowersIndustry/2df4bcab9972d01215babbdb9e6b9af6.js"></script>
<br><br>
<p>Once all that is done, reboot the system.<br>Then, open DS Creator and have fun making your DS game!</p>
</div>
</section>
<section id="Install_LinHat" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Red Hat Linux</p>
<p>Coming Soon</p>
</div>
</section>
<section id="Install_LinRas" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Raspberry Pi OS</p>
<p>Start by downloading and installing DS Creator for Raspberry Pi.</p>
<a href="https://bowersindustry.itch.io/ds-creator" style="color:blue;"
target="_blank">https://bowersindustry.itch.io/ds-creator</a>
<br><br>
<p>Next, download the "devkitPro_r50-raspberry_pi-linux.deb" file from this link.</p>
<a href="https://github.com/BowersIndustry/devkitPro-for-linux/releases/tag/RPi" style="color:blue;"
target="_blank">https://github.com/BowersIndustry/devkitPro-for-linux/releases/tag/RPi</a>
<br><br>
<p>Then, run this command. Replace "path_to_downloaded_file" with the real path to the downloaded file.</p>
<script src="https://gist.github.com/BowersIndustry/7bb5793c104719b25b6e3035b0ac1832.js"></script>
</div>
</section>
</section>
<section id="Assets">
<div class="h-full mt-5">
<p class="font-normal text-2xl">Assets</p>
<p class="text-sm pt-2 pb-4">Assets are all the art and audio you use in your game.</p>
</div>
<section id="bcgrn" class="border-l-[2px]">
<div class="h-full mt-3 ml-5">
<p class="font-normal text-xl">Backgrounds</p>
<p>Backgrounds can only have a max of 256 colors and no more. The smallest a background can be is 256px
horizontally and 192px vertically. Backgrounds sizes must be a multiple of 8.</p>
</div>
</section>
<section id="spr" class="border-l-[2px]">
<div class="h-full mt-3 ml-5">
<p class="font-normal text-xl">Sprites</p>
<p>Sprites can only have a max of 256 colors (including the transparent color). The default transparency
color is <a style="color:#FF00FF;">#FF00FF</a>. Sprites can only be 8x8, 16x16, 32x32, 64x64, 16x8, 32x8,
32x16, 64x32, 8x16, 8x32, 16x32, or 32x64 pixels per frame.</p>
</div>
</section>
<section id="msc" class="border-l-[2px]">
<div class="h-full mt-3 ml-5">
<p class="font-normal text-xl">Music</p>
<p>Music (songs) are in the ".mod" format. Music goes in the "audio" folder of your project. Here is a list
of applications you can use to make music,</p>
<p>• <a href="https://openmpt.org/" style="color:blue;" target="_blank">OpenMPT</a><br>• <a
href="https://milkytracker.org/" style="color:blue;" target="_blank">Milky Tracker</a><br>• <a
href="https://www.stef.be/bassoontracker/" style="color:blue;" target="_blank">BassoonTracker</a></p>
</div>
</section>
<section id="sfx" class="border-l-[2px]">
<div class="h-full mt-3 ml-5">
<p class="font-normal text-xl">Sound Effects</p>
<p>Sound effects must be in the ".wav" format. All sound effects go in the "audio" folder of your project.
Any audio program that can export to ".wav" will work.</p>
</section>
</section>
<section id="ActScn">
<div class="h-full mt-5">
<p class="font-normal text-2xl">Actors & Scenes</p>
</div>
<section id="act" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Actors</p>
<p>Actors are basically code that has a sprite. Actors have "on init" code that runs when that scene is
first loaded, and "on update" code which runs every frame.<br>Each scene can only have 127 actors (not
including the player).</p>
</div>
</section>
<section id="scn" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Scenes</p>
<p>Scenes have "on init" code just like actors.</p>
</div>
</section>
<section id="evts" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Events</p>
<p>Coming Soon</p>
</div>
</section>
</section>
<section id="DSCEL">
<div class="h-full mt-5">
<p class="font-normal text-2xl">DSCEngine</p>
</div>
<section id="DSCELA" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">About</p>
<p>Coming soon.</p>
</div>
</section>
<section id="DSCELD" class="border-l-[2px]">
<div class="h-full mt-5 ml-5">
<p class="font-normal text-xl">Docs</p>
<p>Check out the docs <a href="./docs/dsc-engine/index.html" style="color: blue;">here</a>.</p>
</div>
</section>
</section>
<section id="bugs">
<div class="h-full mt-5">
<p class="font-normal text-2xl">Issues</p>
<p class="text-sm pt-5 pb-4">
If you find either mistakes in spelling or false info, please leave an issue on the
<a href="https://github.com/BowersIndustry/ds-creator-docs/issues/new" target="_blank"
style="color:blue;">GitHub repo.</a>
</p>
</div>
</section>
<!-- Link6 ends -->
</div>
</div>
<!-- Footer starts here -->
<footer>
<div class="bg-black h-30 py-1 px-1 mt-5">
<div tabindex="0" aria-label="footer"
class="focus:outline-none mx-auto container flex flex-col items-center justify-center">
<div class="text-black flex flex-col md:items-center f-f-l pt-0">
<div class="my-6 text-base text-color f-f-l">
<ul class="md:flex items-center">
<li class="md:mr-6 cursor-pointer pt-4 lg:py-0">
<a href="./index.html" class="text-white focus:outline-none focus:underline hover:text-gray-200">Home
</a>
</li>
<li class="md:mr-6 cursor-pointer pt-4 lg:py-0">
<a href="./docs.html" class="text-white focus:outline-none focus:underline hover:text-gray-200">Docs
</a>
</li>
</ul>
</div>
<div class="text-sm text-color mb-10 f-f-l">
<p tabindex="0" class="text-white focus:outline-none">
© 2022 Kenyon Bowers. All rights reserved
</p>
</div>
</div>
</div>
</div>
</footer>
<!-- Footer ends here -->
</body>
</html>