-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
416 lines (314 loc) · 7.7 KB
/
index.html
File metadata and controls
416 lines (314 loc) · 7.7 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
<!DOCTYPE html>
<html>
<head>
<title>Comic-Web</title>
<script
id="comic-web"
type="module"
src="plugin.js"
data-url-dir="./comic"
data-file-type="svg"
data-width="500"
data-height="500"
data-text-size="16"
></script>
<style>
body {
font-family: sans-serif;
font-size: 20px;
}
</style>
</head>
<body>
<h1>Comic-Web</h1>
<p>
Comic-Web is a <b>markup language</b> designed to bring your comic creations to life, and rendering engine for that language.
</p>
<h1>The Markup Language</h1>
<p>
The Comic-Web markup language is quite simple, you can master it in minutes.
</p>
<figure>
<img class="comic-web-panel" src="./comic/01.svg" alt="
THE STUDIO
JENCEL (happy)
Hi, welcome to Comic-web's readme!
I am Jencel, creator of this format.
"></img>
<pre>
THE STUDIO
JENCEL (happy)
Hi, welcome to Comic-web's readme!
</pre>
</figure>
<h2>
Layers
</h2>
<p>
Every capitalized word followed by an empty line defines a layer in your comic panel.
</p>
<figure>
<img class="comic-web-panel" src="./comic/02.svg" alt="
THE STUDIO
"></img>
<pre>
THE STUDIO
</pre>
</figure>
<p>
The rendering engine searches for an image matching the layer name in your designated folder. File names are lowercase and use dashes instead of spaces (e.g., 'THE STUDIO' becomes 'the-studio.svg').
</p>
<h2>
Stacking
</h2>
<p>
Each new layer stacks on top of the previous one, allowing you to build complex scenes.
</p>
<figure>
<img class="comic-web-panel" src="./comic/03.svg" alt="
THE STUDIO
A CAT
"></img>
<pre>
THE STUDIO
A CAT
</pre>
</figure>
<p>
You can stack as many layers as you like—just ensure they’re transparent, or they’ll overlap completely.
</p>
<h2>
Characters
</h2>
<p>
When a layer line is followed by non-capitalized lines (without an empty line in between), the engine treats it as a character with dialogue. The character’s image is scaled to make room for their speech bubble.
</p>
<figure>
<img class="comic-web-panel" src="./comic/04.svg" alt="
THE STUDIO
A CAT
JENCEL
Oh cool, I'm here again.
"></img>
<pre>
THE STUDIO
A CAT
JENCEL
Oh cool, I'm here again.
</pre>
</figure>
<p>
In this example, the image "jencel.svg" is scaled slightly to ensure the text panel is visible.
</p>
<h2>
Moods
</h2>
<p>
Organize your files better by using "moods"! Enclose a mood in brackets next to the character’s name, and the engine will look for the image in the corresponding folder (e.g., "./jencel/sad.svg"). If the mood-specific image isn’t found, it defaults to the base character image.
</p>
<figure>
<img class="comic-web-panel" src="./comic/06.svg" alt="
THE STUDIO
JENCEL (sad)
Oh, where did the cat go?
"></img>
<pre>
THE STUDIO
JENCEL (sad)
Oh, where did the cat go?
</pre>
</figure>
<p>
You can even chain moods with a comma-separated list. For example, "JENCEL (sad, closeup)" will search for "./jencel/sad/closeup.svg" before falling back to "./jencel/sad.svg" or "./jencel.svg".
</p>
<p>
To see how it all comes together, you can <a href="https://github.com/abuseofnotation/comic-web-markup/tree/main/comic">explore the folder structure of this comic</a>.
</p>
<h2>
Stacking Characters
</h2>
<p>
Bring multiple characters into the scene, and the engine will automatically position them and their speech bubbles for maximum impact.
</p>
<figure>
<img class="comic-web-panel" src="./comic/04.svg" alt="
THE STUDIO
A CAT
JENCEL
This is my co-host, Alyssa!
Welcome, Alyssa
ALYSSA (angry)
Ah, couldn't you at least
clean this place a bit?
JENCEL
Shhh, it's out of frame.
"></img>
<pre>
JENCEL
This is my co-host, Alyssa!
Welcome, Alyssa
ALYSSA (angry)
Ah, couldn't you at least
clean this place a bit?
JENCEL
Shhh, it's out of frame.
</pre>
</figure>
<p>
The engine arranges characters and their dialogue based on the order they’re defined.
</p>
<h2>
Stacking Characters CONTD
</h2>
<p>
You can have as many characters as you want and there isn't any special way to describe characters, any image can be a character.
</p>
<figure>
<img class="comic-web-panel" src="./comic/05.svg" alt="
THE STUDIO
JENCEL
Here
kitty
kitty
kitty...
ALYSSA
Hi.
A CAT
Meowww!
"></img>
<pre>
THE STUDIO
JENCEL
Here
kitty
kitty
kitty...
ALYSSA
Hi.
A CAT
Meowww!
</pre>
</figure>
<p>
The arrangement of characters corresponds to their dialogue.
</p>
<h2>
Narrators and Off-Screen Dialogue
</h2>
<p>
For off-screen dialogue, use the "off-screen" mood to keep characters out of the frame while still letting them speak.
</p>
<p>
The special 'NARRATOR' character is always off-screen, and their dialogue appears at the top or bottom of the panel, just like in traditional comics.
</p>
<figure>
<img class="comic-web-panel" src="./comic/06.svg" alt="
THE STUDIO
NARRATOR
Later...
ALYSSA
So, what are you doing over there?
Cleaning?
JENCEL (off-screen)
Yeees!
NARRATOR
He wasn't...
"></img>
<pre>
THE STUDIO
NARRATOR
Later...
ALYSSA
So, what are you doing over there?
Cleaning?
JENCEL (off-screen)
Yeees!
NARRATOR
He wasn't...
</pre>
</figure>
<p>
</p>
<h2>
Custom Images
</h2>
<p>
If you want, you can always include a fully custom-drawn panel. And if you want to mix custom artwork with Comic-Web’s speech balloons, simply use the "off-screen" mood for characters.
</p>
<figure>
<img class="comic-web-panel" src="./comic/06.svg" alt="
The studio
Jencel and Alyssa hugging
Alyssa (off-screen)
Mmmmm.
Jencel (off-screen)
Love you, see you in the next section.
"></img>
<pre>
The studio
Jencel and Alyssa hugging
Alyssa (off-screen)
Mmmmm.
Jencel (off-screen)
Love you, see you in the next section.
</pre>
</figure>
<h1>The Toolchain</h1>
<p>
Now that you’ve mastered the markup, let’s dive into how you can use it to bring your comics to life.
</p>
<h2>The API</h2>
<p>
Comic-Web’s API, found in <b>lib/index.js</b>, is simple. It features a single JavaScript function, <b>renderComic</b>, which takes a string of panel descriptions and a directory of images. It returns an SVG DOM element, ready to be displayed in your page.
</p>
<h2>The Plugin</h2>
<p>
The plugin is the easiest way to integrate Comic-Web into your HTML pages. Here’s how it works:
</p>
<p>
1. Include the plugin file in your HTML page, like this. The data attribute allows you to configure the URL directory where you store your images, as well as some other parameters.
</p>
<pre>
<script
id="comic-web"
type="module"
src="https://abuseofnotation.github.io/comic-web-markup/plugin.js"
data-url-dir="./comic"
data-file-type="svg"
data-width="500"
data-height="500"
data-text-size="16"
></script>
</pre>
<p>
2. Insert an image with class <b>comic-web-panel</b>, and place the script in the <b>alt-text</b> property (the src can be empty, or can point to a non-existent filename, if you want to generate it):
</p>
<pre>
<img class="comic-web-panel" src="./comic/01.svg" alt="
THE STUDIO
JENCEL (happy)
Hi, welcome to Comic-web's readme!
I am Jencel, creator of this format.
"></img>
</pre>
<p>
The plugin will automatically generate a panel in place of the image.
</p>
<h2>Editor</h2>
<p>
Looking for an interactive way to create your comics? Try the Comic-Web editor—it’s the perfect playground for experimenting with your ideas.
<p><a href="editor.html">Give it a try!</a></p>
</p>
<h2>Image generator</h2>
<p>
There is also a command-line tool, located at "bin/index.js" that generates images from Comic Web scripts. To use it, pass the name of a text-file as an argument and the tool will generate a png image of this panel, in the same directory, for example:
</p>
<pre>
node bin/index.js jokes/one.md
</pre>
<h2>Styling</h2>
<p>
Comic-Web also includes a <b>style.css</b> file, embedded into all generated images. This file controls the appearance of frames, speech balloons, and more.
</p>
</body>
</html>