File size: 51,073 Bytes
cc6b6d8 7391956 cc6b6d8 757768f cc6b6d8 08a393b cc6b6d8 757768f cc6b6d8 757768f cc6b6d8 757768f cc6b6d8 757768f cc6b6d8 757768f cc6b6d8 e31bb23 757768f e31bb23 757768f e31bb23 757768f e31bb23 cc6b6d8 757768f cc6b6d8 757768f cc6b6d8 | 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 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 | {
"name": "Unroll",
"app": {
"version": "1.7.0",
"date": "2026-10-24",
"sha": "e5067cd"
},
"apiVersion": "1.0.0",
"docs": {
"llms": "/llms.txt",
"agents": "/AGENTS.md",
"addingAScroll": "/docs/ADDING_A_SCROLL.md",
"changelog": "/CHANGELOG.md",
"embed": "/docs/EMBED.md",
"oembed": "/oembed.json"
},
"global": "window.unroll",
"conventions": [
"Every method returns a Promise of { ok: true, ... } or { ok: false, error, code }. Nothing throws.",
"Error codes: invalid (bad arguments), not_found, unavailable (feature missing in this build or scroll), timeout, conflict, failed, load_failed.",
"Screen coordinates are CSS pixels of the viewport; scene coordinates are millimeters.",
"Add-ons register more groups with unroll.register(group, methods, specs), for example unroll.bench. They appear in unroll.schema() with extension: true.",
"Every interactive element has data-testid and data-api naming its API equivalent."
],
"embed": {
"url": "https://sharpmeow-unroll.static.hf.space/index.html?embed=1",
"params": {
"embed": "1: compact layout, click to interact",
"autoplay": "1: play on load",
"controls": "0: hide the controls"
},
"iframeAllow": "fullscreen; clipboard-write"
},
"postMessage": {
"description": "Host pages drive an embedded viewer with postMessage. Every method above is callable by name; on, off and register are replaced by subscribe and unsubscribe.",
"toViewer": {
"call": {
"unroll": 1,
"id": "number|string",
"method": "string (an API method name)",
"args": "array"
},
"subscribe": {
"unroll": 1,
"id": "number|string",
"method": "subscribe",
"args": [
"eventName"
]
},
"unsubscribe": {
"unroll": 1,
"id": "number|string",
"method": "unsubscribe",
"args": [
"eventName"
]
}
},
"fromViewer": {
"ready": {
"unroll": 1,
"type": "ready",
"version": "{ version, date, sha, api }",
"methods": "array of method names"
},
"result": {
"unroll": 1,
"type": "result",
"id": "the id you sent",
"result": "{ ok: true, ... } | { ok: false, error, code }"
},
"event": {
"unroll": 1,
"type": "event",
"event": "string",
"payload": "object"
}
},
"forbidden": [
"open.listLocal",
"open.removeLocal"
]
},
"methods": {
"version": {
"group": "meta",
"summary": "The app version from version.json: { version (semver), date, sha, api }. Also in api.json and Bench export bundles.",
"call": "window.unroll.version()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"help": {
"group": "meta",
"summary": "A short guide: how calls work, a quick start and the methods by group. help(\"destroy\") narrows to a group, help(\"setLayer\") to one method.",
"call": "window.unroll.help(topic?)",
"params": [
{
"name": "topic",
"type": [
"string"
],
"required": false,
"description": "A method or group name"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"schema": {
"group": "meta",
"summary": "This API: version, every method with its parameters, events, URL parameters and keyboard actions.",
"call": "window.unroll.schema()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"getState": {
"group": "meta",
"summary": "The whole page state as JSON: scroll, unroll position, layer, winding, close-up, panels, Destroy mode, camera, readout and a text description of the view.",
"call": "window.unroll.getState()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"describe": {
"group": "meta",
"summary": "A plain-text description of what is on screen now (the same text screen readers get).",
"call": "window.unroll.describe()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"links": {
"group": "meta",
"summary": "Every link on the page (credits, licenses, docs) with its text and URL.",
"call": "window.unroll.links()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"deepLink": {
"group": "meta",
"summary": "A URL that restores the current state (scroll, t, layer, focus, compare, panel, Destroy mode; camera too if asked).",
"call": "window.unroll.deepLink(camera?)",
"params": [
{
"name": "camera",
"type": [
"boolean"
],
"required": false,
"description": "Include the camera position (cam=...)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"on": {
"group": "meta",
"summary": "Subscribe to an event; the callback gets a JSON payload. Returns { ok, id } for off().",
"call": "window.unroll.on(event, callback)",
"params": [
{
"name": "event",
"type": [
"string"
],
"required": true,
"description": "Event name",
"enum": [
"change",
"unroll",
"layer",
"focus",
"panel",
"destroy",
"camera",
"settled",
"scroll",
"extension",
"error"
]
},
{
"name": "callback",
"type": [
"function"
],
"required": true,
"description": "Called with (payload)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"off": {
"group": "meta",
"summary": "Remove a subscription made with on().",
"call": "window.unroll.off(id)",
"params": [
{
"name": "id",
"type": [
"number"
],
"required": true,
"description": "The id on() returned"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"run": {
"group": "meta",
"summary": "Run a batch of calls in order. Each step is [\"method\", ...args] or { \"method\", \"args\" }; dotted names reach groups (e.g. \"camera.orbit\"). Stops at the first failure unless options.continueOnError.",
"call": "window.unroll.run(steps, options?)",
"params": [
{
"name": "steps",
"type": [
"array"
],
"required": true,
"description": "The calls"
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ continueOnError: boolean }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"waitFor": {
"group": "meta",
"summary": "Wait until the state matches. condition is \"ready\", \"settled\" (unroll and camera at rest), \"overlayLoaded\", or an object of dotted state paths to values or to { eq, ne, gte, lte, gt, lt, in }.",
"call": "window.unroll.waitFor(condition, options?)",
"params": [
{
"name": "condition",
"type": [
"string",
"object"
],
"required": true,
"description": "What to wait for"
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ timeout: ms (default 10000) }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"reload": {
"group": "meta",
"summary": "Reload the page (keeps the URL state).",
"call": "window.unroll.reload()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"listScrolls": {
"group": "scrolls",
"summary": "Scrolls in the registry and scrolls opened in this browser (local).",
"call": "window.unroll.listScrolls()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"openScroll": {
"group": "scrolls",
"summary": "Open a scroll by registry id or local key. The page reloads; call waitFor(\"ready\") after the new page loads.",
"call": "window.unroll.openScroll(id)",
"params": [
{
"name": "id",
"type": [
"string"
],
"required": true,
"description": "Registry id or local key (local-...)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"setUnroll": {
"group": "view",
"summary": "Set the unroll position, 0 rolled to 1 fully unrolled. Animates unless instant.",
"call": "window.unroll.setUnroll(t, options?)",
"params": [
{
"name": "t",
"type": [
"number"
],
"required": true,
"description": "Position",
"minimum": 0,
"maximum": 1
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ instant: boolean }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"play": {
"group": "view",
"summary": "Start or stop the automatic unroll (toggles if omitted).",
"call": "window.unroll.play(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "Play or pause"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"setLayer": {
"group": "view",
"summary": "Show a layer: \"xray\", \"ink\" or \"overlay\" (aliases \"ct\", \"gpu\", or the manifest layer id).",
"call": "window.unroll.setLayer(id)",
"params": [
{
"name": "id",
"type": [
"string"
],
"required": true,
"description": "Layer"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"focus": {
"group": "view",
"summary": "Open the close-up of a winding (current winding if omitted), or close it with null. options.view picks the tab: \"main\", \"overlay\" or \"compare\".",
"call": "window.unroll.focus(winding?, options?)",
"params": [
{
"name": "winding",
"type": [
"string",
"number",
"null"
],
"required": false,
"description": "Winding id such as \"w059\" (or its number, 59), null to close"
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ view: \"main\" | \"overlay\" | \"compare\" }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"compare": {
"group": "view",
"summary": "Compare swipe in the close-up: on/off and the split position 0..1 (0 shows only the overlay, 1 only the main ink). Opens the close-up on the current winding if needed.",
"call": "window.unroll.compare(on, pos?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": true,
"description": "Show the compare view"
},
{
"name": "pos",
"type": [
"number"
],
"required": false,
"description": "Split position",
"minimum": 0,
"maximum": 1
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"closeup": {
"group": "view",
"summary": "Zoom and pan the close-up image: { scale } multiplies the zoom, { x, y } pans in CSS px, { fit: true } fits it.",
"call": "window.unroll.closeup(options)",
"params": [
{
"name": "options",
"type": [
"object"
],
"required": true,
"description": "{ scale, x, y, fit }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"panel": {
"group": "view",
"summary": "Open or close a panel: \"about\", \"help\", \"open\" (Open your own), \"why\" (why two ink layers), \"embed\" (the iframe snippet). Toggles if open is omitted.",
"call": "window.unroll.panel(name, open?)",
"params": [
{
"name": "name",
"type": [
"string"
],
"required": true,
"description": "Panel",
"enum": [
"about",
"help",
"open",
"why",
"embed"
]
},
{
"name": "open",
"type": [
"boolean"
],
"required": false,
"description": "Open or close"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"sound": {
"group": "view",
"summary": "Crackle sound for Destroy on or off (browsers need a user gesture first to play audio).",
"call": "window.unroll.sound(on)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": true,
"description": "Sound on"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"fullscreen": {
"group": "view",
"summary": "Enter or leave full screen (browsers may refuse without a user gesture).",
"call": "window.unroll.fullscreen(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "Full screen"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"screenshot": {
"group": "view",
"summary": "A PNG of the view as a data URL. options.clean leaves out the title overlay; options.download also saves it like the camera button.",
"call": "window.unroll.screenshot(options?)",
"params": [
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ clean: boolean, download: boolean }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"key": {
"group": "view",
"summary": "Press a keyboard shortcut, as a person would (see schema().keys).",
"call": "window.unroll.key(key, options?)",
"params": [
{
"name": "key",
"type": [
"string"
],
"required": true,
"description": "Key name, e.g. \"t\", \"ArrowRight\", \"?\""
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ shift: boolean }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"reset": {
"group": "view",
"summary": "Back to the start: close panels, leave Destroy, put every sheet back, roll up, reset the camera and layer.",
"call": "window.unroll.reset()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"camera.get": {
"group": "camera",
"summary": "Camera position, target, distance, azimuth and polar angle (degrees), field of view.",
"call": "window.unroll.camera.get()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"camera.orbit": {
"group": "camera",
"summary": "Orbit around the target by degrees.",
"call": "window.unroll.camera.orbit(dAzimuth, dPolar?)",
"params": [
{
"name": "dAzimuth",
"type": [
"number"
],
"required": true,
"description": "Degrees around the vertical axis"
},
{
"name": "dPolar",
"type": [
"number"
],
"required": false,
"description": "Degrees up or down"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"camera.zoom": {
"group": "camera",
"summary": "Zoom by a factor (2 is twice as close, 0.5 twice as far).",
"call": "window.unroll.camera.zoom(factor)",
"params": [
{
"name": "factor",
"type": [
"number"
],
"required": true,
"description": "Zoom factor",
"minimum": 0.01,
"maximum": 100
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"camera.pan": {
"group": "camera",
"summary": "Pan the view in millimeters along the screen (x right, y up).",
"call": "window.unroll.camera.pan(dx, dy?)",
"params": [
{
"name": "dx",
"type": [
"number"
],
"required": true,
"description": "mm right"
},
{
"name": "dy",
"type": [
"number"
],
"required": false,
"description": "mm up"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"camera.set": {
"group": "camera",
"summary": "Put the camera at a position looking at a target, both [x, y, z] in scene millimeters.",
"call": "window.unroll.camera.set(position, target?)",
"params": [
{
"name": "position",
"type": [
"array"
],
"required": true,
"description": "[x, y, z]"
},
{
"name": "target",
"type": [
"array"
],
"required": false,
"description": "[x, y, z]"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"camera.reset": {
"group": "camera",
"summary": "Fly back to the default view for the current position (the V key).",
"call": "window.unroll.camera.reset()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.mode": {
"group": "destroy",
"summary": "Enter or leave Destroy mode (damage the scroll as it is, rolled up or unrolled).",
"call": "window.unroll.destroy.mode(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "Destroy mode on"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.tool": {
"group": "destroy",
"summary": "Pick the Destroy tool used by clicks and drags: \"tear\", \"crush\", \"burn\" or \"water\".",
"call": "window.unroll.destroy.tool(name)",
"params": [
{
"name": "name",
"type": [
"string"
],
"required": true,
"description": "Tool",
"enum": [
"tear",
"crush",
"burn",
"water"
]
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.aim": {
"group": "destroy",
"summary": "A screen point that is on the papyrus right now, nearest the center of the view: { x, y, winding }. Use it for the tool calls.",
"call": "window.unroll.destroy.aim()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.tear": {
"group": "destroy",
"summary": "Rip the papyrus with a drag from (x, y). Enters Destroy mode and picks Tear. Returns damage stats before and after.",
"call": "window.unroll.destroy.tear(x, y, options?)",
"params": [
{
"name": "x",
"type": [
"number"
],
"required": true,
"description": "Screen x in CSS pixels from the left of the page",
"minimum": 0
},
{
"name": "y",
"type": [
"number"
],
"required": true,
"description": "Screen y in CSS pixels from the top",
"minimum": 0
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "Optional { dx, dy, steps, ms }: drag vector in CSS px (default 90, -200), number of pointer moves (default 24), time per move in ms (default 16)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.crush": {
"group": "destroy",
"summary": "Press at (x, y) to crumble the papyrus; options.hold (ms, default 700) presses harder and deeper.",
"call": "window.unroll.destroy.crush(x, y, options?)",
"params": [
{
"name": "x",
"type": [
"number"
],
"required": true,
"description": "Screen x in CSS pixels from the left of the page",
"minimum": 0
},
{
"name": "y",
"type": [
"number"
],
"required": true,
"description": "Screen y in CSS pixels from the top",
"minimum": 0
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "Optional { hold }: how long to press, in ms (0 to 5000)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.burn": {
"group": "destroy",
"summary": "Ignite the papyrus at (x, y); embers then creep along the fibers.",
"call": "window.unroll.destroy.burn(x, y, options?)",
"params": [
{
"name": "x",
"type": [
"number"
],
"required": true,
"description": "Screen x in CSS pixels from the left of the page",
"minimum": 0
},
{
"name": "y",
"type": [
"number"
],
"required": true,
"description": "Screen y in CSS pixels from the top",
"minimum": 0
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "Optional { hold }: how long to press, in ms (0 to 5000)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.water": {
"group": "destroy",
"summary": "Pour water at (x, y); options.hold (ms, default 900) widens the wet patch.",
"call": "window.unroll.destroy.water(x, y, options?)",
"params": [
{
"name": "x",
"type": [
"number"
],
"required": true,
"description": "Screen x in CSS pixels from the left of the page",
"minimum": 0
},
{
"name": "y",
"type": [
"number"
],
"required": true,
"description": "Screen y in CSS pixels from the top",
"minimum": 0
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "Optional { hold }: how long to press, in ms (0 to 5000)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.reset": {
"group": "destroy",
"summary": "Undo all damage, clear the debris and put the Sandbox sheets back.",
"call": "window.unroll.destroy.reset()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.sandbox": {
"group": "destroy",
"summary": "Sandbox on or off: the strip laid flat with full fracture physics (Destroy mode only).",
"call": "window.unroll.destroy.sandbox(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "Sandbox on"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.grab": {
"group": "destroy",
"summary": "In the Sandbox, grab the papyrus at (x, y) and pull (crushes instead while the Crush tool is picked). Returns breaks before and after.",
"call": "window.unroll.destroy.grab(x, y, options?)",
"params": [
{
"name": "x",
"type": [
"number"
],
"required": true,
"description": "Screen x in CSS pixels from the left of the page",
"minimum": 0
},
{
"name": "y",
"type": [
"number"
],
"required": true,
"description": "Screen y in CSS pixels from the top",
"minimum": 0
},
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "Optional { dx, dy, steps, ms }: drag vector in CSS px (default 90, -200), number of pointer moves (default 24), time per move in ms (default 16)"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.crumble": {
"group": "destroy",
"summary": "Crumble the whole scroll: it breaks up from the edges into a heap of dust. destroy.reset() restores it.",
"call": "window.unroll.destroy.crumble()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"prizeOnly": {
"group": "scrolls",
"summary": "Show only prize eligible scrolls in the scroll picker, on or off (toggles when omitted). Returns { prizeOnly, visible }.",
"call": "window.unroll.prizeOnly(on)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": true,
"description": "Only prize eligible scrolls"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.shake": {
"group": "destroy",
"summary": "Sandbox only: knock the table, loosening random bits.",
"call": "window.unroll.destroy.shake()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.stats": {
"group": "destroy",
"summary": "Damage numbers (masks, embers, particles, shards, puddles) and Sandbox numbers (nodes, links, breaks, debris).",
"call": "window.unroll.destroy.stats()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"destroy.tools": {
"group": "destroy",
"summary": "The Destroy tools in this build.",
"call": "window.unroll.destroy.tools()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"rollUp": {
"group": "view",
"summary": "Roll the scroll back up with a steady rewind (the Roll up button); false stops it. Toggles if omitted.",
"call": "window.unroll.rollUp(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "Rolling"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"embed.snippet": {
"group": "embed",
"summary": "The iframe snippet for this viewer: { url, html }. options: { state (start at the current view, default true), autoplay, controls (default true), width, height }.",
"call": "window.unroll.embed.snippet(options?)",
"params": [
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ state, autoplay, controls, width, height }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"embed.info": {
"group": "embed",
"summary": "Embed mode: { embedded (?embed=1), framed (inside an iframe), active (the scene has the pointer and wheel), controls, autoplay }.",
"call": "window.unroll.embed.info()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"embed.activate": {
"group": "embed",
"summary": "In embed mode, hand the pointer, touch and wheel to the scene (like clicking the \"Click to interact\" layer), or give them back with false.",
"call": "window.unroll.embed.activate(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "Activate"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"open.fromURL": {
"group": "open",
"summary": "Open your own: fetch a manifest.json or zip from a URL (the server must allow CORS). Nothing is uploaded. On success the page reloads into the new scroll.",
"call": "window.unroll.open.fromURL(url)",
"params": [
{
"name": "url",
"type": [
"string"
],
"required": true,
"description": "http(s) URL"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"open.fromFiles": {
"group": "open",
"summary": "Open your own from file contents: [{ name, data }] where data is an ArrayBuffer, a Uint8Array, a Blob or a base64 string. A zip, or a manifest.json plus its files. On success the page reloads.",
"call": "window.unroll.open.fromFiles(files)",
"params": [
{
"name": "files",
"type": [
"array"
],
"required": true,
"description": "Files"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"open.example": {
"group": "open",
"summary": "Build the synthetic example package. Returns it as base64 (options.download also saves the zip).",
"call": "window.unroll.open.example(options?)",
"params": [
{
"name": "options",
"type": [
"object"
],
"required": false,
"description": "{ download: boolean }"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"open.listLocal": {
"group": "open",
"summary": "Scrolls kept in this browser.",
"call": "window.unroll.open.listLocal()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"open.removeLocal": {
"group": "open",
"summary": "Remove a scroll kept in this browser.",
"call": "window.unroll.open.removeLocal(key)",
"params": [
{
"name": "key",
"type": [
"string"
],
"required": true,
"description": "Local key"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"open.validate": {
"group": "open",
"summary": "Check a manifest object with the page validator, without opening anything.",
"call": "window.unroll.open.validate(manifest)",
"params": [
{
"name": "manifest",
"type": [
"object"
],
"required": true,
"description": "The manifest"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.dragRes": {
"group": "ct",
"summary": "Lower render resolution while the camera moves: \"off\", \"light\" (0.75x) or \"strong\" (0.5x). Without an argument, returns the state.",
"call": "window.unroll.ct.dragRes(mode?)",
"params": [
{
"name": "mode",
"type": [
"string"
],
"required": false,
"description": "off, light or strong",
"enum": [
"off",
"light",
"strong"
]
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.setWindow": {
"group": "ct",
"summary": "X-ray window and level on the 3D scroll, both 0..1 (low = level - window / 2).",
"call": "window.unroll.ct.setWindow(window, level)",
"params": [
{
"name": "window",
"type": [
"number"
],
"required": true,
"description": "Width, 0.005..1"
},
{
"name": "level",
"type": [
"number"
],
"required": true,
"description": "Center, 0..1"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.autoContrast": {
"group": "ct",
"summary": "X-ray auto contrast from the CT atlas percentiles (default from Settings, 1 and 99).",
"call": "window.unroll.ct.autoContrast(pLow?, pHigh?)",
"params": [
{
"name": "pLow",
"type": [
"number"
],
"required": false,
"description": "Low percentile"
},
{
"name": "pHigh",
"type": [
"number"
],
"required": false,
"description": "High percentile"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.fullRange": {
"group": "ct",
"summary": "Show the full X-ray brightness range.",
"call": "window.unroll.ct.fullRange()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.contrast": {
"group": "ct",
"summary": "X-ray window/level state.",
"call": "window.unroll.ct.contrast()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.open": {
"group": "ct",
"summary": "Open the CT volume (MIP in a slab) around a papyrus point: { winding, u, v } or { voxel: [x, y, z] } or { x, y } screen point, with level? (0..5) and size? (64, 128, 192, 256). Streams OME-Zarr chunks from the public S3 bucket.",
"call": "window.unroll.ct.open(where)",
"params": [
{
"name": "where",
"type": [
"object"
],
"required": true,
"description": "Point"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.close": {
"group": "ct",
"summary": "Close the CT volume panel.",
"call": "window.unroll.ct.close()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.state": {
"group": "ct",
"summary": "CT volume state: point, level, size, voxel size, source URL, slab, window, load stats, labels.",
"call": "window.unroll.ct.state()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.setSlab": {
"group": "ct",
"summary": "Slab clip of the CT volume: { on, thickness (voxels), offset (voxels), tiltX, tiltY (degrees), face (point the camera down the normal) }.",
"call": "window.unroll.ct.setSlab(slab)",
"params": [
{
"name": "slab",
"type": [
"object"
],
"required": true,
"description": "Slab fields to change"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.volumeWindow": {
"group": "ct",
"summary": "Window and level of the CT volume MIP, both 0..1.",
"call": "window.unroll.ct.volumeWindow(window, level)",
"params": [
{
"name": "window",
"type": [
"number"
],
"required": true,
"description": "Width"
},
{
"name": "level",
"type": [
"number"
],
"required": true,
"description": "Center"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.volumeAuto": {
"group": "ct",
"summary": "Auto contrast of the CT volume from its own histogram.",
"call": "window.unroll.ct.volumeAuto()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.setDetail": {
"group": "ct",
"summary": "Detail level of the CT volume: 0 is the full 9.4 µm scan, each step halves the resolution. Reloads.",
"call": "window.unroll.ct.setDetail(level)",
"params": [
{
"name": "level",
"type": [
"number"
],
"required": true,
"description": "0..5"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.setSize": {
"group": "ct",
"summary": "Cube size of the CT volume in voxels. Reloads.",
"call": "window.unroll.ct.setSize(size)",
"params": [
{
"name": "size",
"type": [
"number"
],
"required": true,
"description": "64, 128, 192 or 256"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.pick": {
"group": "ct",
"summary": "Turn pick mode on or off: the next click on the papyrus opens the CT volume there.",
"call": "window.unroll.ct.pick(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "On"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.image": {
"group": "ct",
"summary": "The CT volume view as a PNG data URL.",
"call": "window.unroll.ct.image()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.labels": {
"group": "ct",
"summary": "Labeled segments: color every traced segment inside the CT volume cube. Returns the segments found with their colors and voxel counts.",
"call": "window.unroll.ct.labels(on?)",
"params": [
{
"name": "on",
"type": [
"boolean"
],
"required": false,
"description": "On"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.highlight": {
"group": "ct",
"summary": "Highlight one labeled segment by winding id (null clears).",
"call": "window.unroll.ct.highlight(id)",
"params": [
{
"name": "id",
"type": [
"string",
"null"
],
"required": true,
"description": "Winding id, for example w035"
}
],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
},
"ct.source": {
"group": "ct",
"summary": "Where the CT volume of the current scroll streams from (OME-Zarr on s3://vesuvius-challenge-open-data) and the levels it has.",
"call": "window.unroll.ct.source()",
"params": [],
"returns": "Promise<{ ok: true, ... } | { ok: false, error: string, code: string }>"
}
},
"events": {
"change": "Any state change: { changed: [paths], state }",
"unroll": "The unroll position settled: { t }",
"layer": "The layer changed: { layer }",
"focus": "The close-up opened, closed or changed tab: { focus }",
"panel": "A panel opened or closed: { panels }",
"destroy": "Destroy mode, crush or a tool was used: { destroy }",
"camera": "The camera came to rest somewhere new: { camera }",
"settled": "Unroll and camera at rest: { state }",
"scroll": "A scroll is about to open (the page reloads): { id }",
"extension": "An add-on registered a method group, for example bench: { group, methods }",
"error": "A call failed: { method, error }"
},
"urlParams": {
"scroll": "Registry id or local key (alias s)",
"t": "Unroll position 0..1",
"layer": "xray, ink or overlay (alias l; gpu and ct also work)",
"focus": "Winding id: open its close-up",
"view": "Close-up tab: main, overlay or compare",
"compare": "Open the compare swipe at this split position 0..1 (on the focus winding, or the current one)",
"panel": "about, help, open, why or embed",
"embed": "1 for the compact embed layout with click to interact (query string only)",
"autoplay": "1 to play the unroll on load (embed mode)",
"controls": "0 to hide the controls (embed mode)",
"destroy": "1 to start in Destroy mode",
"tool": "Destroy tool: tear, crush, burn or water (implies destroy=1)",
"crush": "1: the same as tool=crush",
"sandbox": "1 to start in the Destroy Sandbox",
"cam": "Camera px,py,pz,tx,ty,tz in scene millimeters",
"shot": "In the query string: a clean frame for share images"
},
"keys": {
"1": "setLayer(\"xray\")",
"2": "setLayer(\"ink\")",
"3": "setLayer(\"overlay\")",
"Space": "play",
"ArrowRight": "setUnroll(t + 0.01)",
"ArrowLeft": "setUnroll(t - 0.01)",
"Shift+Arrow": "setUnroll(t +/- 0.05)",
"Home": "setUnroll(0)",
"End": "setUnroll(1)",
"r": "focus()",
"v": "camera.reset()",
"t": "destroy.mode()",
"x": "destroy.tool(\"tear\")",
"c": "destroy.tool(\"crush\")",
"b": "destroy.tool(\"burn\")",
"w": "destroy.tool(\"water\")",
"u": "rollUp()",
"f": "fullscreen()",
"i": "panel(\"about\")",
"?": "panel(\"help\")",
"Escape": "close panels",
"canvas focused: arrows": "camera.orbit",
"canvas focused: + and -": "camera.zoom",
"canvas focused: Shift+arrows": "camera.pan",
"canvas focused: Enter": "focus()",
"close-up focused: + - arrows 0": "closeup()"
},
"manifestSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Unroll scroll manifest",
"type": "object",
"required": [
"schema",
"id",
"name",
"voxelMM",
"geometry",
"windings",
"layers"
],
"properties": {
"schema": {
"const": "unroll-scroll/1"
},
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"
},
"name": {
"type": "string",
"maxLength": 120
},
"voxelMM": {
"type": "number",
"exclusiveMinimum": 0,
"exclusiveMaximum": 10
},
"base": {
"type": "string",
"description": "Relative folder that paths start from"
},
"geometry": {
"type": "object",
"required": [
"format"
],
"properties": {
"format": {
"enum": [
"grid-int16",
"mesh"
],
"description": "grid-int16 is for registry scrolls only"
},
"units": {
"enum": [
"voxels",
"mm"
]
},
"axis": {
"enum": [
"z",
"y"
]
},
"index": {
"type": "string",
"description": "Relative path inside the package: no URL, no leading slash, no \"..\""
},
"bin": {
"type": "string",
"description": "Relative path inside the package: no URL, no leading slash, no \"..\""
}
}
},
"windings": {
"description": "A list of { id, mesh } or { range: [first, last], mesh: pattern with {id}, outermost }",
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"mesh": {
"type": "string",
"description": ".obj, .ply"
}
}
}
},
{
"type": "object",
"required": [
"range"
]
}
]
},
"outermost": {
"enum": [
"first",
"last"
]
},
"layers": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"id",
"role",
"label"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"ct",
"ink",
"overlay"
]
},
"label": {
"type": "string"
},
"shortLabel": {
"type": "string",
"description": "Label where space is tight (layer chip, compare swipe)"
},
"resolutionUM": {
"type": "number",
"exclusiveMinimum": 0,
"description": "Resolution in micrometers"
},
"windings": {
"description": "\"all\", a list of ids, or { range: [first, last] }"
},
"texture": {
"type": "string",
"description": "Per-winding image path pattern containing {id}"
},
"files": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "Relative path inside the package: no URL, no leading slash, no \"..\""
},
"description": "Winding id to image path, overriding texture"
},
"atlas": {
"type": "string",
"description": "Relative path inside the package: no URL, no leading slash, no \"..\""
},
"atlasFallback": {
"type": "string",
"description": "Relative path inside the package: no URL, no leading slash, no \"..\""
},
"hi": {
"type": "string",
"description": "Close-up image pattern containing {id}"
},
"stats": {
"type": "string",
"description": "Relative path inside the package: no URL, no leading slash, no \"..\""
},
"source": {
"type": "string",
"description": "Where the layer comes from"
},
"aboutHtml": {
"type": "string",
"description": "Registry scrolls only"
}
}
},
"description": "One layer per role; at least one ct or ink layer"
},
"description": {
"type": "string"
},
"credits": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"citation": {
"type": "string"
},
"holder": {
"type": "string"
}
}
},
"dataTerms": {
"type": "object",
"properties": {
"license": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"notes": {
"type": "string"
}
}
},
"display": {
"type": "object",
"description": "Registry scrolls only"
}
},
"x-imageExtensions": [
"png",
"jpg",
"jpeg",
"webp",
"tif",
"tiff"
],
"x-meshExtensions": [
"obj",
"ply"
],
"x-limits": {
"openYourOwn": {
"maxFileBytes": 67108864,
"maxTotalBytes": 268435456,
"maxZipBytes": 134217728,
"maxWindings": 64,
"maxVertices": 2000000,
"maxTextureSide": 8192
},
"registry": {
"maxFileBytes": 209715200,
"maxTotalBytes": 2000000000,
"maxZipBytes": 134217728,
"maxWindings": 400,
"maxVertices": 2000000,
"maxTextureSide": 8192
}
}
}
}
|