-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
560 lines (490 loc) · 14 KB
/
index.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
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
<!DOCTYPE html>
<html>
<head>
<title>index.md</title>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<style>
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
body {
font-family: "Segoe WPC", "Segoe UI", "SFUIText-Light", "HelveticaNeue-Light", sans-serif, "Droid Sans Fallback";
font-size: 14px;
padding: 0 12px;
line-height: 22px;
word-wrap: break-word;
}
#code-csp-warning {
position: fixed;
top: 0;
right: 0;
color: white;
margin: 16px;
text-align: center;
font-size: 12px;
font-family: sans-serif;
background-color:#444444;
cursor: pointer;
padding: 6px;
box-shadow: 1px 1px 1px rgba(0,0,0,.25);
}
#code-csp-warning:hover {
text-decoration: none;
background-color:#007acc;
box-shadow: 2px 2px 2px rgba(0,0,0,.25);
}
body.scrollBeyondLastLine {
margin-bottom: calc(100vh - 22px);
}
body.showEditorSelection .code-line {
position: relative;
}
body.showEditorSelection .code-active-line:before,
body.showEditorSelection .code-line:hover:before {
content: "";
display: block;
position: absolute;
top: 0;
left: -12px;
height: 100%;
}
body.showEditorSelection li.code-active-line:before,
body.showEditorSelection li.code-line:hover:before {
left: -30px;
}
.vscode-light.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(0, 0, 0, 0.15);
}
.vscode-light.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(0, 0, 0, 0.40);
}
.vscode-dark.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(255, 255, 255, 0.4);
}
.vscode-dark.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(255, 255, 255, 0.60);
}
.vscode-high-contrast.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(255, 160, 0, 0.7);
}
.vscode-high-contrast.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(255, 160, 0, 1);
}
img {
max-width: 100%;
max-height: 100%;
}
a {
color: #4080D0;
text-decoration: none;
}
a:focus,
input:focus,
select:focus,
textarea:focus {
outline: 1px solid -webkit-focus-ring-color;
outline-offset: -1px;
}
hr {
border: 0;
height: 2px;
border-bottom: 2px solid;
}
h1 {
padding-bottom: 0.3em;
line-height: 1.2;
border-bottom-width: 1px;
border-bottom-style: solid;
}
h1, h2, h3 {
font-weight: normal;
}
h1 code,
h2 code,
h3 code,
h4 code,
h5 code,
h6 code {
font-size: inherit;
line-height: auto;
}
a:hover {
color: #4080D0;
text-decoration: underline;
}
table {
border-collapse: collapse;
}
table > thead > tr > th {
text-align: left;
border-bottom: 1px solid;
}
table > thead > tr > th,
table > thead > tr > td,
table > tbody > tr > th,
table > tbody > tr > td {
padding: 5px 10px;
}
table > tbody > tr + tr > td {
border-top: 1px solid;
}
blockquote {
margin: 0 7px 0 5px;
padding: 0 16px 0 10px;
border-left: 5px solid;
}
code {
font-family: Menlo, Monaco, Consolas, "Droid Sans Mono", "Courier New", monospace, "Droid Sans Fallback";
font-size: 14px;
line-height: 19px;
}
body.wordWrap pre {
white-space: pre-wrap;
}
.mac code {
font-size: 12px;
line-height: 18px;
}
pre:not(.hljs),
pre.hljs code > div {
padding: 16px;
border-radius: 3px;
overflow: auto;
}
/** Theming */
.vscode-light,
.vscode-light pre code {
color: rgb(30, 30, 30);
}
.vscode-dark,
.vscode-dark pre code {
color: #DDD;
}
.vscode-high-contrast,
.vscode-high-contrast pre code {
color: white;
}
.vscode-light code {
color: #A31515;
}
.vscode-dark code {
color: #D7BA7D;
}
.vscode-light pre:not(.hljs),
.vscode-light code > div {
background-color: rgba(220, 220, 220, 0.4);
}
.vscode-dark pre:not(.hljs),
.vscode-dark code > div {
background-color: rgba(10, 10, 10, 0.4);
}
.vscode-high-contrast pre:not(.hljs),
.vscode-high-contrast code > div {
background-color: rgb(0, 0, 0);
}
.vscode-high-contrast h1 {
border-color: rgb(0, 0, 0);
}
.vscode-light table > thead > tr > th {
border-color: rgba(0, 0, 0, 0.69);
}
.vscode-dark table > thead > tr > th {
border-color: rgba(255, 255, 255, 0.69);
}
.vscode-light h1,
.vscode-light hr,
.vscode-light table > tbody > tr + tr > td {
border-color: rgba(0, 0, 0, 0.18);
}
.vscode-dark h1,
.vscode-dark hr,
.vscode-dark table > tbody > tr + tr > td {
border-color: rgba(255, 255, 255, 0.18);
}
.vscode-light blockquote,
.vscode-dark blockquote {
background: rgba(127, 127, 127, 0.1);
border-color: rgba(0, 122, 204, 0.5);
}
.vscode-high-contrast blockquote {
background: transparent;
border-color: #fff;
}
</style>
<style>
/* Tomorrow Theme */
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
/* Tomorrow Comment */
.hljs-comment,
.hljs-quote {
color: #8e908c;
}
/* Tomorrow Red */
.hljs-variable,
.hljs-template-variable,
.hljs-tag,
.hljs-name,
.hljs-selector-id,
.hljs-selector-class,
.hljs-regexp,
.hljs-deletion {
color: #c82829;
}
/* Tomorrow Orange */
.hljs-number,
.hljs-built_in,
.hljs-builtin-name,
.hljs-literal,
.hljs-type,
.hljs-params,
.hljs-meta,
.hljs-link {
color: #f5871f;
}
/* Tomorrow Yellow */
.hljs-attribute {
color: #eab700;
}
/* Tomorrow Green */
.hljs-string,
.hljs-symbol,
.hljs-bullet,
.hljs-addition {
color: #718c00;
}
/* Tomorrow Blue */
.hljs-title,
.hljs-section {
color: #4271ae;
}
/* Tomorrow Purple */
.hljs-keyword,
.hljs-selector-tag {
color: #8959a8;
}
.hljs {
display: block;
overflow-x: auto;
color: #4d4d4c;
padding: 0.5em;
}
.hljs-emphasis {
font-style: italic;
}
.hljs-strong {
font-weight: bold;
}
</style>
<style>
/*
* Markdown PDF CSS
*/
body {
font-family: "Meiryo", "Segoe WPC", "Segoe UI", "SFUIText-Light", "HelveticaNeue-Light", sans-serif, "Droid Sans Fallback";
}
pre {
background-color: #f8f8f8;
border: 1px solid #cccccc;
border-radius: 3px;
overflow-x: auto;
white-space: pre-wrap;
overflow-wrap: break-word;
}
pre:not(.hljs) {
padding: 23px;
line-height: 19px;
}
blockquote {
background: rgba(127, 127, 127, 0.1);
border-color: rgba(0, 122, 204, 0.5);
}
.emoji {
height: 1.4em;
}
/* for inline code */
:not(pre):not(.hljs) > code {
color: #C9AE75; /* Change the old color so it seems less like an error */
font-size: inherit;
}
/* Page Break : use <div class="page"/> to insert page break
-------------------------------------------------------- */
.page {
page-break-after: always;
}
</style>
</head>
<body>
<h2 id="minir-api">MinIR API</h2>
<p>MinIRで利用できるWebAPIの説明です。</p>
<h2 id="%E4%BA%8B%E5%89%8D%E6%BA%96%E5%82%99">事前準備</h2>
<p>MinIRへのデータ書き込みにはPublicKeyが必要です。
以下の手順で取得できます。</p>
<ol>
<li>MinIRにログインします。</li>
<li><code>GENERATE API KEY</code> ボタンを押してKeyを作成します。<br>
<img src="./images/generate.PNG" alt=""""></li>
</ol>
<p>※注意</p>
<ul>
<li><code>GENERATE API KEY</code>を押すたびにキーが再作成されます。表示されているキーのみ有効です。</li>
</ul>
<hr>
<h2 id="get-songscores">GET SongScores</h2>
<p>曲のスコアリストを取得します。</p>
<h3 id="url">URL</h3>
<p><code>https://minir.azurewebsites.net/api/getSongScores</code></p>
<h3 id="http-%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89">HTTP メソッド</h3>
<p>GET</p>
<h3 id="%E3%82%AF%E3%82%A8%E3%83%AA%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF">クエリパラメータ</h3>
<p>なし</p>
<h3 id="%E3%83%98%E3%83%83%E3%83%80%E3%83%BC">ヘッダー</h3>
<ul>
<li>songhash (必須)： 譜面のsha256</li>
<li>lnmode （オプション）：lnmode(0 or Nothing:LN, 1:CN, 2:HCN)</li>
</ul>
<p>※<code>LNMODE</code>拡張定義があるBMSはlnmode=0でしか取得できません。</p>
<h3 id="body">BODY</h3>
<p>なし</p>
<h3 id="%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B">レスポンス例</h3>
<pre class="hljs"><code><div>[
{
"lpg": 917,
"combo": 884,
"datetime": "2018-05-31T10:57:04.734Z",
"lgr": 442,
"songhash": "57a52cb3fbeac72b876d80524f38f50850006c5878a628f0147a5c4c0ede6d11.0",
"clear": 6,
"userid": "0c0f76af-e47d-43aa-90cd-d4a3ac5932f3",
"notes": 2115,
"score": 3575,
"epg": 583,
"username": "いづな",
"egr": 133
},
{
"lpg": 588,
"combo": 796,
"datetime": "2018-05-26T06:30:17.834Z",
"lgr": 317,
"songhash": "57a52cb3fbeac72b876d80524f38f50850006c5878a628f0147a5c4c0ede6d11.0",
"clear": 7,
"userid": "00997ef2-4173-4da5-8e7d-28798398e52f",
"notes": 2115,
"score": 3365,
"epg": 744,
"username": "Otaku",
"egr": 384
},
{
"lpg": 276,
"combo": 265,
"datetime": "2018-06-28T06:22:52.171Z",
"lgr": 285,
"songhash": "57a52cb3fbeac72b876d80524f38f50850006c5878a628f0147a5c4c0ede6d11.0",
"clear": 1,
"userid": "fcf03d99-63c8-42a2-bacd-e71ce6445b1b",
"notes": 2115,
"score": 2267,
"epg": 446,
"username": "E-patternβ",
"egr": 538
}
]
</div></code></pre>
<hr>
<h2 id="put-songscore">PUT SongScore</h2>
<p>曲のスコアをMnIRに登録します。</p>
<h3 id="url">URL</h3>
<p><code>https://minir.azurewebsites.net/api/putSongScore</code></p>
<h3 id="http-%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89">HTTP メソッド</h3>
<p>PUT</p>
<h3 id="%E3%82%AF%E3%82%A8%E3%83%AA%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF">クエリパラメータ</h3>
<p>なし</p>
<h3 id="%E3%83%98%E3%83%83%E3%83%80%E3%83%BC">ヘッダー</h3>
<ul>
<li>publickey (必須)： <code>GENERATE API KEY</code>で取得したKey</li>
<li>dryrun （オプション）：<code>true</code>の場合、MinIRに書き込みを行わず、書き込み結果がどのようになるかがレスポンスとして返却されます。</li>
</ul>
<p>※<code>LNMODE</code>拡張定義があるBMSはlnmode=0でしか取得できません。</p>
<h3 id="body">BODY</h3>
<p>曲スコアデータJSON。各項目は必須です。</p>
<pre class="hljs"><code><div>{
"songhash": "SONGHASH",
"lnmode": 0,
"score": 1234,
"epg": 600,
"lpg": 0,
"egr": 33,
"lgr": 1,
"combo": 550,
"clear": 3,
"notes": 1555
}
</div></code></pre>
<ul>
<li>songhash : 譜面のsha256</li>
<li>lnmode: LNプレイモード。(0:LN, 1:CN, 2:HCN)
<code>LNMODE</code>拡張定義があるBMSはlnmode=0を指定してください。</li>
<li>score:EX SCORE</li>
<li>epg: early perfect great</li>
<li>lpg: late perfect great</li>
<li>egr: early great</li>
<li>lgr: late great</li>
<li>combo:max combo</li>
<li>clear
<ul>
<li>0 : NoPlay</li>
<li>1 : Failed</li>
<li>2 : AssistEasy</li>
<li>3 : LightAssistEasy</li>
<li>4 : Easy</li>
<li>5 : Normal</li>
<li>6 : Hard</li>
<li>7 : ExHard</li>
<li>8 : FullCombo</li>
<li>9 : Perfect</li>
<li>10 : Max</li>
</ul>
</li>
<li>notes : 譜面ノート数（※RANDOM譜面の場合、ノート数が変動する）</li>
</ul>
<h3 id="%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B">レスポンス例</h3>
<h4 id="dryrun-false-or-nothing">dryrun == false or nothing</h4>
<p>"Put Song score successed."</p>
<h4 id="dryrun-true">dryrun = true</h4>
<pre class="hljs"><code><div>{
"songhash": "TEST.0",
"score": 1234,
"epg": 600,
"lpg": 0,
"egr": 33,
"lgr": 1,
"combo": 550,
"clear": 3,
"notes": 1555,
"userid": "a30f300b-1984-4797-80d3-66a06af7fcc8",
"username": "海岸砂丘"
}
</div></code></pre>
<hr>
<h2 id="qa">Q&A</h2>
<h3 id="%E3%82%B9%E3%82%B3%E3%82%A2%E3%81%8C%E5%8F%96%E5%BE%97%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%84%E3%83%BB%E9%80%81%E4%BF%A1%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%84%E3%82%93%E3%81%A0%E3%81%91%E3%81%A9%EF%BC%9F">スコアが取得できない・送信できないんだけど？</h3>
<ul>
<li>クエリが間違っている</li>
<li>高頻度でのリクエスト要求をしている</li>
</ul>
<p>どちらかとは思いますが、単純にバグの可能性もあります。<br>
どうしても解決しない場合はお問い合わせください。</p>
<p><strong>高頻度でのリクエストは財布が死ぬからカンベンな！</strong></p>
<p><br><br></p>
<h3 id="%E3%81%A9%E3%81%86%E8%80%83%E3%81%88%E3%81%A6%E3%82%82%E4%B8%8D%E6%AD%A3%E3%82%B9%E3%82%B3%E3%82%A2%E3%81%8C%E9%80%81%E4%BF%A1%E3%81%95%E3%82%8C%E3%82%8B%E4%BD%9C%E3%82%8A%E3%81%A0%E3%82%88%E3%81%AD%EF%BC%9F">どう考えても不正スコアが送信される作りだよね？</h3>
<p>はい、スコア送信に関しては特にチェックを行っていません。<br>
ただし、このAPIを利用して送信されたスコアは<strong>No Validation</strong> スコアとして登録されます。<br>
IRページでも<code>No Validation</code>スコアは表示上区別されます。</p>
<p><img src="./images/novalidate.PNG" alt=""""></p>
<p>レコメンドの算出等、他者比較が必要の場合は<code>No Validation</code>スコアを集計対象から外すことが必要になってきます。</p>
<p>また、スコアの消去は実装してないので、変なスコア送ったとしても、<code>No Validation</code>スコアがずっと残るだけです…（恥ずかしい…恥ずかしくない？）</p>
</body>
</html>