ComicStripScript/documentation.html at gh-pages · yukiy/ComicStripScript · GitHub

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
<style>
	body{
		font-family: "Comic Sans MS", cursive, sans-serif;
	}
	pre {
		background: #EEEEEE;
	}

	hr{
		margin-top: 50px;
		margin-bottom: 50px;
	}

	i{
		color: #0000AA;
	}

	th{
		font-weight: normal;
	}

	div{
		margin: 30px;
	}
</style>

<body>
<h1>ComicStriptScript Documentation</h1>
<div>
	<p><strong>Define the title</strong></p>

	<pre><code>
	---TITLE
	<i>title_you_define</i>
	</code></pre>

	example:
	<pre><code>
	---TITLE
	Mickey's day
	</code></pre>
</div>

<hr/>

<div>
	<p><strong>Define characters</strong></p>

	<pre><code>
	---CAST
	Starring <i>folder_path</i> as <i>charactername_you_define</i>
	</code></pre>

	example:
	<pre><code>
	---CAST
	Starring mickey as M
	</code></pre>

	See more details <a href="#howtoadd">How to add your characters</a>
</div>

<hr/>

<div>
	<p><strong>Draw characters</strong></p>

	Right-pointing
	<pre><code>
	<i>character_name_you_define</i> : <i>emoticon</i> <(" <i>script</i> ")
	</code></pre>

	Left-pointing
	<pre><code>
	<i>character_name_you_define</i> : (" <i>script</i> ")> <i>emoticon</i>
	</code></pre>

	*Use <code>\n</code> for line break.<br/>
	*Available emoticons are <a href="#emoticontable">here</a>.
	<br/>

</div>

<div>
	<p><strong>Divide scene</strong></p>
	<pre><code>
	---
	</code></pre>

	example:
	<pre><code>
	---
	M : ('-') <("HELLO \nMY NAME IS \nMICKEY.")

	---
	M : ("WHAT!?\n ARE YOU MICKEY?")> (;ﾟﾛﾟ)

	---
	M : (｀ε´) <("YES. \nI AM \nMICKEY MOUSE.")
	M : ("")> (･_･)

	</code></pre>

</div>


<hr/>


<div id="howtoadd">
	<p><strong>How to add your character</strong></p>

	<p>
	1. Prepare PNG files to represent each emoticon.<br/>
	2. Name each file as corresponding numbers on <a href="#emoticontable">Emoticon Table.</a><br/>
	3. Name the folder as a character name.<br/>
	</p>
	It will look like this.<br/>
	<img src='./img/character_sample.png' width="750px"/>
</div>

<hr/>

<div id="emoticontable">
	<strong>Emoticon Table</strong>
	<table>
		<tr>
			<th>Index</th>
			<th>|</th>
			<th>Expression</th>
		</tr>
		<tr>
			<th>0</th>
			<th>|</th>
			<th>('-')</th>
		</tr>
		<tr>
			<th>1</th>
			<th>|</th>
			<th>(;ﾟﾛﾟ)</th>
		</tr>
		<tr>
			<th>2</th>
			<th>|</th>
			<th>(^o^)</th>
		</tr>
		<tr>
			<th>3</th>
			<th>|</th>
			<th>(｀ε´)</th>
		</tr>
		<tr>
			<th>4</th>
			<th>|</th>
			<th>(･_･)</th>
		</tr>
		<tr>
			<th>5</th>
			<th>|</th>
			<th>(:_;)</th>
		</tr>

		<tr>
			<th>-</th>
			<th>-</th>
			<th>*Additional Expression</th>
		</tr>

		<tr>
			<th>100</th>
			<th>|</th>
			<th>ʕ•̫͡•ʕ*̫͡*ʕ•͓͡•ʔ-̫͡-ʕ•̫͡•ʔ*̫͡*ʔ-̫͡-ʔ</th>
		</tr>
		<tr>
			<th>101</th>
			<th>|</th>
			<th>((⊂(`ω´∩)</th>
		</tr>
		<tr>
			<th>102</th>
			<th>|</th>
			<th>(;´༎ຶД༎ຶ`)</th>
		</tr>
		<tr>
			<th>103</th>
			<th>|</th>
			<th>(๑˃̶ꇴ˂̶)♪⁺</th>
		</tr>
		<tr>
			<th>104</th>
			<th>|</th>
			<th>ฅ^•ﻌ•^ฅ</th>
		</tr>
	</table>
	<br/>
	*As advanced option, you can build your emoticon table by modifying ComicStripScript.js. User Emoticons's id starts from 100.<br/>
	<br/>
	More default expressions will be added in future. It's aiming to have compatibilities between characters, so you can easily change the character with same scripts.<br/>
</div>

<hr/>

<div>
	<strong>Full example with User Emoticons</strong><br/>
	<pre><code>
	---TITLE
	I LOVE CATS

	---CAST
	Starring harmony as H
	Starring cat as C
	Starring godofcats as GC


	---
	H : (๑˃̶ꇴ˂̶)♪⁺ <("I LOVE CATS♡")

	---
	C : ("Nyan")> ฅ^•ﻌ•^ฅ

	---
	H : (;´༎ຶД༎ຶ`) <("I LOVE.. \nI LOVE CATS \nTOO MUCH..")

	---
	GC:("MAY THE CATS \nWITH YOU")> ʕ•̫͡•ʕ*̫͡*ʕ•͓͡•ʔ-̫͡-ʕ•̫͡•ʔ*̫͡*ʔ-̫͡-ʔ
	</code></pre>

	<br/>
	To start building your own, write codes between &lt;code id="comicsource"&gt; &lt;/code&gt; in empty.html
</div>


</body>