forked from ibnuda/dactyl-keyboard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjson-help.html
173 lines (173 loc) · 10.5 KB
/
json-help.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
{% extends "wrapper.html" %}
{% block content %}
<div class="row">
<div class="column column-75">
<br>
<h2>JSON API</h2>
</div>
</div>
<div class="row">
<div class="column column-75">
<p>This site also accepts json requests for generathing <code>.scad</code> files for manuform and/or lightcycle.
</p>
<p>You can send them to the following links:</p>
<ul>
<li><a href="/api/lightcycle">Lightcycle</a></li>
<li><a href="/api/manuform">Manuform</a></li>
</ul>
<p>Using the following <code>.json</code> file templates:</p>
<ul>
<li><a href="/lightcycle.json"><code>lightcycle.json</code></a></li>
<li><a href="/manuform.json"><code>manuform.json</code></a></li>
</ul>
<p>And folowwing is the explanation and default values for each templates:</p>
<h3>Lightcycle</h3>
<ul>
<li>
<code>keys</code>:
<ul>
<li><code>columns</code>: the number of the columns each side has. Default is <code>5</code></li>
<li><code>num-row</code>: whether it will use a num-row or not. Default is <code>false</code></li>
<li><code>last-row</code>: whether it will use a bottom or not. Default is <code>false</code></li>
<li><code>thumb-count</code>: the number of the thumbkeys each side has. Default is
<code>"two"</code>. Accepted values:
<code>"two"</code>,<code>"three"</code>,<code>"five"</code>,<code>"six"</code>,<code>"eight"</code>.
</li>
<li><code>hide-last-pinky</code>: whether it will hide the last pinky like Kinesis Adv.'s Layout.
Default is <code>false</code>. Accepted values: <code>true</code>, <code>false</code>.</li>
</ul>
</li>
<li>
<code>curve</code>:
<ul>
<li><code>alpha</code>: the curvature of each column. Default is <code>12</code></li>
<li><code>beta</code>: the curvature of each row. Default is <code>36</code></li>
<li><code>tenting</code>: the tenting of the body. Default is <code>12</code></li>
<li><code>thumb-alpha</code>: the curvature of each thumb row. Default is <code>12</code></li>
<li><code>thumb-beta</code>: the curvature of each thumb column. Default is <code>36</code></li>
<li><code>thumb-tenting</code>: the curvature of the thumb cluster. Default is <code>12</code>.</li>
</ul>
</li>
<li>
<code>connector</code>:
<ul>
<li><code>external</code>: whether it uses an external connector or not. Default is
<code>false</code></li>
</ul>
</li>
<li>
<code>form</code>:
<ul>
<li><code>hotswap</code>: whether it uses Dongguan Kaihua Electronics Co., Ltd (originally named
Longhua Electronics)'s hotswap socket or not. Default is <code>false</code></li>
<li><code>thumb-offset-x</code>: the offset of the thumb cluster from the alpha cluster in
<code>x</code> coordinate. Default is <code>52</code></li>
<li><code>thumb-offset-y</code>: the offset of the thumb cluster from the alpha cluster in
<code>y</code> coordinate. Default is <code>42</code></li>
<li><code>wide-pinky</code>: whether it uses wide key (1.5u) on the outermost pinky column or not.
Default is <code>false</code></li>
<li><code>thumb-offset-z</code>: the offset of the thumb cluster from the alpha cluster in
<code>z</code> coordinate. Default is <code>27</code>.</li>
<li><code>z-offset</code>: the height of the body from the floor. Default is <code>10</code>.</li>
<li><code>manuform-offset</code>: whether it uses Dactyl Manuform's column stagger or not. Default
is <code>false</code></li>
<li><code>border</code>: whether it uses wall border or not. Default is <code>true</code></li>
</ul>
</li>
<li>
<code>misc</code>:
<ul>
<li><code>right-side</code>: whether it is the right side or not. Default is <code>true</code></li>
<li><code>screw-inserts</code>: whether it uses the screw inserts or not. Default is
<code>false</code></li>
</ul>
</li>
</ul>
<h3>Manuform</h3>
<ul>
<li>
<code>keys</code>:
<ul>
<li><code>columns</code>: the number of the columns each side has. Default is <code>5</code></li>
<li><code>rows</code>: the number of the rows each side has. Default is <code>4</code></li>
<li><code>thumb-count</code>: the number of the thumbkeys each side has. Default is
<code>"six"</code>. Accepted values:
<code>"two"</code>,<code>"three"</code>,<code>"four"</code>,<code>"five"</code>,<code>"six"</code>.
</li>
<li><code>last-row</code>: the number of keys on the last row. Default is <code>"two"</code>.
Accepted values: <code>"zero"</code>,<code>"two"</code>,<code>"full"</code>.</li>
<li><code>switch-type</code>: whether it uses BOX, MX, or Alps style switch. Default is
<code>BOX</code>. Accepted values: <code>box</code>, <code>mx</code>, <code>alps</code></li>
<li><code>inner-columns</code>: whether it uses the inner-column or not. Default is
<code>normie</code>. Accepted values: <code>normie</code>, <code>innie</code>, and
<code>outie</code>.</li>
<li><code>hide-last-pinky</code>: whether it will hide the last pinky like Kinesis Adv.'s Layout.
Default is <code>false</code>. Accepted values: <code>true</code>, <code>false</code>.</li>
</ul>
</li>
<li>
<code>curve</code>:
<ul>
<li><code>alpha</code>: the curvature of each column (except pinky's column). Default is
<code>12</code></li>
<li><code>pinky-alpha</code>: the curvature of pinky's column. Default is <code>12</code></li>
<li><code>beta</code>: the curvature of each row. Default is <code>36</code></li>
<li><code>centercol</code>: the center curvature of the body. Default is <code>4</code></li>
<li><code>tenting</code>: the tenting of the body. Default is <code>12</code></li>
</ul>
</li>
<li>
<code>connector</code>:
<ul>
<li><code>external</code>: whether it uses an external connector or not. Default is
<code>false</code></li>
<li><code>trrs</code>: whether it uses trrs cable as a connector or not. Default is
<code>false</code></li>
<li><code>micro-usb</code>: whether it connects to the pc using micro-usb or not. Default is
<code>false</code></li>
</ul>
</li>
<li>
<code>form</code>:
<ul>
<li><code>hotswap</code>: whether it uses Dongguan Kaihua Electronics Co., Ltd (originally named
Longhua Electronics)'s hotswap socket or not. Default is <code>false</code></li>
<li><code>stagger</code>: whether it has staggered columns or not. Default is <code>true</code></li>
<li><code>stagger-index-y</code>: how much index finger's column moves in Y direction. Default is
<code>0</code></li>
<li><code>stagger-index-z</code>: how much index finger's column moves in Z direction. Default is
<code>0</code></li>
<li><code>stagger-middle-y</code>: how much middle finger's column moves in Y direction. Default is
<code>2.8</code></li>
<li><code>stagger-middle-z</code>: how much middle finger's column moves in Z direction. Default is
<code>-6.5</code></li>
<li><code>stagger-ring-y</code>: how much ring finger's column moves in Y direction. Default is
<code>0</code></li>
<li><code>stagger-ring-z</code>: how much ring finger's column moves in Z direction. Default is
<code>0</code></li>
<li><code>stagger-pinky-y</code>: how much pinky finger's column moves in Y direction. Default is
<code>-13</code></li>
<li><code>stagger-pinky-z</code>: how much pinky finger's column moves in Z direction. Default is
<code>6</code></li>
<li><code>wide-pinky</code>: whether it uses wide key (1.5u) on the outermost pinky column or not.
Default is <code>true</code></li>
<li><code>height-offset</code>: the height of the body from the floor. Default is <code>4</code>.
</li>
<li><code>wire-post</code>: whether it uses wire posts or not. Default is <code>false</code></li>
<li><code>screw-inserts</code>: whether it uses screw inserts or not. Default is <code>false</code>
</li>
</ul>
</li>
<li>
<code>misc</code>:
<ul>
<li><code>keycaps</code>: whether it shows the keycaps on the model not. Default is
<code>false</code></li>
<li><code>right-side</code>: whether it is the right side or not. Default is <code>true</code></li>
<li><code>case</code>: whether it is a case or just the plate. Default is <code>true</code></li>
</ul>
</li>
</ul>
</div>
</div>
{% endblock %}