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
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<link title="Purple" rel="stylesheet" href="manual-purple.css" type="text/css" />
<link title="Minty" rel="alternate stylesheet" href="manual-minty.css" type="text/css" />
<link title="Plain" rel="alternate stylesheet" href="manual.css" type="text/css" />
<title>openMSX Console Command Reference</title>
</head>
<body>
<h1>openMSX Console Command Reference</h1>
<ol class="inlinetoccat">
<li><a class="internal" href="#introduction">Introduction</a></li>
<li><a class="internal" href="#commands">Commands</a>
<ol class="inlinetoc">
<li><a class="internal" href="#after">after</a></li>
<li><a class="internal" href="#bind">bind / unbind / bind_default / unbind_default / activate_input_layer / deactivate_input_layer</a></li>
<li><a class="internal" href="#cart">cart / cart<x></a></li>
<li><a class="internal" href="#cassetteplayer">cassetteplayer</a></li>
<li><a class="internal" href="#cd">cd<x></a></li>
<li><a class="internal" href="#cycle">cycle / cycle_back</a></li>
<li><a class="internal" href="#debug">debug</a></li>
<li><a class="internal" href="#disk">disk<x> / virtual_drive</a></li>
<li><a class="internal" href="#diskmanipulator">diskmanipulator</a></li>
<li><a class="internal" href="#escape_grab">escape_grab</a></li>
<li><a class="internal" href="#exit">exit</a></li>
<li><a class="internal" href="#ext">ext / ext<x></a></li>
<li><a class="internal" href="#filepool">filepool</a></li>
<li><a class="internal" href="#findcheat">findcheat</a></li>
<li><a class="internal" href="#hd">hd<x></a></li>
<li><a class="internal" href="#help">help</a></li>
<li><a class="internal" href="#incr">incr</a></li>
<li><a class="internal" href="#iomap">iomap</a></li>
<li><a class="internal" href="#keymatrix">keymatrixdown / keymatrixup</a></li>
<li><a class="internal" href="#laserdiscplayer">laserdiscplayer</a></li>
<li><a class="internal" href="#list_extensions">list_extensions</a></li>
<li><a class="internal" href="#load_icons">load_icons</a></li>
<li><a class="internal" href="#load_settings">load_settings</a></li>
<li><a class="internal" href="#machine">machine</a></li>
<li><a class="internal" href="#machines">create_machine / load_machine / activate_machine / list_machines / delete_machine</a></li>
<li><a class="internal" href="#machine_info">machine_info</a></li>
<li><a class="internal" href="#message">message</a></li>
<li><a class="internal" href="#monitor_type">monitor_type</a></li>
<li><a class="internal" href="#mute_channels">mute_channels / unmute_channels / solo</a></li>
<li><a class="internal" href="#nowind">nowind<x></a></li>
<li><a class="internal" href="#openmsx_info">openmsx_info</a></li>
<li><a class="internal" href="#openmsx_update">openmsx_update</a></li>
<li><a class="internal" href="#osd">osd</a></li>
<li><a class="internal" href="#palette">palette</a></li>
<li><a class="internal" href="#plugunplug">plug / unplug</a></li>
<li><a class="internal" href="#psg_profile">psg_profile</a></li>
<li><a class="internal" href="#record">record</a></li>
<li><a class="internal" href="#record_channels">record_channels</a></li>
<li><a class="internal" href="#remove_extension">remove_extension</a></li>
<li><a class="internal" href="#reset">reset</a></li>
<li><a class="internal" href="#reverse">reverse</a></li>
<li><a class="internal" href="#save_settings">save_settings</a></li>
<li><a class="internal" href="#savestate">savestate / loadstate / list_savestates / delete_savestate</a></li>
<li><a class="internal" href="#screenshot">screenshot</a></li>
<li><a class="internal" href="#set">set</a></li>
<li><a class="internal" href="#slotmap">slotmap</a></li>
<li><a class="internal" href="#slotselect">slotselect</a></li>
<li><a class="internal" href="#soundlog">soundlog</a></li>
<li><a class="internal" href="#store_machine">store_machine / restore_machine</a></li>
<li><a class="internal" href="#test_machine">test_machine</a></li>
<li><a class="internal" href="#toggle">toggle</a></li>
<li><a class="internal" href="#trainer">trainer</a></li>
<li><a class="internal" href="#type">type / type_via_keyboard</a></li>
<li><a class="internal" href="#unset">unset</a></li>
<li><a class="internal" href="#user_setting">user_setting</a></li>
<li><a class="internal" href="#vdpregs">vdpregs</a></li>
<li><a class="internal" href="#other">other</a></li>
</ol>
</li>
<li><a class="internal" href="#settings">Settings</a>
<ol class="inlinetoc">
<li><a class="internal" href="#accuracy">accuracy</a></li>
<li><a class="internal" href="#audio-inputfilename">audio-inputfilename</a></li>
<li><a class="internal" href="#autoruncassettes">autoruncassettes</a></li>
<li><a class="internal" href="#autorunlaserdisc">autorunlaserdisc</a></li>
<li><a class="internal" href="#auto_enable_reverse">auto_enable_reverse</a></li>
<li><a class="internal" href="#auto_save_replay">auto_save_replay</a></li>
<li><a class="internal" href="#blur">blur</a></li>
<li><a class="internal" href="#bootsector">bootsector</a></li>
<li><a class="internal" href="#brightness">brightness</a></li>
<li><a class="internal" href="#cmdtiming">cmdtiming</a></li>
<li><a class="internal" href="#color_matrix">color_matrix</a></li>
<li><a class="internal" href="#console">console</a></li>
<li><a class="internal" href="#consolebackground">consolebackground</a></li>
<li><a class="internal" href="#consolecolumns">consolecolumns</a></li>
<li><a class="internal" href="#consolefont">consolefont</a></li>
<li><a class="internal" href="#consolefontsize">consolefontsize</a></li>
<li><a class="internal" href="#console_history_size">console_history_size</a></li>
<li><a class="internal" href="#consoleplacement">consoleplacement</a></li>
<li><a class="internal" href="#consolerows">consolerows</a></li>
<li><a class="internal" href="#console_remove_doubles">console_remove_doubles</a></li>
<li><a class="internal" href="#contrast">contrast</a></li>
<li><a class="internal" href="#cputrace">cputrace</a></li>
<li><a class="internal" href="#debugoutput">debugoutput</a></li>
<li><a class="internal" href="#default_machine">default_machine</a></li>
<li><a class="internal" href="#deflicker">deflicker</a></li>
<li><a class="internal" href="#deinterlace">deinterlace</a></li>
<li><a class="internal" href="#DirAsDSKmode">DirAsDSKmode</a></li>
<li><a class="internal" href="#disablesprites">disablesprites</a></li>
<li><a class="internal" href="#display_deform">display_deform</a></li>
<li><a class="internal" href="#di_halt_callback">di_halt_callback</a></li>
<li><a class="internal" href="#enable_session_management">enable_session_management</a></li>
<li><a class="internal" href="#frequency">frequency</a></li>
<li><a class="internal" href="#firmwareswitch">firmwareswitch</a></li>
<li><a class="internal" href="#fullscreen">fullscreen</a></li>
<li><a class="internal" href="#fullspeedwhenloading">fullspeedwhenloading</a></li>
<li><a class="internal" href="#gamma">gamma</a></li>
<li><a class="internal" href="#glow">glow</a></li>
<li><a class="internal" href="#grabinput">grabinput</a></li>
<li><a class="internal" href="#horizontal_stretch">horizontal_stretch</a></li>
<li><a class="internal" href="#inputdelay">inputdelay</a></li>
<li><a class="internal" href="#interleave_black_frame">interleave_black_frame</a></li>
<li><a class="internal" href="#invalid_psg_directions_callback">invalid_psg_directions_callback</a></li>
<li><a class="internal" href="#joystickN_config">joystick<n>_config</a></li>
<li><a class="internal" href="#joystickN_deadzone">joystick<n>_deadzone</a></li>
<li><a class="internal" href="#kbd_auto_toggle_code_kana_lock">kbd_auto_toggle_code_kana_lock</a></li>
<li><a class="internal" href="#kbd_code_kana_host_key">kbd_code_kana_host_key</a></li>
<li><a class="internal" href="#kbd_deadkey1_host_key">kbd_deadkey1_host_key</a></li>
<li><a class="internal" href="#kbd_deadkey2_host_key">kbd_deadkey2_host_key</a></li>
<li><a class="internal" href="#kbd_deadkey3_host_key">kbd_deadkey3_host_key</a></li>
<li><a class="internal" href="#kbd_mapping_mode">kbd_mapping_mode</a></li>
<li><a class="internal" href="#kbd_numkeypad_always_enabled">kbd_numkeypad_always_enabled</a></li>
<li><a class="internal" href="#kbd_numkeypad_enter_key">kbd_numkeypad_enter_key</a></li>
<li><a class="internal" href="#kbd_trace_key_presses">kbd_trace_key_presses</a></li>
<li><a class="internal" href="#keyjoystick_n_button">keyjoystick<n>.<button></a></li>
<li><a class="internal" href="#led">led_<name></a></li>
<li><a class="internal" href="#limitsprites">limitsprites</a></li>
<li><a class="internal" href="#master_volume">master_volume</a></li>
<li><a class="internal" href="#maxframeskip">maxframeskip</a></li>
<li><a class="internal" href="#midi-in-readfilename">midi-in-readfilename</a></li>
<li><a class="internal" href="#midi-out-logfilename">midi-out-logfilename</a></li>
<li><a class="internal" href="#minframeskip">minframeskip</a></li>
<li><a class="internal" href="#mode">mode</a></li>
<li><a class="internal" href="#mute">mute</a></li>
<li><a class="internal" href="#noise">noise</a></li>
<li><a class="internal" href="#pause">pause</a></li>
<li><a class="internal" href="#pause_on_lost_focus">pause_on_lost_focus</a></li>
<li><a class="internal" href="#pointer_hide_delay">pointer_hide_delay</a></li>
<li><a class="internal" href="#power">power</a></li>
<li><a class="internal" href="#printerlogfilename">printerlogfilename</a></li>
<li><a class="internal" href="#print-resolution">print-resolution</a></li>
<li><a class="internal" href="#r800_freq">r800_freq / r800_freq_locked</a></li>
<li><a class="internal" href="#renderer">renderer</a></li>
<li><a class="internal" href="#renshaturbo">renshaturbo</a></li>
<li><a class="internal" href="#resampler">resampler</a></li>
<li><a class="internal" href="#rs232-inputfilename">rs232-inputfilename</a></li>
<li><a class="internal" href="#rs232-outputfilename">rs232-outputfilename</a></li>
<li><a class="internal" href="#rtcmode">rtcmode</a></li>
<li><a class="internal" href="#samples">samples</a></li>
<li><a class="internal" href="#save_settings_on_exit">save_settings_on_exit</a></li>
<li><a class="internal" href="#scale_algorithm">scale_algorithm</a></li>
<li><a class="internal" href="#scale_factor">scale_factor</a></li>
<li><a class="internal" href="#scanline">scanline</a></li>
<li><a class="internal" href="#sound_driver">sound_driver</a></li>
<li><a class="internal" href="#speed">speed</a></li>
<li><a class="internal" href="#soundchip_balance"><soundchip>_balance</a></li>
<li><a class="internal" href="#soundchip_channel_record"><soundchip>_ch<channel>_record</a></li>
<li><a class="internal" href="#soundchip_channel_mute"><soundchip>_ch<channel>_mute</a></li>
<li><a class="internal" href="#soundchip_detune_frequency"><soundchip>_detune_frequency</a></li>
<li><a class="internal" href="#soundchip_detune_percent"><soundchip>_detune_percent</a></li>
<li><a class="internal" href="#soundchip_vibrato_frequency"><soundchip>_vibrato_frequency</a></li>
<li><a class="internal" href="#soundchip_vibrato_percent"><soundchip>_vibrato_percent</a></li>
<li><a class="internal" href="#soundchip_volume"><soundchip>_volume</a></li>
<li><a class="internal" href="#throttle">throttle</a></li>
<li><a class="internal" href="#too_fast_vram_access">too_fast_vram_access</a></li>
<li><a class="internal" href="#too_fast_vram_access_callback">too_fast_vram_access_callback</a></li>
<li><a class="internal" href="#touchpad_transform_matrix">touchpad_transform_matrix</a></li>
<li><a class="internal" href="#turborpause">turborpause</a></li>
<li><a class="internal" href="#umr_callback">umr_callback</a></li>
<li><a class="internal" href="#vdpcmdinprogress_callback">vdpcmdinprogress_callback</a></li>
<li><a class="internal" href="#vdpcmdtrace">vdpcmdtrace</a></li>
<li><a class="internal" href="#videosource">videosource</a></li>
<li><a class="internal" href="#v9990cmdtrace">v9990cmdtrace</a></li>
<li><a class="internal" href="#z80_freq">z80_freq / z80_freq_locked</a></li>
<li><a class="internal" href="#othersettings">other</a></li>
</ol>
</li>
</ol>
<h2><a id="introduction">Introduction</a></h2>
<p>This manual describes all commands and settings which are available in openMSX. You can use them to control openMSX fully from the Console (a built in command line interface, use F10 to call it), via Tcl scripts and via remote connections (explained in <a class="external" href="openmsx-control.html">Controlling openMSX from External Applications</a>). If you want to unleash the full potential of openMSX or just want a reference of all available possibilities, this manual should serve you well.</p>
<h2><a id="commands">Commands</a></h2>
<h3><a id="after">after</a></h3>
<p>Execute a command after a certain event occurs, for example a given amount of time has passed or the emulator has been idle for a given amount of time.
Every postponed command executes just once; if you want a command to run periodically, you have to issue it again every time it runs.
The <code>after</code> command returns the id of the postponed command.
It is possible to query a list of
postponed commands and also to cancel postponed commands.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>after time <seconds> <command></code></td>
<td>Execute a command after some time. Timescale is in MSX seconds.</td>
</tr>
<tr>
<td><code>after realtime <seconds> <command></code></td>
<td>Execute a command after some time. Timescale is in host seconds.</td>
</tr>
<tr>
<td><code>after idle <seconds> <command></code></td>
<td>Execute a command after some time being idle</td>
</tr>
<tr>
<td><code>after frame <command></code></td>
<td>Execute a command when a video frame is finished
(VDP scanning reaches vsync)</td>
</tr>
<tr>
<td><code>after break <command></code></td>
<td>Execute a command after a breakpoint is reached</td>
</tr>
<tr>
<td><code>after boot <command></code></td>
<td>Execute a command after a (re)boot</td>
</tr>
<tr>
<td><code>after machine_switch <command></code></td>
<td>Execute a command after switch to new a machine</td>
</tr>
<tr>
<td><code>after <input-event> <command></code></td>
<td>Execute a command after the given input event occurs. The events are e.g. mouse, joystick, focus and resize events, the same ones as for the <a class="internal" href="#bind">bind</a> command.</td>
</tr>
<tr>
<td><code>after info</code></td>
<td>List all postponed commands</td>
</tr>
<tr>
<td><code>after cancel <id></code></td>
<td>Cancel the postponed command with given id</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>after time 2.6 "set renderer SDLGL-PP"</code><br />
<code>after idle 100 exit</code><br />
<code>after info</code><br />
<code>after cancel after#2</code><br />
<code>after "mouse button1 down" foo</code>
</div>
<h3><a id="bind">bind / unbind / bind_default / unbind_default / activate_input_layer / deactivate_input_layer</a></h3>
<p>Associate events (such as key presses) with commands. Whenever the
specified event occurs (e.g. you press the specified key), the corresponding
command will be executed. Any Tcl command or combination of commands
separated with <tt>;</tt> (normal Tcl syntax) can be used. To customize your
bindings you should use the (un)bind commands. A script that wants to provide
a default binding for its functionality needs to use <tt>bind_default</tt>,
this allows users with different preferences to overrule the default
bindings. Using the <tt>-repeat</tt> option makes sure that if the event is
repeated (e.g. keyboard events when keeping a key pressed), the command is
repeated as well.</p>
<p>Tcl scripts that need a whole set of bindings and only conditionally
activate those bindings can use the 'input layer' system. It's possible to
associate a binding with a specific layer and later specific layer(s) can be
activated or deactivated. Such a layer can also be activated in a blocking
mode. Blocking mode means that even if the layer didn't have a binding for a
certain event, that event is still not passed to the emulated MSX. This can
be useful to implement certain OSD widgets (like a virtual OSD keyboard).</p>
<p>Events can be:</p>
<table>
<tr>
<td><code><key>[,release]</code></td>
<td>Short for <code>keyb <key>[,release]</code></td>
</tr>
<tr>
<td><code>keyb <key>[,release]</code></td>
<td><key> is pressed [or released]</td>
</tr>
<tr>
<td><code>mouse button<n> <up/down></code></td>
<td>Mouse button <n> went up or down</td>
</tr>
<tr>
<td><code>mouse motion <x> <y></code></td>
<td>Mouse motion of <x> and <y></td>
</tr>
<tr>
<td><code>joy<n> button<m> <up/down></code></td>
<td>Button <m> of joystick <n> went up/down</td>
</tr>
<tr>
<td><code>joy<n> axis<m> <value></code></td>
<td>Axis <m> of joystick <n> got value <value></td>
</tr>
<tr>
<td><code>focus <boolean></code></td>
<td>The openMSX window got (1) or lost (0) focus</td>
</tr>
<tr>
<td><code>OSDcontrol <button> PRESS|RELEASE</code></td>
<td>The virtual OSDcontrol <button> got pressed or released.</td>
</tr>
</table>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>bind</code></td>
<td>Show all bindings</td>
</tr>
<tr>
<td><code>bind -layer <layername></code></td>
<td>Show all in a specific layer</td>
</tr>
<tr>
<td><code>bind <event> [-layer <layername>]</code></td>
<td>Show binding for the given event, optionally you can specify a layer</td>
</tr>
<tr>
<td><code>bind <event> [-layer <layername>] [-repeat] <command></code></td>
<td>Make a new binding. Optionally make this binding in a specific layer.
Also optionally it's possible to retrigger this binding periodically
(e.g. when a key is kept pressed).</td>
</tr>
<tr>
<td><code>bind -layers</code></td>
<td>Show the names of all layers that currently have bindings</td>
</tr>
<tr>
<td><code>unbind [-layer <layername>] <event></code></td>
<td>Undo binding for this event (optionally in a specific layer).</td>
</tr>
<tr>
<td><code>unbind -layer <layername></code></td>
<td>Undo all bindings in the specified layer</td>
</tr>
<tr>
<td><code>activate_input_layer</code></td>
<td>Show a list of the currently active layers.</td>
</tr>
<tr>
<td><code>activate_input_layer [-blocking] <layername></code></td>
<td>Activate the specified input layer, optionally this layer can be
activate in blocking mode.</td>
</tr>
<tr>
<td><code>deactivate_input_layer <layername></code></td>
<td>Deactivate the specified input layer.</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>bind PAGEUP "set speed 100"</code><br />
<code>bind PAGEDOWN "set speed 50"</code><br />
<br />
Only run with full throttle while F9 is pressed (like BrMSX):<br />
<code>unbind F9</code><br />
<code>bind F9 "set throttle off"</code><br />
<code>bind F9,release "set throttle on"</code><br />
<br />
Pause when window loses focus (like fMSX):<br />
<code>bind "focus 0" "set pause on"</code><br />
<code>bind "focus 1" "set pause off"</code><br />
<br />
Middle-click to toggle input grabbing:<br />
<code>bind "mouse button2 down" "toggle grabinput"</code><br />
<br />
Map button 8 of joystick 1 to F2-key:<br />
<code>bind "joy1 button8 down" "keymatrixdown 6 0x40"</code><br />
<code>bind "joy1 button8 up" "keymatrixup 6 0x40"</code><br />
<br />
Use PageUp/Down to increase/decrease emulation speed.<br/>
<code>bind PAGEUP -repeat "incr speed 1"</code><br />
<code>bind PAGEDOWN -repeat "incr speed -1"</code><br />
<br />
Use Joystick hat left/right to increase/decrease volume.<br/>
<code>bind "joy1 hat0 left" -repeat "incr speed -5"</code><br />
<code>bind "joy1 hat0 right" -repeat "incr speed 5"</code><br />
<br />
Toggle fullscreen with ALT and ENTER.<br/>
<code>bind ALT+RETURN toggle fullscreen</code><br />
<br />
React to joystick or cursor up movement in a Tcl script:<br />
<code>bind_default "OSDcontrol UP PRESS" -repeat {osd_menu::menu_action UP }</code><br />
React to joystick button 1 or spacebar press in a Tcl script:<br />
<code>bind_default "OSDcontrol A PRESS" -repeat {osd_menu::menu_action A }</code><br />
</div>
<h3><a id="cart">cart / cart<x></a></h3>
<p>Insert a ROM cartridge in a running MSX. The <code>cart</code> command inserts the cartridge in the first available slot. The <code>carta</code>, <code>cartb</code> etc. commands insert it in the specified slot. The cartridges can be removed again with the <code>eject</code> subcommand.</p>
<p>ROM cartridges are a special class of extensions. For extensions that are not ROM cartridges, see the commands <code><a class="internal" href="#ext">ext</a></code>, <code><a class="internal" href="#list_extensions">list_extensions</a></code> and <code><a class="internal" href="#remove_extension">remove_extension</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>cart KMARE.ROM</code></td>
<td>Insert ROM cartridge in first free slot</td>
</tr>
<tr>
<td><code>cart insert KMARE.ROM</code></td>
<td>Insert ROM cartridge in first free slot</td>
</tr>
<tr>
<td><code>carta USAS.ROM -ips USAS.IPS</code></td>
<td>Insert ROM cartridge in slot A, with IPS patch applied to the ROM contents</td>
</tr>
<tr>
<td><code>cartb NEMESIS.ROM -romtype Konami</code></td>
<td>Insert ROM cartridge in slot B, and explicitly specify the mapper type (is normally auto detected)</td>
</tr>
<tr>
<td><code>carta eject</code></td>
<td>Eject the currently inserted cartridge from slot A</td>
</tr>
</table>
<h3><a id="cassetteplayer">cassetteplayer</a></h3>
<p>Controls the openMSX cassette player. The various subcommands can be used to insert, remove, create and rewind tape images.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>cassetteplayer insert <tape image></code></td>
<td>Insert tape image (WAV or CAS format) in the cassette player</td>
</tr>
<tr>
<td><code>cassetteplayer eject</code></td>
<td>Remove tape from virtual cassette player</td>
</tr>
<tr>
<td><code>cassetteplayer rewind</code></td>
<td>Rewind the current tape</td>
</tr>
<tr>
<td><code>cassetteplayer motorcontrol on|off</code></td>
<td>Selects whether motor control signal (remote) is obeyed (default: on)</td>
</tr>
<tr>
<td><code>cassetteplayer new [<tape image>]</code></td>
<td>Create new tape image and go to record mode</td>
</tr>
<tr>
<td><code>cassetteplayer play</code></td>
<td>Go to play mode (when in record mode) and rewind the tape</td>
</tr>
</table>
<h3><a id="cd">cd<x></a></h3>
<p>Change the CDROM image. The commands <code>cda</code>, <code>cdb</code> etc. are assigned to all available CDROM drives in the MSX. They will not
correspond to drive names as used in MSX-DOS.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>cda <iso image></code></td>
<td>Use ISO image for CDROM drive "cda"</td>
</tr>
<tr>
<td><code>cda insert <iso image></code></td>
<td>Use ISO image for CDROM drive "cda"</td>
</tr>
<tr>
<td><code>cda eject</code></td>
<td>Eject CDROM from CDROM drive "cda"</td>
</tr>
<tr>
<td><code>cda</code></td>
<td>Show current ISO image for CDROM drive "cda"</td>
</tr>
</table>
<h3><a id="cycle">cycle / cycle_back</a></h3>
<p>Iterates through the values of an enumerated setting.</p>
<p><code>cycle_back</code> does the same as <code>cycle</code>, but it goes in the opposite direction.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>cycle <setting></code></td>
<td>Changes the specified setting to the next value in the cycle</td>
</tr>
<tr>
<td><code>cycle_back <setting></code></td>
<td>Changes the specified setting to the previous value in the cycle</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>cycle scale_algorithm</code><br />
<code>cycle videosource</code>
</div>
<h3><a id="debug">debug</a></h3>
<p>This command provides access to the debugger functionality of openMSX. It's meant to be used by an external debugger (see also <a class="external" href="openmsx-control.html">Controlling openMSX from External Applications</a>). The general format of the debug command is:</p>
<p><code>debug <subcommand> [<extra arguments>]</code></p>
<p>where 'extra arguments' are specific for each subcommand. Below is a list of all subcommands:</p>
<table>
<tr>
<td><code>debug list</code></td>
<td>Return a list of all debuggables.<br />
A debuggable is (part of) the state of a MSX device that can be accessed
via these debug commands.<br />
Examples are:
<ul>
<li> the VDP registers </li>
<li> the currently visible memory for the Z80</li>
<li> the contents of the RAM </li>
</ul>
</td>
</tr>
<tr>
<td><code>debug desc <name></code></td>
<td>Return a description of this debuggable</td>
</tr>
<tr>
<td><code>debug size <name></code></td>
<td>Return the size of this debuggable</td>
</tr>
<tr>
<td><code>debug read <name> <addr></code></td>
<td>Read a byte from a debuggable</td>
</tr>
<tr>
<td><code>debug write <name> <addr> <val></code></td>
<td>Write a byte to a debuggable</td>
</tr>
<tr>
<td><code>debug read_block <name> <addr> <size></code></td>
<td>Read a whole block at once</td>
</tr>
<tr>
<td><code>debug write_block <name> <addr> <values></code></td>
<td>Write a whole block at once</td>
</tr>
<tr>
<td><code>debug probe <subcommand></code></td>
<td>See below.</td>
</tr>
<tr>
<td><code>debug break</code></td>
<td>Break CPU at current position</td>
</tr>
<tr>
<td><code>debug breaked</code></td>
<td>Query CPU break status</td>
</tr>
<tr>
<td><code>debug cont</code></td>
<td>Continue execution after break</td>
</tr>
<tr>
<td><code>debug step</code></td>
<td>Execute one instruction</td>
</tr>
<tr>
<td><code>debug list_bp</code></td>
<td>List the active breakpoints</td>
</tr>
<tr>
<td><code>debug set_bp <addr> [<cond>] [<cmd>]</code></td>
<td>Insert a new breakpoint at the given address. Optionally you can specify a condition and a command. When
the CPU is about to execute the instruction at the given address, the condition will be evaluated, if this
evaluates to true then the command is executed. The condition can be any Tcl expression and the command can be
any Tcl command. The default condition is 'true' and the default command is <code>"debug break"</code>.</td>
</tr>
<tr>
<td><code>debug remove_bp <id></code></td>
<td>Remove a certain breakpoint</td>
</tr>
<tr>
<td><code>debug list_watchpoints</code></td>
<td>List all defined watchpoints</td>
</tr>
<tr>
<td><code>debug set_watchpoint <type> <region> [<cond>] [<cmd>]</code></td>
<td>Insert a new watchpoint. When the CPU is about to read or write to/from the specified memory or I/O region,
the condition is evaluated. If the condition evaluated to true, the command is executed. The condition and the
command are similar to the ones in the <code>set_bp</code> subcommand. A watchpoint can either be set on a single memory
address or I/O port (specify a single value), or on a whole memory or I/O port range (specify a begin/end pair).
For example: <code>debug set_watchpoint write_mem {0x8000 0x8FFF}</code>. During the execution of <code><cmd></code>, the following global Tcl variables are set: <code>::wp_last_address</code>, which is the actual address of the mem/io read/write that triggered the watchpoint and <code>::wp_last_value</code>, the actual value that was written by the mem/io write that triggered the watchpoint.</td>
</tr>
<tr>
<td><code>debug remove_watchpoint <id></code></td>
<td>Remove a certain watchpoint</td>
</tr>
<tr>
<td><code>debug list_conditions</code></td>
<td>List the active conditions</td>
</tr>
<tr>
<td><code>debug set_condition <cond> [<cmd>]</code></td>
<td>Set a new debugger condition. Conditions are like breakpoints, but not
tied to a specific address. Simulation is much slower when conditions
are used (though generally while debugging this is not a problem).</td>
</tr>
<tr>
<td><code>debug remove_condition <id></code></td>
<td>Remove a certain condition</td>
</tr>
<tr>
<td><code>debug disasm [<addr>]</code></td>
<td>Disassemble instructions at PC or given address</td>
</tr>
</table>
<p>The probe subcommand again has subcommands:</p>
<table>
<tr>
<td><code>debug probe list</code></td>
<td>Returns a list of all probes.</td>
</tr>
<tr>
<td><code>debug probe desc <probe></code></td>
<td>Returns a description of this probe.</td>
</tr>
<tr>
<td><code>debug probe read <probe></code></td>
<td>Returns the current value of a probe. But note that not all probes have a value</td>
</tr>
<tr>
<td><code>debug probe set_bp <probe> [<cond>] [<cmd>]</code></td>
<td>Set a breakpoint on a probe. Like in the 'set_bp' subcommand you can optionally specify a condition and a command.</td>
</tr>
<tr>
<td><code>debug probe remove_bp <id></code></td>
<td>Remove the given breakpoint.</td>
</tr>
<tr>
<td><code>debug probe list_bp</code></td>
<td>List the active breakpoints set on probes.</td>
</tr>
</table>
<p>At first sight 'probes' and 'debuggables' are very similar. Though there are some important differences and that's why probes and debuggables use different subcommands:</p>
<table>
<tr>
<td>A debuggable is an array of bytes.</td>
<td>A probe is a single value and can have any type.</td>
</tr>
<tr>
<td>A debuggable is readable and (usually) writable.</td>
<td>A probe is always read-only.</td>
</tr>
<tr>
<td>It's not possible to set breakpoints on a debuggable.</td>
<td>You can set breakpoints on a probe (and sometimes this is the only purpose of a probe).</td>
</tr>
</table>
<p>Many examples of usage of the debug command can be found in the scripts that come with openMSX (in the <code>share/scripts</code> directory). We also list a few here.
</p>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<ul>
<li>break (only!) after 0 is written to 0x8000):<br/>
<code>debug set_watchpoint write_mem 0x8000 {[debug read "memory" 0x8000] ==
0x00}</code></li>
<li>break on address 0xF37D, but only when Z80 register C has the value 0x2F:<br/>
<code>debug set_bp 0xF37D {[reg C] == 0x2F}</code></li>
<li>break when CPU reads from any addresses between 0xFBE5 and 0xFBEF:<br/>
<code>debug set_watchpoint read_mem {0xFBE5 0xFBEF}</code></li>
<li>break after a write was done to I/O port 0x99, but only when Z80 register A has a value of 0x81:<br/>
<code>debug set_watchpoint write_io 0x99 {[reg A] == 0x81}</code></li>
<li>break as soon as there is a pending Z80 IRQ (even when in DI mode):<br/>
<code>debug probe set_bp z80.pendingIRQ</code></li>
<li>break when register HL has the value 1234:<br/>
<code>debug set_condition {[reg hl] == 1234}</code></li>
</ul>
</div>
<div class="note">
Note: Some of the commands are pretty low level. In the share/scripts directory you'll find some Tcl scripts that
offer convenience wrappers around these commands. For example: <a class="internal" href="#other"><code>showmem</code></a>, <a class="internal" href="#other"><code>disasm</code></a>, <a class="internal" href="#other"><code>cpuregs</code></a>, <a class="internal" href="#other"><code>save_debuggable</code></a>, etc.
</div>
<h3><a id="disk">disk<x> / virtual_drive</a></h3>
<p>Insert a disk image in a drive. Optionally apply an IPS patch to the disk image.
The commands <code>diska</code>, <code>diskb</code> etc. are
assigned to all available "physical" disk drives in the MSX. They might not correspond to drive names as used in
MSX-DOS.</p>
<p>In addition to the physical <code>disk<x></code> drives, there is the <code>virtual_drive</code>. This fake drive does not correspond to any MSX hardware. It can be used as a source or target for <code><a class="internal" href="#diskmanipulator">diskmanipulator</a></code> operations just like physical drives.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>diska <disk image></code></td>
<td>Insert disk image in drive "diska"</td>
</tr>
<tr>
<td><code>diskb insert <disk image></code></td>
<td>Insert disk image in drive "diskb"</td>
</tr>
<tr>
<td><code>diska <disk image> <ips></code></td>
<td>Insert disk image and apply IPS patch</td>
</tr>
<tr>
<td><code>diska eject</code></td>
<td>Remove disk from drive "diska"</td>
</tr>
<tr>
<td><code>diska ramdsk</code></td>
<td>Insert scratch disk in drive "diska"</td>
</tr>
</table>
<h3><a id="diskmanipulator">diskmanipulator</a></h3>
<p>A collection of commands to manipulate (the files on) a disk image.</p>
<p>It can be used in so many different ways, that we wrote a separate manual for it: <a class="external" href="diskmanipulator.html">Using Diskmanipulator</a>.</p>
<h3><a id="escape_grab">escape_grab</a></h3>
<p>Only has effect in windowed mode and when the <code><a class="internal" href="#grabinput">grabinput</a></code> setting is active. Temporarily release the input grab.
After the openMSX window has lost and regained the focus, the grab is again effective.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>escape_grab</code></td>
<td>Temporarily release the input grab</td>
</tr>
</table>
<h3><a id="exit">exit</a></h3>
<p>Terminate the openMSX application.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>exit</code></td>
<td>Exits the emulator</td>
</tr>
</table>
<h3><a id="ext">ext / ext<x></a></h3>
<p>Insert an MSX extension in a running MSX machine. The <code>ext</code> command inserts the extension in the first available slot. The <code>exta</code>, <code>extb</code> etc. commands insert it in the specified slot. The extension can be removed again with the <code><a class="internal" href="#remove_extension">remove_extension</a></code>
command. See also the commands <code><a class="internal" href="#cart">cart</a></code>, <code><a class="internal" href="#list_extensions">list_extensions</a></code> and <code><a class="internal" href="#remove_extension">remove_extension</a></code>.</p>
<p>To get a list of possible extensions it's convenient to use the tab-completetion feature, i.e. type '<code>ext<space><tab></code>'. Alternatively the command '<code><a class="internal" href="#openmsx_info">openmsx_info</a> extensions</code>' gives you the same information (and is easier to use in a scripting context).</p>
<p>Note that some extensions (i.e. those without any memory) will not physically occupy any slot when inserted, even when they were inserted in a specific slot.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>ext fmpac</code></td>
<td>Insert an FMPAC in a running MSX machine in the first free slot</td>
</tr>
<tr>
<td><code>extb scc</code></td>
<td>Insert the empty SCC cart in slot B of the running MSX machine</td>
</tr>
</table>
<h3><a id="filepool">filepool</a></h3>
<p>With this command you can manage your file pool settings. File pools are directories on your host system (PC/Mac/Dingoo/etc.). They are used by openMSX to search files in, which are referred to from machine or extension definition files, save states or replays which you are trying to load. First, the file will be searched at the path that was also used when the save state or replay was created. But if it isn't found there (which is usually the case if you load such a state or replay you got from someone else), it will use the file pools to search instead. In other words, if you are trying to load such replays, it's probably a good idea to put the media files referred to (ROMs, disks, tapes) in the (proper) filepool.</p>
<p>File pools have the following properties:</p>
<dl>
<dt>path</dt>
<dd>The path to the directory which is the actual file pool</dd>
<dt>position</dt>
<dd>There exists a list of file pools, which are searched in order of their position.</dd>
<dt>type(s)</dt>
<dd>A file pool can serve specific types. Currently, the valid types are
<dl>
<dt><code>system_rom</code></dt>
<dd>for system ROMs, you are probably using this one already if you installed your system ROMs in the recommended place <code>share/systemroms</code>,</dd>
<dt><code>rom</code></dt>
<dd>for other ROM files,</dd>
<dt><code>disk</code></dt>
<dd>for disk images and</dd>
<dt><code>tape</code></dt>
<dd>for cassette/tape images.</dd>
</dl>
</dd>
</dl>
<p>Apart from the default system ROM file pool as mentioned above, the other default file pool is <code>share/software</code>, which is configured for all other (than type <code>system_rom</code>) software files.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>filepool list</code></td>
<td>Shows the currently defined file pool entries (see below for example output)</td>
</tr>
<tr>
<td><code>filepool add -path <path> -types <typelist> [-position <pos>]</code></td>
<td>Add a new entry with the given properties as explained above. For the types, use a format like <code>"rom tape disk"</code>. Optionally, you can also specify where in the list of existing file pools the new file pool should be added. By default, this is at the end.</td>
</tr>
<tr>
<td><code>filepool remove <position></code></td>
<td>Remove the file pool at the given position</td>
</tr>
<tr>
<td><code>filepool reset</code></td>
<td>Reset the file pool settings to the default values</td>
</tr>
</table>
<p>An example of the default file pools for a Windows 7 system with user Quibus:</p>
<pre>
1: C:/Users/Quibus/Documents/openMSX/share/systemroms [system_rom]
2: C:/Users/Quibus/Documents/openMSX/share/software [rom disk tape]
3: C:/Program Files/openMSX/share/systemroms [system_rom]
4: C:/Program Files/openMSX/share/software [rom disk tape]
</pre>
<p>The first one is the system ROMs dir in the user's home directory. The second is the software file pool for other software in the user's home directory. The last two are similar, but then on system level. On a UNIX like system, you get something very similar.</p>
<h3><a id="findcheat">findcheat</a></h3>
<p>This is a tool to find new cheats, for example for a certain game it can help you find the memory location where the number of remaining lives is stored. These cheats can later be added to the <code><a class="internal" href="#trainer">trainer</a></code> command.</p>
<p>It works more or less like this:</p>
<ol>
<li>Initialize the <code>findcheat</code> tool, this takes an initial snapshot of the MSX memory.</li>
<li>Perform some action in the game that changes the variable that you're interested in. For example if you want to find the memory location where the number of lives is stored, you have to loose (or gain) a life in the game.</li>
<li>Now use the <code>findcheat</code> tool to compare the current MSX memory state with the previous memory snapshot. <code>findcheat</code> offers a lot of possibilities here, for example you can search for memory locations that became bigger or smaller or locations whose value changed or didn't change.</li>
<li><code>findcheat</code> will show a list of memory locations that still match the search criteria.</li>
<li>If there still are still too many matches, repeat from step 2.</li>
</ol>
<p>Vampier made a video tutorial on how to use <code>findcheat</code>, you can find it <a class="external" href="http://www.youtube.com/watch?v=F11ltfkCtKo">here</a>.</p>
<h3><a id="hd">hd<x></a></h3>
<p>Change the hard disk image. The commands <code>hda</code>, <code>hdb</code> etc. are assigned to all available hard disk drives in the MSX. They will not correspond to drive names as used in MSX-DOS.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>hda <disk image></code></td>
<td>Use hard disk image for hard disk "hda"</td>
</tr>
<tr>
<td><code>hda insert <disk image></code></td>
<td>Use hard disk image for hard disk "hda"</td>
</tr>
<tr>
<td><code>hda</code></td>
<td>Show current hard disk image for hard disk "hda"</td>
</tr>
</table>
<div class="note">
Note: Because of disk caching, changing the hard disk when the MSX is running can lead to corruption of the hard disk contents. Therefore openMSX blocks the <code>hd<x></code> commands unless the MSX is powered off. See <code><a class="internal" href="#power">power</a></code> setting.
</div>
<h3><a id="help">help</a></h3>
<p>Shows help info for console commands.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>help</code></td>
<td>Shows a list of all possible commands</td>
</tr>
<tr>
<td><code>help <command></code></td>
<td>Shows help info for a specific command</td>
</tr>
<tr>
<td><code>help <command> <subcommand></code></td>
<td>Some commands have more detailed help on subcommands</td>
</tr>
</table>
<h3><a id="incr">incr</a></h3>
<p>Increment an integer setting.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>incr <setting></code></td>
<td>Increment the specified setting by one</td>
</tr>
<tr>
<td><code>incr <setting> <num></code></td>
<td>Increment the specified setting by the given amount (can be negative)</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>incr speed</code><br />
<code>incr renshaturbo 10</code><br />
<code>incr scanline -5</code>
</div>
<h3><a id="iomap">iomap</a></h3>
<p>Shows what I/O ports are connected to which devices. The related command <code><a class="internal" href="#slotmap">slotmap</a></code> shows a similar overview, but for memory-mapped devices.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>iomap</code></td>
<td>Shows the I/O map of the current MSX machine</td>
</tr>
</table>
<h3><a id="keymatrix">keymatrixdown / keymatrixup</a></h3>
<p>Press or release keys in the MSX keyboard matrix. Can be used to make an external program or Tcl script press MSX keys. For some more information about the keymatrix, you could read the <a href="http://map.grauw.nl/articles/keymatrix.php">article on the MAP</a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>keymatrixdown <row> <mask></code></td>
<td>Press the indicated MSX keys</td>
</tr>
<tr>
<td><code>keymatrixup <row> <mask></code></td>
<td>Release the indicated MSX keys</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>keymatrixdown 6 0x01</code><br />
<code>keymatrixup 6 0x01</code>
</div>
<h3><a id="laserdiscplayer">laserdiscplayer</a></h3>
<p>Controls the Laserdisc player; a Laserdisc can be inserted or ejected. When a real Laserdisc player is connected to an MSX, no other controls are available either.</p>
<p>Note that this command is only available when the Pioneer PX-7 or Pioneer PX-V60 MSX machine is being emulated</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>laserdiscplayer insert <filename></code></td>
<td>Inserts the specified file into the virtual laserdisc player.</td>
</tr>
<tr>
<td><code>laserdiscplayer eject</code></td>
<td>Ejects the laserdisc from the virtual laserdisc player; this emulates pressing the eject button on a real Laserdisc Player.</td>
</tr>
</table>
<h3><a id="list_extensions">list_extensions</a></h3>
<p>Returns a list of inserted cartridges and extensions. These can be removed with the <code><a class="internal" href="#remove_extension">remove_extension</a></code> command or
additional items can be added with the <code><a class="internal" href="#cart">cart</a></code> and <code><a class="internal" href="#ext">ext</a></code> commands.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>list_extensions</code></td>
<td>Lists all currently inserted cartridges and extensions</td>
</tr>
</table>
<h3><a id="load_icons">load_icons</a></h3>
<p>Load a different icon set (used for the On Screen Display (OSD) LEDs).</p>
<p>Icon sets are stored in the share/skins directory.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>load_icons <name></code></td>
<td>Load the given icon set, but don't change the position on the screen.</td>
</tr>
<tr>
<td><code>load_icons <name> <position></code></td>
<td>Load the given icon set and place them at the requested position. Position can be <code>bottom</code>, <code>top</code>, <code>left</code> or <code>right</code>.</td>
</tr>
</table>
<h3><a id="load_settings">load_settings</a></h3>
<p>Load settings from a given settings XML file. The settings file does not have to be complete: settings that are not mentioned in the given file are left untouched. See also <code><a class="internal" href="#save_settings">save_settings</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>load_settings <filename></code></td>
<td>Load settings from the given file</td>
</tr>
</table>
<h3><a id="machine">machine</a></h3>
<p>Switch to a new MSX machine.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>machine</code></td>
<td>Returns the handle for the currently active machine</td>
</tr>
<tr>
<td><code>machine <machine name></code></td>
<td>Switch to the specified machine, also returns the handle for that machine</td>
</tr>
</table>
<div class="note">
Note: The machine handle is mostly used by external applications controlling openMSX (see also <a class="external" href="openmsx-control.html">Controlling openMSX from External Applications</a>). For interactive use you can omit the machine handle to have the commands operate on the current machine.
</div>
<h3><a id="machines">create_machine / load_machine / activate_machine / list_machines / delete_machine</a></h3>
<p>openMSX has the possibility to have multiple MSX machines concurrently in memory. This is more or less like multiple tabs in a web browser: you only work with one at-a-time, but you can have multiple open at the same time and easily switch between them. These commands are low level commands to manage this.</p>
<p>Some commands are specific per machine, for example if you insert a disk image into the disk drive of the emulated MSX machine and if you have multiple MSX machines, you need to specify in which MSX machine you want to insert the disk. To solve this, we introduced the concept of the 'active' MSX machine (this is also the machine that is visible and audible). All unqualified machine-specific command will act on the active machine. If you want to execute the command in a specific machine, you can qualify the command with a machineID prefix.</p>
<table>
<tr>
<td><code>diska <diskimage></code></td>
<td>execute the diska command in the active machine</td>
</tr>
<tr>
<td><code><machine-ID>::diska <diskimage></code></td>
<td>execute the diska command in the specified machine</td>
</tr>
</table>
<h4><code>create_machine</code>:</h4>
<p>This command returns a new machine-id. This machine-id can be used in the following commands. In the web browser analogy this command would open a new empty tab.</p>
<h4><code>load_machine</code>:</h4>
<p>This command loads a machine configuration (= MSX model) into the given machine-ID.
In the web browser analogy, this command would load a page in a previously created empty tab. And unlike a web browser, where you can reload a different page in the same tab, you can only load a machine configuration once in the same machine-ID.</p>
<h4><code>activate_machine</code>:</h4>
<p>This command activates the given machine-ID. At any time there can only be one active machine-ID. This is analogue to switching tabs in a web browser.</p>
<h4><code>list_machines</code>:</h4>
<p>Returns a list of all currently existing machine-IDs.</p>
<h4><code>delete_machine</code>:</h4>
<p>Deletes the given machine-ID. This is analogue to closing a tab in a web browser.</p>
<h4>examples:</h4>
<table>
<tr>
<td><code>set oldID [machineID]</code></td>
<td>get the current machineID</td>
</tr>
<tr>
<td><code>set newID [create_machine]</code></td>
<td>create a new machineID</td>
</tr>
<tr>
<td><code>$newID::load_machine Philips_NMS_8250</code></td>
<td>load an MSX2 configuration in that new machineID</td>
</tr>
<tr>
<td><code>activate_machine $newID</code></td>
<td>switch to the new machine</td>
</tr>
<tr>
<td><code>activate_machine $oldID</code></td>
<td>switch back to old machine</td>
</tr>
<tr>
<td><code>delete_machine $newID</code></td>
<td>delete new machine</td>
</tr>
</table>
<div class="note">
If you don't care about multiple active machines, the <code><a class="internal" href="#machine">machine</a></code> command is much more convenient to switch to a different MSX configuration.
</div>
<h3><a id="machine_info">machine_info</a></h3>
<p>Shows information about a certain topic. This command is similar to the <code><a class="internal" href="#openmsx_info">openmsx_info</a></code> command. The topics of
<code>machine_info</code> are all machine specific, while the topics of <code><a class="internal" href="#openmsx_info">openmsx_info</a></code> are generic.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>machine_info</code></td>
<td>Shows a list of all possible topics</td>
</tr>
<tr>
<td><code>machine_info <topic></code></td>
<td>Shows info on the given topic</td>
</tr>
</table>
<h3><a id="message">message</a></h3>
<p>Show a message, with optional level (info, warning, error). By default this message will be shown in a colored box at the top of the screen for a (short) duration and then fade away.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>message <text> [<level>]</code></td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>message "Hello world!"</code><br />
<code>message "Something bad happened" error</code><br />
</div>
<h3><a id="monitor_type">monitor_type</a></h3>
<p>Select a monitor color profile.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>monitor_type</code></td>
<td>Shows the currently selected color profile</td>
</tr>
<tr>
<td><code>monitor_type -list</code></td>
<td>Lists all available color profiles</td>
</tr>
<tr>
<td><code>monitor_type <profile></code></td>
<td>Selects a new color profile</td>
</tr>
</table>
<div class="note">
Note: This command is a convenience wrapper around the <code><a class="internal" href="#color_matrix">color_matrix</a></code> setting.
</div>
<h3><a id="mute_channels">mute_channels / unmute_channels / solo</a></h3>
<p>Mute or unmute specific individual channels of sound devices. The syntax is very similar to the <code><a class="internal" href="#record_channels">record_channels</a></code> command.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>mute_channels <device> [<channels>]] [<device> [<channels>]]</code></td>
<td>Mute the specified channels of the specified device(s). If a device is given but no specific channels are specified, all channels of that device are muted. If no arguments are given at all, this command return a list of all currently muted channels.</td>
</tr>
<tr>
<td><code>unmute_channels <device> [<channels>]] [<device> [<channels>]]</code></td>
<td>Unmute the specified channels of the specified device(s). If a device is given but no specific channels are specified, all channels of that device are unmuted. If no arguments are given at all, this command unmutes all channels of all devices. </td>
</tr>
<tr>
<td><code>solo <device> [<channels>]] [<device> [<channels>]]</code></td>
<td>Mute all channels of all devices except for the specified channels.</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>mute_channels</code><br />
<code>mute_channels PSG</code><br />
<code>mute_channels SCC 2,4</code><br />
<code>unmute_channels</code><br />
<code>unmute_channels PSG 1 SCC 1,3-4</code><br />
<code>solo PSG 3</code>
</div>
<h3><a id="nowind">nowind<x></a></h3>
<p>Similar to the <code><a class="internal" href="#disk">disk<x></a></code>
commands there is a <code>nowind<x></code> command for each nowind
interface. This command is modeled after the 'usbhost' command of the real
nowind interface. Though only a subset of the options is supported. Here's a
short overview of the command line options:</p>
<table>
<tr><th>long</th> <th>short</th><th>explanation</th></tr>
<tr><td>--image</td> <td>-i</td> <td>specify disk image</td></tr>
<tr><td>--hdimage</td> <td>-m</td> <td>specify harddisk image</td></tr>
<tr><td>--romdisk</td> <td>-j</td> <td>enable romdisk</td></tr>
<tr><td>--ctrl</td> <td>-c</td> <td>no phantom disks</td></tr>
<tr><td>--no-ctrl</td> <td>-C</td> <td>enable phantom disks</td></tr>
<tr><td>--allow</td> <td>-a</td> <td>allow other diskroms to initialize</td></tr>
<tr><td>--no-allow</td><td>-A</td> <td>don't allow other diskroms to initialize</td></tr>
</table>
<p>If you don't pass any arguments to this command, you'll get an overview of
the current nowind status.</p>
<p>This command will create a certain amount of drives on the nowind
interface and (optionally) insert diskimages in those drives. For each of
these drives there will also be a
<code><a class="internal" href="#disk">nowind<x><1..8></a></code>
command created. Those commands are similar to e.g. the
<code><a class="internal" href="#disk">diska</a></code>
command. They can be used to access the more advanced diskimage insertion
options.</p>
<p>In some cases it is needed to reboot the MSX before the changes take
effect. In those cases you'll get a message that warns about this.</p>
<div class="subsectiontitle">examples:</div>
<table>
<tr>
<td><code>nowinda -a image.dsk -j</code></td>
<td>Image.dsk is inserted into drive A: and the romdisk will be drive B:.
Other diskroms will be able to install drives as well. For example when
the MSX has an internal diskdrive, drive C: en D: will be available as
well.</td>
</tr>
<tr>
<td><code>nowinda disk1.dsk disk2.dsk</code></td>
<td>The two images will be inserted in A: and B: respectively.</td>
</tr>
<tr>
<td><code>nowinda -m hdimage.dsk</code></td>
<td>Inserts a harddisk image. All available partitions will be mounted
as drives.</td>
</tr>
<tr>
<td><code>nowinda -m hdimage.dsk:1</code></td>
<td>Inserts the first partition only.</td>
</tr>
<tr>
<td><code>nowinda -m hdimage.dsk:2-4</code></td>
<td>Inserts the 2nd, 3th and 4th partition as drive A: B: and C:.</td>
</tr>
</table>
<h3><a id="openmsx_info">openmsx_info</a></h3>
<p>Shows information about a certain topic. For machine-specific topics, use the related command <code><a class="internal" href="#machine_info">machine_info</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>openmsx_info</code></td>
<td>Shows a list of all possible topics</td>
</tr>
<tr>
<td><code>openmsx_info <topic></code></td>
<td>Shows info on the given topic</td>
</tr>
</table>
<h3><a id="openmsx_update">openmsx_update</a></h3>
<p>Enable or disable update notifications of a certain type. This command is intended for external programs controlling openMSX. More about this in <a class="external" href="openmsx-control.html">Controlling openMSX from External Applications</a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>openmsx_update enable <type></code></td>
<td>enable notifications for this type</td>
</tr>
<tr>
<td><code>openmsx_update disable <type></code></td>
<td>disable notifications for this type</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>openmsx_update enable led</code><br />
<code>openmsx_update disable setting</code>
</div>
<h3><a id="osd">osd</a></h3>
<p>openMSX has the possibility to show OSD (on screen display) elements. For example, the LEDs and the fps-indicator are implemented via OSD elements. This command allows to create new OSD elements, configure existing elements or delete elements.</p>
<p>This command is only useful if you plan to adjust or enhance the openMSX OSD, or create your own OSD widgets.</p>
<!-- do we really have to repeat the help text from the openmsx source code here? -->
<p>Execute "<code>help osd</code>" to get a detailed description of this command, which we will not repeat here.</p>
<h3><a id="palette">palette</a></h3>
<p>Shows the current VDP palette settings. Related command: <code><a class="internal" href="#vdpregs">vdpregs</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>palette</code></td>
<td>Show the currently active color palette</td>
</tr>
</table>
<h3><a id="plugunplug">plug / unplug</a></h3>
<p>Plugs or unplugs a plug into a connector, for example plug a virtual joystick into a virtual joystick port.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>plug</code></td>
<td>Shows all currently connected plugs</td>
</tr>
<tr>
<td><code>plug <connector></code></td>
<td>Shows currently connected plug for the specified connector</td>
</tr>
<tr>
<td><code>plug <connector> <plug></code></td>
<td>Plugs the specified plug into the specified connector</td>
</tr>
<tr>
<td><code>unplug <connector></code></td>
<td>Unplugs the plug connected to the specified connector</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>plug cassetteport cassetteplayer</code><br />
<code>plug joyporta mouse</code><br />
<code>plug printerport logger</code><br />
<code>unplug joyportb</code><br />
</div>
<h3><a id="psg_profile">psg_profile</a></h3>
<p>Select a PSG sound profile.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>psg_profile</code></td>
<td>Shows the currently selected sound profile</td>
</tr>
<tr>
<td><code>psg_profile -list</code></td>
<td>Lists all available sound profiles</td>
</tr>
<tr>
<td><code>psg_profile <profile></code></td>
<td>Selects a new sound profile</td>
</tr>
</table>
<div class="note">
Note: This command is a convenience wrapper around the <code><a class="internal" href="#soundchip_vibrato_frequency">PSG_vibrato_frequency</a></code>, <code><a class="internal" href="#soundchip_vibrato_percent">PSG_vibrato_percent</a></code>, <code><a class="internal" href="#soundchip_detune_frequency">PSG_detune_frequency</a></code> and <code><a class="internal" href="#soundchip_detune_percent">PSG_detune_percent</a></code> settings.
</div>
<h3><a id="record">record</a></h3>
<p>Controls video recording: write openMSX audio/video to an AVI file.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>record start</code></td>
<td>Record to file "openmsxNNNN.avi"</td>
</tr>
<tr>
<td><code>record start <filename></code></td>
<td>Record to indicated file</td>
</tr>
<tr>
<td><code>record start -prefix foo</code></td>
<td>Record to file "fooNNNN.avi"</td>
</tr>
<tr>
<td><code>record stop</code></td>
<td>Stop recording</td>
</tr>
<tr>
<td><code>record toggle</code></td>
<td>Toggle recording</td>
</tr>
</table>
<p>The <code>start</code> subcommand also accepts an optional <code>-audioonly</code>, <code>-videoonly</code>, <code>-doublesize</code> and a <code>-triplesize</code> flag. Videos are recorded in a 320×240 size by default, at 640×480 when the <code>-doublesize</code> flag is used and 960×720 when using the <code>-triplesize</code> flag.
If only audio is recorded, the created file will be a WAV file instead of an AVI file.</p>
<p>If any stereo sound devices are present or any sound device has an off-center balance, the recording will be made in stereo, otherwise it will be mono.
If a recording is made in mono and then a stereo sound device is added, you'll receive a warning that stereo sound has been detected and that the two channels will be mixed down to mono.
You can prevent this from happening by using the <code>-stereo</code> option to force a stereo recording even if no stereo devices are present at the time you enter the command.
You can also force a mono recording with <code>-mono</code> to save space.</p>
<p>The <code><a class="internal" href="#soundlog">soundlog</a></code> command is a shorthand for <code>record -audioonly</code>.</p>
<p>Use <code>record_chunks</code> if you want some extra options. You can control the maximum length (in seconds) to record and also set up multiple recordings of a certain length. This is very useful if you want to record for e.g. YouTube. The default length is 14:59 (to make sure YouTube will accept it). Using this command implies <code>-doublesize</code>.</p>
<p>Use <code>record_chunks_on_framerate_changes</code> if you want to split up the recording in several files, whenever the frame rate of the MSX changes. An AVI file cannot contain video of multiple frame rates, so sound and video will get out of sync if that happens without using this special version of the command. Do not specify the target filename with this variant, or openMSX will record all chunks to the same file.</p>
<h3><a id="record_channels">record_channels</a></h3>
<p>A high level command to record individual channels of sound chips to separate files. In the following variants of the command you can specify devices and channels. Multiple devices can be specified and multiple channels as well. If you want to specify channels of a device, put them right after the device. You can also specify <code>all</code> for the device, which means that all sound devices in the currently running MSX will be recorded. When starting recording, an option <code>-prefix</code> can be given to specify a filename prefix.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>record_channels [start] <device> [<channels>] [<device> [<channels>]] [-prefix <prefix>]</code></td>
<td>Start recording the specified channel(s) of the specified device(s). If no channels are given, all channels of the device are recorded. </td>
</tr>
<tr>
<td><code>record_channels stop [<device> [<channels>]] [<device> [<channels>]]</code></td>
<td>Stop recording the specified channel(s) of the specified device(s). If no channels are given, recording for all channels is stopped for the given device(s). If no devices are given, all channel recording is stopped.</td>
</tr>
<tr>
<td><code>record_channels all -prefix justtesting</code></td>
<td>Record all channels of all sound devices and create the file names with prefix 'justtesting' (e.g. to quickly delete all these files again).</td>
</tr>
<tr>
<td><code>record_channels list</code></td>
<td>Lists which channels of which sound chips are currently being recorded.</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>record_channels start PSG</code><br />
<code>record_channels PSG</code><br />
<code>record_channels SCC 1,4-5</code><br />
<code>record_channels SCC PSG 1</code><br />
<code>record_channels "MSX Music" 7-9 SCC 3,5 PSG 2</code><br />
<code>record_channels stop</code><br />
<code>record_channels stop PSG</code><br />
<code>record_channels stop SCC 3,5</code><br />
<code>record_channels list</code>
</div>
<h3><a id="remove_extension">remove_extension</a></h3>
<p>Remove a cartridge or extension from a running MSX machine. See also the commands <code><a class="internal" href="#cart">cart</a></code>, <code><a class="internal" href="#ext">ext</a></code>, <code><a class="internal" href="#list_extensions">list_extensions</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>remove_extension fmpac</code></td>
<td>Removes the FMPAC extension from the running MSX</td>
</tr>
</table>
<h3><a id="reset">reset</a></h3>
<p>Emulates the pressing of the reset button on the MSX. This sends a reset pulse to all devices, but does not erase memory contents.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>reset</code></td>
<td>Resets the current machine</td>
</tr>
</table>
<h3><a id="reverse">reverse</a></h3>
<p>Controls the reverse feature. When this feature is enabled (the default), openMSX will collect data while emulating, which enables you to go back (and forward) in MSX time. In other words: you cannot use the commands to go back and forward in time, if you disable the feature.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>reverse start</code></td>
<td>Start collecting data (enable the reverse feature).</td>
</tr>
<tr>
<td><code>reverse stop</code></td>
<td>Stop collecting data (disable reverse feature) and remove all collected data.</td>
</tr>
<tr>
<td><code>reverse status</code></td>
<td>Gives information about the reverse feature and the data it collected. Mostly useful for scripts.</td>
</tr>
<tr>
<td><code>reverse goback <n></code></td>
<td>Go back <n> seconds in time. Of course, you cannot go back to a time before the time the <code>reverse start</code> command was given.</td>
</tr>
<tr>
<td><code>reverse viewonlymode <on|off></code></td>
<td>Control the view only mode of the reverse feature. In view only mode, the replay will never get interrupted by any user actions that normally would interrupt the replay. Use this to safely view a replay without accidentally ruining it by touching a key.</td>
</tr>
<tr>
<td><code>reverse goto <time></code></td>
<td>Go to the indicated absolute moment in MSX time (given in seconds). If the time is before the time openMSX started collecting data (with the <code>reverse start</code> command) openMSX will jump to the time when collecting started.</td>
</tr>
<tr>
<td><code>reverse truncatereplay</code></td>
<td>Stop replaying and wipe all replay data that is in the future (so after <strong>now</strong>). This is useful if you are hindered by the future events somehow, for instance when you are playing a game and jumped too early and therefore reversed. Be careful with this, as there is no way to recover this future. If you are at time 0, it means your whole replay will be gone after executing this command!</td>
</tr>
<tr>
<td><code>reverse savereplay [<filename>]</code></td>
<td>Save the collected data (an initial savestate and all collected input events) to a file.</td>
</tr>
<tr>
<td><code>reverse loadreplay [-goto <begin|end|savetime|<n>>] [-viewonly] <filename></code></td>
<td>Load the replay from the given file and start it. Loads the initial snapshot and starts replaying the recorded events. Enables the reverse feature automatically. With the <code>-goto</code> option, you can specify where to jump to in the replay after loading (<code>begin</code> is default), where <code>savetime</code> is the time at which the replay was saved and <code>n</code> is an absolute time in seconds in the replay. The <code>-viewonly</code> option is a shortcut to put the reverse feature in viewonly mode directly after loading the replay. Without this option, it will always go to normal mode.</td>
</tr>
</table>
<p>There are some extra helper commands to make the feature easier to use.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>go_back_one_second</code> / <code>go_forward_one_second</code></td>
<td>Go back or forward one second in time (if possible). These are used for the default PageUp and PageDown key bindings.</td>
</tr>
<tr>
<td><code>reverse_prev [<min> [<max>]]</code></td>
<td>Go back in time to the previous (internal) snapshot. The further back in the past the less dense the amount of snapshots are. So, executing this command multiple times, will take successively bigger steps in the past. You can optionally specify a minimal and maximal step size. You will at least go back the minimal amount of time (even if there's a snapshot closer to the current time) and at most the maximal amount of time (even if there's no snapshot within the maximum specified time from the current time).</td>
</tr>
<tr>
<td><code>reverse_next [<min> [<max>]]</code></td>
<td>As <code>reverse_prev</code> but then it goes to the closest snapshot in the future (if possible).</td>
</tr>
</table>
<p>Because the reverse feature is very useful, it is automatically enabled via <code><a class="internal" href="#auto_enable_reverse">auto_enable_reverse</a></code> setting.</p>
<h3><a id="save_settings">save_settings</a></h3>
<p>Write the current openMSX settings to a settings XML file. See also <code><a class="internal" href="#load_settings">load_settings</a></code>.</p>
<p>If you disabled <code><a class="internal" href="#save_settings_on_exit">save_settings_on_exit</a></code>, you can use this command to save your preferences.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>save_settings</code></td>
<td>Save settings to the default settings file</td>
</tr>
<tr>
<td><code>save_settings <filename></code></td>
<td>Save settings to the given file</td>
</tr>
</table>
<h3><a id="savestate">savestate / loadstate / list_savestates / delete_savestate</a></h3>
<p>These commands can be used to manage savestates. These are much easier to use than the lowlevel <code><a class="internal" href="#store_machine">store_machine</a></code> and <code><a class="internal" href="#store_machine">restore_machine</a></code> commands.</p>
<h4><code>savestate [<name>]</code></h4>
<p>This creates a snapshot of the currently emulated MSX machine. Optionally you can specify a name for the savestate, if you omit this name, the default name <code>quicksave</code> will be taken.</p>
<h4><code>loadstate [<name>]</code></h4>
<p>This restores a previously created savestate. Like above you can specify a name which defaults to <code>quicksave</code> if omitted.</p>
<h4><code>list_savestates</code></h4>
<p>This returns the names of all previously created savestates.</p>
<h4><code>delete_savestate <name></code></h4>
<p>Delete a previously created savestate.</p>
<h3><a id="screenshot">screenshot</a></h3>
<p>Take a screenshot of the openMSX screen. By default this takes a screenshot of the 'scaled' MSX screen (see <code><a class="internal" href="#scale_algorithm">scale_algorithm</a></code> setting) without OSD elements (e.g. console and icons). If you want to include the OSD elements pass the <code>-with-osd</code> option. If you want a screenshot of the 'unscaled' raw MSX screen, pass the <code>-raw</code> option. The screenshots are PNG files and (by default) are saved in the <code>screenshots</code> subdirectory of the openMSX data directory in your home directory. There's also an option <code>-no-sprites</code> to take a screenshot with sprite rendering disabled.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td>
<code>screenshot [-with-osd] [-raw [-doublesize]] [-no-sprites] [-prefix <prefix>] [<filename>]</code>
</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<table>
<tr>
<td><code>screenshot</code></td>
<td>Write screenshot to file "openmsxNNNN.png"</td>
</tr>
<tr>
<td><code>screenshot <filename></code></td>
<td>Write screenshot to indicated file</td>
</tr>
<tr>
<td><code>screenshot -prefix foo</code></td>
<td>Write screenshot to file "fooNNNN.png"</td>
</tr>
<tr>
<td><code>screenshot -raw</code></td>
<td>Create screenshot of the raw MSX screen only (so no icons or console and no scaling)</td>
</tr>
<tr>
<td><code>screenshot -raw -doublesize</code></td>
<td>Create screenshot of the raw MSX screen only, with resolution 640×480</td>
</tr>
<tr>
<td><code>screenshot -with-osd</code></td>
<td>Create screenshot of the scaled screen, including OSD elements</td>
</tr>
<tr>
<td><code>screenshot -no-sprites</code></td>
<td>Create screenshot with sprite rendering disabled</td>
</tr>
</table>
<h3><a id="set">set</a></h3>
<p>Change or query the value of various settings. See also: <code><a class="internal" href="#unset">unset</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <setting></code></td>
<td>Query the current value of the specified setting</td>
</tr>
<tr>
<td><code>set <setting> <value></code></td>
<td>Change the specified setting to the given value</td>
</tr>
</table>
<p>The settings that can be adjusted with this command are listed and explained <a class="internal" href="#settings">later</a> in this document.</p>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set accuracy pixel</code><br />
<code>set blur 25</code><br />
<code>set scanline 20</code><br />
<code>set deinterlace on</code><br />
</div>
<h3><a id="slotmap">slotmap</a></h3>
<p>Shows what devices are inserted into which slots. The related command <code><a class="internal" href="#iomap">iomap</a></code> shows a similar overview, but for I/O mapped devices.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>slotmap</code></td>
<td>Shows the slot map of the current MSX machine</td>
</tr>
</table>
<h3><a id="slotselect">slotselect</a></h3>
<p>Shows the currently selected slots. To see what devices are located in the slots, use the <code><a class="internal" href="#slotmap">slotmap</a></code> command.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>slotselect</code></td>
<td>Shows the currently selected slot for each page</td>
</tr>
</table>
<h3><a id="soundlog">soundlog</a></h3>
<p>Controls sound logging: writing the openMSX sound to a WAV file.</p>
<p>This command is a shorthand for <code><a class="internal" href="#record">record</a> -audioonly</code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>soundlog start</code></td>
<td>Log sound to file "openmsxNNNN.wav"</td>
</tr>
<tr>
<td><code>soundlog start <filename></code></td>
<td>Log sound to indicated file</td>
</tr>
<tr>
<td><code>soundlog start -prefix foo</code></td>
<td>Log sound to file "fooNNNN.wav"</td>
</tr>
<tr>
<td><code>soundlog stop</code></td>
<td>Stop logging sound</td>
</tr>
<tr>
<td><code>soundlog toggle</code></td>
<td>Toggle sound logging state</td>
</tr>
</table>
<h3><a id="store_machine">store_machine / restore_machine</a></h3>
<p>These are low-level commands, used to implement savestates.</p>
<h4><code>store_machine</code>:</h4>
<p>Saves the state of the specified machine to a file.</p>
<table>
<tr>
<td><code>store_machine</code></td>
<td>Save state of current machine to file "openmsxNNNN.xml.gz"</td>
</tr>
<tr>
<td><code>store_machine <machineID></code></td>
<td>Save state of indicated machine to file "openmsxNNNN.xml.gz"</td>
</tr>
<tr>
<td><code>store_machine <machineID> <filename></code></td>
<td>Save state of indicated machine to specified file</td>
</tr>
</table>
<h4><code>restore_machine</code>:</h4>
<p>Load a previously saved machine in a new machine-ID, next to the already available machines. See the section on <code><a class="internal" href="#machines">activate_machine</a></code>.</p>
<table>
<tr>
<td><code>restore_machine</code></td>
<td>Load state from last saved state in default directory</td>
</tr>
<tr>
<td><code>restore_machine <filename></code></td>
<td>Load state from indicated file</td>
</tr>
</table>
<div class="note">
Note: These commands are pretty low level. The <code><a class="internal" href="#savestate">savestate</a></code> and <code><a class="internal" href="#savestate">loadstate</a></code> scripts are built on top of this and are much more convenient to use.
</div>
<h3><a id="test_machine">test_machine / test_all_machines / test_all_extensions</a></h3>
<p>Test whether the given MSX machine configuration works. For example whether you have all required system ROMs for this machine. See also <code><a class="internal" href="#machines">load_machine</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>test_machine <machine-config></code></td>
<td>Test whether the given machine configuration is OK.</td>
</tr>
</table>
<p>Use the convenience commands <code>test_all_machines</code> and <code>test_all_extensions</code> to get a full overview on which system ROMs you are still missing.</p>
<h3><a id="toggle">toggle</a></h3>
<p>Toggles any boolean (on/off) setting: if it was on, it will be turned off and vice versa.
See also: <code><a class="internal" href="#cycle">cycle</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>toggle <setting></code></td>
<td>Toggles the specified setting</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>toggle mute</code><br />
<code>toggle throttle</code>
</div>
<h3><a id="trainer">trainer</a></h3>
<p>Control game trainers. You can enable or disable individual cheats of each trainer. Make use of the TAB key to see
what is available. When switching trainers, the currently active trainer will be deactivated.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>trainer</code></td>
<td>See which trainer is currently active</td>
</tr>
<tr>
<td><code>trainer <game></code></td>
<td>See which cheats are currently active in the trainer</td>
</tr>
<tr>
<td><code>trainer <game> all</code></td>
<td>Activate all cheats in the trainer of <game></td>
</tr>
<tr>
<td><code>trainer <game> \[<cheat> ..\]</code></td>
<td>Toggle cheats of <game> on/off</td>
</tr>
<tr>
<td><code>trainer deactivate</code></td>
<td>Deactivate all trainers</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>trainer Frogger all</code><br />
<code>trainer "Circus Charlie" 1 2</code><br />
<code>trainer Pippols lives "jump shoes"</code>
</div>
<h3><a id="type">type / type_via_keyboard</a></h3>
<p>Type a string in the emulated MSX. This command automatically presses and
releases keys in the simulated MSX keyboard matrix. This command is useful
for demoing and for automating tasks in MSX-BASIC.</p>
<p>The command has a <code>-release</code> option, with which you can specify
that keys are always released before new ones are pressed. Some game input
routines need this, but it also makes typing twice as slow.</p>
<p>With the <code>-freq</code> option, you can tweak how fast typing goes and
how long the keys will be pressed (and released if the <code>-release</code>
option is used). Keys will be typed at the given frequency and will remain
pressed/released for 1/freq seconds.</p>
<p>This command should always work, because it is just like as if a user was
actually typing on the MSX keyboard. It is therefore a bit slow, though.
Check out the <code>type_via_keybuf</code> command if you're looking for
something faster (but more limited in where it works). With the
<code>default_type_proc</code> setting you can even make
<code>type_via_keybuf</code> the standard implementation for the
<code>type</code> command. Only do this if you really know what you're
doing!</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>type "Hello world!"</code></td>
<td>Yet another manifestation of the most famous program</td>
</tr>
<tr>
<td><code>type "PRINT \"Hi!\"\r"</code></td>
<td>Executes this basic command directly</td>
</tr>
</table>
<p>There are also a few scripts extending this command:</p>
<table>
<tr>
<td><code>type_from_file</code></td>
<td>With this command you can automatically type text which is stored in
the given (text) file. Mostly useful if you want to type in some
BASIC program fragment that you found somewhere and pasted in a
text file.
</td>
</tr>
<tr>
<td><code>type_password_from_file</code></td>
<td>A special version of <code>type_from_file</code>, made to type in
passwords of games, which you have stored in a file. The text
file should have a special format: one password per line, lines
starting with # are ignored. After the filename, you can give the
index of the password to type (which is the index of the first
non-comment and non-blank line in the file).
</td>
</tr>
</table>
<h3><a id="unset">unset</a></h3>
<p>Undefines a Tcl variable. When used on openMSX settings, they are reverted to their default value. See also: <code><a class="internal" href="#set">set</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>unset <variable></code></td>
<td>Undefines the given variable</td>
</tr>
<tr>
<td><code>unset <setting></code></td>
<td>Reverts the given setting to its default value</td>
</tr>
</table>
<h3><a id="user_setting">user_setting</a></h3>
<p>This command is only meant to be used in Tcl scripts. It allows to create Tcl variables that act very much like built-in openMSX settings. They have a description (can be queried with "<code>help set <setting-name></code>") and their value is stored saved/restored when openMSX is quit/restarted.</p>
<!-- do we really have to repeat the help text from the openmsx source code here? -->
<p>Execute "<code>help user_setting</code>" to get a detailed description of this command.</p>
<h3><a id="vdpregs">vdpregs</a></h3>
<p>Shows the current register settings of the Video Display Processor (VDP). Related command: <code><a class="internal" href="#palette">palette</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>vdpregs</code></td>
<td>Shows the current VDP control register contents</td>
</tr>
</table>
<h3><a id="other">other</a></h3>
<p>Most commands described above are generally useful. openMSX also has a bunch of other more specialized commands. Some of these are intended for programmers who code MSX programs using openMSX as a tool. Other of these commands are more like toys or examples that show the openMSX scripting capabilities.</p>
<p>We've only listed a very brief overview of these commands. As always execute "<code>help <command-name></code>" to get a more detailed description of the command.</p>
<table>
<tr>
<td><code>about</code></td>
<td>Search command and setting help-texts for the given keyword</td>
</tr>
<tr>
<td><code>cpuregs</code></td>
<td>Gives an overview of the CPU registers</td>
</tr>
<tr>
<td><code>data_file</code></td>
<td>Helps locate openMSX data files</td>
</tr>
<tr>
<td><code>disasm</code></td>
<td>Print disassembled instructions at the given memory location</td>
</tr>
<tr>
<td><code>getcolor</code></td>
<td>Query V99x8 palette settings</td>
</tr>
<tr>
<td><code>get_active_cpu</code></td>
<td>Returns the active cpu, z80 or r800</td>
</tr>
<tr>
<td><code>get_color_count</code></td>
<td>Gives an overview of the used colors in the current screen</td>
</tr>
<tr>
<td><code>get_screen</code></td>
<td>Capture the content of a MSX text screen in a Tcl string</td>
</tr>
<tr>
<td><code>get_screen_mode</code></td>
<td>Decodes the current screen mode from the VDP registers and returns it as a Tcl string. <code>get_screen_mode_number</code> returns it as a number which would also be used for the basic command <code>SCREEN</code>.</td>
</tr>
<tr>
<td><code>get_selected_slot</code></td>
<td>Returns the selected slot for the given memory page</td>
</tr>
<tr>
<td><code>guess_title</code></td>
<td>Use heuristics to guess the title of the current game (cartridge, disk or tape). For specific media use <code>guess_cassette_title</code>, <code>guess_disk_title</code> or <code>guess_rom_title</code>.</td>
</tr>
<tr>
<td><code>listing</code></td>
<td>Reimplementation of the BASIC LIST command in Tcl</td>
</tr>
<tr>
<td><code>load_debuggable</code></td>
<td>Write the content of a file to a openMSX debuggable</td>
</tr>
<tr>
<td><code>main_menu_open</code> / <code>main_menu_close</code> / <code>main_menu_toggle</code></td>
<td>Control the visibility of the default OSD menu</td>
</tr>
<tr>
<td><code>multi_screenshot</code></td>
<td>Take screenshots of multiple successive frames</td>
</tr>
<tr>
<td><code>pc_in_slot</code></td>
<td>Check whether CPU is executing from the specified slot (useful as breakpoint condition)</td>
</tr>
<tr>
<td><code>peek</code></td>
<td>Read a byte from the given memory location</td>
</tr>
<tr>
<td><code>peek16</code></td>
<td>Read a 16 bit word from the given memory location</td>
</tr>
<tr>
<td><code>poke</code></td>
<td>Write a byte to the given memory location. Use <code>dpoke</code> to only write if the to be written value is different from the current value.</td>
</tr>
<tr>
<td><code>poke16</code></td>
<td>Write a 16 bit word to the given memory location</td>
</tr>
<tr>
<td><code>psg_log</code></td>
<td>Log or replay PSG register values in binary format</td>
</tr>
<tr>
<td><code>ram_watch</code></td>
<td>Add or remove RAM watch addresses to/from the list on the right side of the screen, useful for debugging or TASing</td>
</tr>
<tr>
<td><code>reg</code></td>
<td>Read or write CPU registers</td>
</tr>
<tr>
<td><code>reg_log</code></td>
<td>Log or replay register values for the specified debuggable in ASCII format</td>
</tr>
<tr>
<td><code>rom_info</code></td>
<td>Gives information about the given ROM device, coming from the software database. If no argument is given, the first found (external) ROM device is assumed. This command replaces the info that was previously (before openMSX 0.8.1) automatically printed on stdout.</td>
</tr>
<tr>
<td><code>run_to</code></td>
<td>Execute instructions until the PC reaches the specified address</td>
</tr>
<tr>
<td><code>save_debuggable</code></td>
<td>Save the (partial) content of a debuggable to a file</td>
</tr>
<tr>
<td><code>save_msx_screen</code></td>
<td>Saves the current MSX screen into an MSX compatible binary file (BLOAD format).</td>
</tr>
<tr>
<td><code>save_to_file</code></td>
<td>Helper function to save data (e.g. the output of another command) to a file.</td>
</tr>
<tr>
<td><code>setcolor</code></td>
<td>Change V99x8 palette settings</td>
</tr>
<tr>
<td><code>set_help_text</code></td>
<td>Associate help text with a Tcl proc</td>
</tr>
<tr>
<td><code>set_tabcompletion_proc</code></td>
<td>Associate tab completion with a Tcl proc</td>
</tr>
<tr>
<td><code>showdebuggable</code></td>
<td>Print the content of a debuggable in a table</td>
</tr>
<tr>
<td><code>showmem</code></td>
<td>Print the content of memory in a table</td>
</tr>
<tr>
<td><code>show_osd</code></td>
<td>Print an overview of the defined OSD elements</td>
</tr>
<tr>
<td><code>skip_instruction</code></td>
<td>Skip the current CPU instruction</td>
</tr>
<tr>
<td><code>sprite_viewer</code></td>
<td>Show a widget with which you can view the sprite patterns</td>
</tr>
<tr>
<td><code>stack</code></td>
<td>Print the top of the CPU stack</td>
</tr>
<tr>
<td><code>step_in</code></td>
<td>Execute one CPU instruction, go into subroutines</td>
</tr>
<tr>
<td><code>step_over</code></td>
<td>Execute one CPU instruction, but don't go into subroutines</td>
</tr>
<tr>
<td><code>step_out</code></td>
<td>Step out of the current subroutine</td>
</tr>
<tr>
<td><code>step_back</code></td>
<td>Step one instruction back in time</td>
</tr>
<tr>
<td><code>text_echo</code></td>
<td>Echo all printed MSX text on stderr</td>
</tr>
<tr>
<td><code>toggle_cursors</code></td>
<td>Show (or hide) a widget which shows which keys are pressed</td>
</tr>
<tr>
<td><code>toggle_fps</code></td>
<td>Show (or hide) a frames-per-second (fps) indicator</td>
</tr>
<tr>
<td><code>toggle_frame_counter</code></td>
<td>Show (or hide) a widget which shows the current frame number since start-up</td>
</tr>
<tr>
<td><code>toggle_freq</code></td>
<td>Switch between PAL/NTSC</td>
</tr>
<tr>
<td><code>toggle_info_panel</code></td>
<td>Show (or hide) a panel with various types of info on the currently running MSX (emulation); similar to the info in the panel you get when using the DIGIblue theme in blueMSX</td>
</tr>
<tr>
<td><code>toggle_mog_overlay</code></td>
<td>Enable (or disable) graphical extra information and game hints when playing The Maze of Galious</td>
</tr>
<tr>
<td><code>toggle_mog_editor</code></td>
<td>Enable (or disable) wall drawing and Popolon-placement with the mouse when playing The Maze of Galious; needs to have the MoG overlay enabled, see <code>toggle_mog_overlay</code></td>
</tr>
<tr>
<td><code>toggle_music_keyboard</code></td>
<td>Enable (or disable) keyboard view of all existing music channels. EXPERIMENTAL! Be careful, it's very slow when many channels are present in the system</td>
</tr>
<tr>
<td><code>toggle_nemesis_1_shield</code></td>
<td>Enable (or disable) an OSD drawn shield in Nemesis (Gradius) 1, all enemy objects will repel from it</td>
</tr>
<tr>
<td><code>toggle_osd_keyboard</code></td>
<td>Show (or hide) an on-screen keyboard (mostly useful for devices without physical keyboard); only supports an international keyboard-layout for now</td>
</tr>
<tr>
<td><code>toggle_psg2scc</code></td>
<td>Enable (or disable) playing PSG sound on SCC</td>
</tr>
<tr>
<td><code>toggle_reversebar</code></td>
<td>Show (or hide) the reverse bar, which helps to control and view the data of the <a class="internal" href="#reverse">reverse</a> feature, which is automatically enabled when the bar is enabled</td>
</tr>
<tr>
<td><code>toggle_scc_editor</code></td>
<td>Show a graphical view of the SCC chip(s) of the system, showing waveforms and volume per channel and also enables you to edit the waveforms per channel</td>
</tr>
<tr>
<td><code>toggle_scc_viewer</code></td>
<td>Show a graphical view of the SCC chip(s) of the system, showing waveforms and volume per channel</td>
</tr>
<tr>
<td><code>toggle_show_palette</code></td>
<td>Show (or hide) a graphical view on the palette registers</td>
</tr>
<tr>
<td><code>toggle_tron</code></td>
<td>Show (or hide) an OSD implementation of the MSX-BASIC TRON command to trace what the current line number of the BASIC interpreter is</td>
</tr>
<tr>
<td><code>toggle_vdp_access_test</code></td>
<td>Enable (or disable) reporting in the console when VDP I/O is done which could possibly cause data corruption on the slowest VDP (TMS9xxx), which is not emulated</td>
</tr>
<tr>
<td><code>toggle_vdp_busy</code></td>
<td>Enable (or disable) display on the OSD how busy the VDP is</td>
</tr>
<tr>
<td><code>toggle_vdp_reg_viewer</code></td>
<td>Enable (or disable) a widget that shows an overview of all VDP registers and highlights changes in the values</td>
</tr>
<tr>
<td><code>toggle_vu_meters</code></td>
<td>Show (or hide) a graphical view of the volumes of the sound channels of several sound chips</td>
</tr>
<tr>
<td><code>type_via_keybuf</code></td>
<td>Alternative to the <code>type_via_keyboard</code> (the default <code><a class="internal" href="#type">type</a></code> command), that uses the keyboard buffer; only works if the running software uses the standard keyboard buffer functions to get keyboard input, but is much faster</td>
</tr>
<tr>
<td><code>umrcallback</code></td>
<td>Example proc to use with the umr_callback setting</td>
</tr>
<tr>
<td><code>vdpcmdinprogresscallback</code></td>
<td>Example proc to use with the vdpcmdinprogress_callback setting</td>
</tr>
<tr>
<td><code>v9990reg</code></td>
<td>Read or write a V9990 register</td>
</tr>
<tr>
<td><code>v9990regs</code></td>
<td>Print an overview of all V9990 registers</td>
</tr>
<tr>
<td><code>vdpreg</code></td>
<td>Read or write a V99x8 register</td>
</tr>
<tr>
<td><code>vdrive</code></td>
<td>Easily switch disks in multi-disk games</td>
</tr>
<tr>
<td><code>vgm_rec</code></td>
<td>Record the music played by PSG, MSX-MUSIC, MSX-AUDIO, OPL4 and SCC into a VGM file</td>
</tr>
<tr>
<td><code>vpeek/vpoke</code></td>
<td>Read/write bytes from/to video RAM</td>
</tr>
</table>
<p>The source code of all these scripts is located in <code>share/scripts</code> directory. Feel free to inspect these scripts and modify them to suit your needs.</p>
<h2><a id="settings">Settings</a></h2>
<p>Settings control many aspects of openMSX. Below, the available settings are listed and described. You can change setting values with the <code><a class="internal" href="#set">set</a></code> command.</p>
<h3><a id="accuracy">accuracy</a></h3>
<p>Sets the render accuracy. openMSX supports three levels of render accuracy:</p>
<dl>
<dt>screen accurate:</dt>
<dd>Changes in VDP state become effective only once per video frame. Works well for most MSX1 software, but will break a lot of MSX2 software (anything that does so-called raster effects).</dd>
<dt>line accurate:</dt>
<dd>Changes in VDP state become effective only once per display line. Works well for almost all software.</dd>
<dt>pixel accurate:</dt>
<dd>Changes in VDP state become effective immediately. In this mode even the 'Unknown Reality scope part' is rendered correctly.</dd>
</dl>
<p>In some cases switching to a lower accuracy level can speed up emulation, but in many cases the speed difference is negligible.</p>
<p>The default is pixel accuracy, since this is the most realistic. If the software you are running shows a jittery screen split and you would prefer a stable screen split, switching to line accuracy can help.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set accuracy</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set accuracy screen</code></td>
<td>Selects screen accurate rendering</td>
</tr>
<tr>
<td><code>set accuracy line</code></td>
<td>Selects line accurate rendering</td>
</tr>
<tr>
<td><code>set accuracy pixel</code></td>
<td>Selects pixel accurate rendering</td>
</tr>
</table>
<h3><a id="audio-inputfilename">audio-inputfilename</a></h3>
<p>Sets the audio file from which the wave input is read for the sampler.</p>
<p>By default, it is read from "audio-input.wav" when available.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set audio-inputfilename</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set audio-inputfilename mysample.wav</code></td>
<td>Read from "mysample.wav"</td>
</tr>
</table>
<div class="note">
Note: The file is fully read into memory, so under Linux/UNIX do not attempt to read from a device node such as <code>/dev/dsp</code>.
</div>
<h3><a id="autoruncassettes">autoruncassettes</a></h3>
<p>Switches the "auto-run cassettes" feature on or off. When it's enabled, openMSX will try to type the proper loading
instruction when a cassette is inserted.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set autoruncassettes</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set autoruncassettes on</code></td>
<td>Try to run cassettes automatically</td>
</tr>
<tr>
<td><code>set autoruncassettes off</code></td>
<td>Do nothing when cassettes are inserted</td>
</tr>
</table>
<div class="note">
Note: Autorun is only supported for cassette images in the CAS format.
</div>
<h3><a id="autorunlaserdisc">autorunlaserdisc</a></h3>
<p>Switches the "auto-run laserdisc" feature on or off. When it's enabled, openMSX will try to type the proper loading
instruction when a laserdisc is inserted.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set autorunlaserdisc</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set autorunlaserdisc on</code></td>
<td>Try to load Laserdiscs automatically</td>
</tr>
<tr>
<td><code>set autorunlaserdisc off</code></td>
<td>Do nothing when Laserdiscs are inserted</td>
</tr>
</table>
<h3><a id="auto_enable_reverse">auto_enable_reverse</a></h3>
<p>Using the <code><a class="internal" href="#reverse">reverse</a></code> feature has a small memory and performance cost. Therefore it has to be enabled before it can be used. This setting controls whether the reverse feature should automatically be activated when openMSX starts. On desktop computers this generally won't be a problem. But for small handheld devices it can be.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set auto_enable_reverse</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set auto_enable_reverse off</code></td>
<td>Don't automatically enable the reverse feature</td>
</tr>
<tr>
<td><code>set auto_enable_reverse on</code></td>
<td>Enable the reverse feature when openMSX starts</td>
</tr>
<tr>
<td><code>set auto_enable_reverse gui</code></td>
<td>Enable the reverse feature and the reverse bar when openMSX starts</td>
</tr>
</table>
<h3><a id="auto_save_replay">auto_save_replay</a></h3>
<p>Enable this setting to make automatic backups of your current replay. The replay is saved to the filename specified in the <code>auto_save_replay_filename</code> setting (default: "auto_save") at an interval as specified by the <code>auto_save_replay_interval</code> setting (default: 30 seconds). The interval is in real clock time, not in MSX time.</p>
<h3><a id="blur">blur</a></h3>
<p>Sets the amount of horizontal blur effect. A value of 0 turns off blur, while 100 selects maximum blur.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set blur</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set blur <value></code></td>
<td>Change the value</td>
</tr>
</table>
<div class="note">
Note: Only some <a class="internal" href="#scale_algorithm">scale algorithms</a> apply horizontal blur; the default algorithm "simple" does.
</div>
<h3><a id="bootsector">bootsector</a></h3>
<p>Sets the boot sector type for DirAsDSK. Default: DOS2. Only relevant on turboR, because it boots differently
depending on the type of boot sector on the disk in drive A.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set bootsector</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set bootsector DOS1</code></td>
<td>Use a DOS1 boot sector</td>
</tr>
</table>
<h3><a id="brightness">brightness</a></h3>
<p>Controls the brightness of the video output. Can be between -100 and 100. Lower values are darker, higher values are brighter. The default is 0, which is neutral. This setting shifts the brightness of all colors, including black and white, while the <code><a class="internal" href="#gamma">gamma</a></code> setting changes the relative brightness of colors but does not change black and white.</p>
<p>The section about the <code><a class="internal" href="#noise">noise</a></code> setting describes a typical way of using <code>brightness</code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set brightness</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set brightness 5</code></td>
<td>Make the video output a bit brighter than default</td>
</tr>
</table>
<h3><a id="cmdtiming">cmdtiming</a></h3>
<p>Controls VDP command execution timing.</p>
<p>This is useful for debugging and for speeding up games where the command engine performance is a bottleneck.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set cmdtiming</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set cmdtiming broken</code></td>
<td>Make VDP commands finish instantly</td>
</tr>
<tr>
<td><code>set cmdtiming real</code></td>
<td>Make VDP commands take a realistic amount of time</td>
</tr>
</table>
<div class="note">
Note: When set to <code>broken</code> the emulated MSX acts different from a real MSX. This might cause some software to fail.
</div>
<h3><a id="color_matrix">color_matrix</a></h3>
<p>This setting represents a 3×3 matrix that is used to transform MSX RGB colors to host RGB colors. This setting can
be used to generate all kind of color schemes, see <code>scripts/monitor.tcl</code> for examples.</p>
<p>To get the following color transformation:</p>
<pre>
| a b c | | Rm | | Rh |
| d e f | × | Gm | = | Gh |
| g h i | | Bm | | Bh |
</pre>
<p>Use this command:</p>
<pre>
set color_matrix { { a b c } { d e f } { g h i } }
</pre>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set color_matrix</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set color_matrix { { 1 0 0 } { 0 1 0 } { 0 0 1 } }</code></td>
<td>This is the default (no color transformation)</td>
</tr>
<tr>
<td><code>set color_matrix { { .33 .33 .33 } { .33 .33 .33 } { .33 .33 .33 } }</code></td>
<td>Transform to grey scale</td>
</tr>
</table>
<div class="note">
Note: It is often more convenient to use the <code><a class="internal" href="#monitor_type">monitor_type</a></code> command.
</div>
<h3><a id="console">console</a></h3>
<p>Turns the openMSX on-screen console on or off.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set console</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set console on</code></td>
<td>Turns the console on</td>
</tr>
<tr>
<td><code>set console off</code></td>
<td>Turns the console off</td>
</tr>
</table>
<h3><a id="consolebackground">consolebackground</a></h3>
<p>Change the console background image. Only images in the PNG format are supported. Background images may also have an alpha channel (amount of transparency per pixel).</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set consolebackground</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set consolebackground <image></code></td>
<td>Sets a new background image</td>
</tr>
</table>
<h3><a id="consolecolumns">consolecolumns</a></h3>
<p>Change the width of the console measured by the number of columns.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set consolecolumns</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set consolecolumns <value></code></td>
<td>Set the specified width</td>
</tr>
</table>
<h3><a id="consolefont">consolefont</a></h3>
<p>Change the console font. This should be the filename of a True Type Font. The default value is <code>/usr/share/fonts/truetype/ttf-bitstream-vera/VeraMono.ttf</code>.</p>
<p>Font files of other types than True Type Fonts (TTF) are not supported. The font must also be monospaced.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set consolefont</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set consolefont <myfont.ttf></code></td>
<td>Sets a new font</td>
</tr>
</table>
<h3><a id="consolefontsize">consolefontsize</a></h3>
<p>Set the size for the console font. The default value is 12.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set consolefontsize</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set consolefontsize 16</code></td>
<td>Set a bigger than default font size</td>
</tr>
</table>
<h3><a id="console_history_size">console_history_size</a></h3>
<p>Determines how many commands are saved into the console history.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set console_history_size</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set console_history_size 5000</code></td>
<td>Keep a maximum of 5000 commands in the console history</td>
</tr>
</table>
<h3><a id="consoleplacement">consoleplacement</a></h3>
<p>Changes the position of the console on the emulator screen.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set consoleplacement</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set consoleplacement <place></code></td>
<td>Moves the console to the specified location; <code><place></code> can be <code>topleft</code>, <code>top</code>, <code>topright</code>, <code>left</code>, <code>center</code>, <code>right</code>, <code>bottomleft</code>, <code>bottom</code> or <code>bottomright</code>.</td>
</tr>
</table>
<h3><a id="consolerows">consolerows</a></h3>
<p>Change the height of the console measured by the number of rows.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set consolerows</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set consolerows <value></code></td>
<td>Set the specified number of rows</td>
</tr>
</table>
<h3><a id="console_remove_doubles">console_remove_doubles</a></h3>
<p>Determines whether the console history remembers two identical subsequent commands.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set console_remove_doubles</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set console_remove_doubles on</code></td>
<td>Remove (do not remember) the last command if it's the same as the previous (default)</td>
</tr>
<tr>
<td><code>set console_remove_doubles off</code></td>
<td>Allow double subsequent command entries in the console history</td>
</tr>
</table>
<h3><a id="contrast">contrast</a></h3>
<p>Controls the contrast of the video output. Can be between -100 and 100. Lower values are less contrast, higher values are more contrast. The default is 0, which is neutral.</p>
<p>The section about the <code><a class="internal" href="#noise">noise</a></code> setting describes a typical way of using <code>contrast</code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set contrast</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set contrast -5</code></td>
<td>Reduce the video contrast a bit</td>
</tr>
</table>
<h3><a id="cputrace">cputrace</a></h3>
<p>Enable/disable CPU instruction tracing. When enabled, the state of the CPU (Z80/R800) is printed on stdout after every instruction. This creates a lot of output and slows down emulation considerably, but it can be very useful for debugging.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set cputrace</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set cputrace on</code></td>
<td>Enables CPU tracing</td>
</tr>
<tr>
<td><code>set cputrace off</code></td>
<td>Disables CPU tracing</td>
</tr>
</table>
<h3><a id="debugoutput">debugoutput</a></h3>
<p>Selects the file to where the output from the debug device goes.</p>
<p>The User's Manual <a class="external" href="user.html#debugdevice">describes the debug device</a> in more detail.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set debugoutput</code></td>
<td>Shows the current output file name</td>
</tr>
<tr>
<td><code>set debugoutput stdout</code></td>
<td>Writes debug output to openMSX's standard output stream</td>
</tr>
<tr>
<td><code>set debugoutput stderr</code></td>
<td>Writes debug output to openMSX's standard error stream</td>
</tr>
<tr>
<td><code>set debugoutput <output file></code></td>
<td>Writes debug output to the specified file</td>
</tr>
</table>
<div class="note">
Note: This setting only exists if the <code>debugdevice</code> extension is present in the current MSX machine.
</div>
<h3><a id="default_machine">default_machine</a></h3>
<p>Selects the default MSX model. openMSX uses this machine when it is started without the <code>-machine</code> option. This is a typical setting that should be saved, see also <a class="internal" href="#save_settings"><code>save_settings</code></a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set default_machine</code></td>
<td>Shows current setting</td>
</tr>
<tr>
<td><code>set default_machine Panasonic_FS-A1GT</code></td>
<td>Use the turboR GT the next time openMSX is started</td>
</tr>
</table>
<h3><a id="DirAsDSKmode">DirAsDSKmode</a></h3>
<p>Determine the behavior of the DirAsDSK when inserting a directory to be used as diskimage.</p>
<p>The possible values are <code>read_only</code> and <code>full</code>. The default mode is <code>full</code>.</p>
<table>
<tr>
<td><code>read_only</code></td>
<td>The MSX can not write to the virtual disk.<br/>Changes on the host-OS are still reflected on the virtual disk, however.</td>
</tr>
<tr>
<td><code>full</code></td>
<td>All changes are performed both ways, no restrictions apply.</td>
</tr>
</table>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set DirAsDSKmode</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set DirAsDSKmode read_only</code></td>
<td>Disk image will be read only</td>
</tr>
</table>
<div class="note">
Note: this setting is only used when the directory is inserted, it is not possible to change the behaviour of the current virtual disk by altering the setting. The new setting will become effective after the current virtual disk has been ejected.
</div>
<h3><a id="deflicker">deflicker</a></h3>
<p>Turns deflicker on/off. deflicker is a filter which tries to detect pixels
that alternate each frame between two different color values and replaces
those alternations with the average color. It gives a very nice result for
software (mostly demos) that use this technique to get the optical illusion
of more colors than are actually supported by the hardware. It also works
well in games with flickering sprites on a static background (like Maze of
Galious). This setting is disabled by default because there aren't that many
situations were it really improves video quality and it does have a
performance cost. </p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set deflicker</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set deflicker on</code></td>
<td>Turns deflicker on</td>
</tr>
<tr>
<td><code>set deflicker off</code></td>
<td>Turns deflicker off</td>
</tr>
</table>
<h3><a id="deinterlace">deinterlace</a></h3>
<p>Turns deinterlacing on/off. Deinterlace is a filter which combines the even and odd field of interlaced video into a single frame which has double vertical resolution. It results in a sharp and stable image, but can show artifacts on fast animations.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set deinterlace</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set deinterlace on</code></td>
<td>Turns deinterlacing on</td>
</tr>
<tr>
<td><code>set deinterlace off</code></td>
<td>Turns deinterlacing off</td>
</tr>
</table>
<div class="note">
Note: Deinterlacing is only supported for <code><a class="internal" href="#scale_factor">scale_factors</a></code> bigger or equal to 2.
</div>
<h3><a id="disablesprites">disablesprites</a></h3>
<p>Can be used to disable sprite rendering. Only the rendering itself is
disabled, all other MSX behaviour (like sprite collision detection) stays
the same.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set disablesprites</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set disablesprites on</code></td>
<td>Disable sprite rendering</td>
</tr>
<tr>
<td><code>set disablesprites off</code></td>
<td>Enable sprite rendering (the default)</td>
</tr>
</table>
<h3><a id="display_deform">display_deform</a></h3>
<p>Select display deformation effect. This effect is only supported in the SDLGL-PP renderer.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set display_deform</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set display_deform normal</code></td>
<td>Turns off display deform</td>
</tr>
<tr>
<td><code>set display_deform 3d</code></td>
<td>Deforms the image in 3D, to look like a CRT (like JEmu2)</td>
</tr>
</table>
<div class="note">
Note: In the past there was also a 'horizontal_stretch' mode. This is now replaced by the <code><a class="internal" href="#horizontal_stretch">horizontal_stretch</a></code> setting.
</div>
<h3><a id="di_halt_callback">di_halt_callback</a></h3>
<p>Selects the Tcl procedure to be called when the running MSX software has executed a HALT instruction while the interrupts are disabled (DI).</p>
<p>The default openmsx startup scripts initialize this setting with a proc that prints a warning message.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set di_halt_callback</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set di_halt_callback my_callback_proc</code></td>
<td>Sets a new callback proc</td>
</tr>
</table>
<h3><a id="enable_session_management">enable_session_management</a></h3>
<p>Controls session management. When enabled, openMSX will store the state of all machines when you exit openMSX and restore that state again when starting it up next time. Note that the reverse history is not saved.
</p>
<p>Sessions can also be saved manually with the command <code>save_session</code>, and explicitly loaded with <code>load_session</code>. A list of saved sessions can be retrieved with <code>list_sessions</code>.
</p>
<h3><a id="frequency">frequency</a></h3>
<p>Sets the sound mixer frequency. Sound hardware and sound APIs typically support a limited set of frequencies, such as 11025 Hz, 22050 Hz, 44100 Hz and 48000 Hz.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set frequency</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set frequency 44100</code></td>
<td>Use 44.1 kHz mixing frequency (CD quality)</td>
</tr>
</table>
<h3><a id="firmwareswitch">firmwareswitch</a></h3>
<p>Some machines (e.g. turboR) have a switch on the front (or on the back) that controls if the machine should boot
'normally' or start the built-in software, also called firmware. This setting controls the position of that
switch.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set firmwareswitch</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set firmwareswitch on</code></td>
<td>Boot into the internal software</td>
</tr>
<tr>
<td><code>set firmwareswitch off</code></td>
<td>Boot into MSX-BASIC or on-disk software</td>
</tr>
</table>
<h3><a id="fullscreen">fullscreen</a></h3>
<p>Switch to/from fullscreen mode.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set fullscreen</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set fullscreen on</code></td>
<td>Switch to fullscreen mode</td>
</tr>
<tr>
<td><code>set fullscreen off</code></td>
<td>Switch to windowed mode</td>
</tr>
</table>
<h3><a id="fullspeedwhenloading">fullspeedwhenloading</a></h3>
<p>When enabled, openMSX will try to detect when the MSX is loading from diskette, cassette or laserdisc. During loading openMSX will run at full speed (<code><a class="internal" href="#throttle">throttle</a></code> off). This can be convenient if you're not interested in the realistic but slow loading times on MSX. Default is off, because it is not according to the behaviour of a real MSX.</p>
<p>Unlike the fast loading features in for example fMSX, <code>fullspeedwhenloading</code> does not intercept BIOS calls. Instead, it speeds up the emulation of the entire MSX, including all hardware devices.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set fullspeedwhenloading</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set fullspeedwhenloading on</code></td>
<td>Load as fast as possible</td>
</tr>
<tr>
<td><code>set fullspeedwhenloading off</code></td>
<td>Load at the same speed as a real MSX</td>
</tr>
</table>
<h3><a id="gamma">gamma</a></h3>
<p>Sets the amount of gamma correction. A value of 1.0 will turn off gamma correction. Lower values will result in a darker image, higher values in a brighter image.</p>
<p>If you want to get a realistic picture, set the openMSX gamma correction to <i>PC gamma / MSX gamma</i>. TVs use a standardised gamma of 2.5, let's take that as the value of <i>MSX gamma</i>. You can measure the gamma of your PC screen with a simple test such as the Gamma Measurement Image in <a class="external" href="https://web.archive.org/web/20150714015749/http://www.bberger.net/rwb/gamma.html">Robert W. Berger's "An Explanation of Monitor Gamma"</a>. If your <i>PC gamma</i> would be for example 2.0, the most realistic value for gamma correction would be 2.0 / 2.5 = 0.8.</p>
<p>Alternatively, you can just try a few values and see what you like.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set gamma</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set gamma <num></code></td>
<td>Sets a new gamma correction amount</td>
</tr>
</table>
<h3><a id="glow">glow</a></h3>
<p>Sets the amount of afterglow effect: 0 is off and 100 is a very heavy afterglow.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set glow</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set glow <value></code></td>
<td>Change the amount of afterglow</td>
</tr>
</table>
<div class="note">
Note: Not all renderers support this.
</div>
<h3><a id="grabinput">grabinput</a></h3>
<p>Controls whether openMSX grabs all input events or not. When this setting is turned on, all input events are directly passed to openMSX. The mouse pointer can't leave the openMSX window and the window manager won't be able to react to keyboard shortcuts.</p>
<p>You can turn this setting on when you want to use mouse-controlled MSX software while openMSX is in windowed mode. It is best turned off in all other cases. See also <a class="internal" href="#escape_grab"><code>escape_grab</code></a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set grabinput</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set grabinput on</code></td>
<td>Starts grabbing all input events</td>
</tr>
<tr>
<td><code>set grabinput off</code></td>
<td>Stops grabbing all input events</td>
</tr>
</table>
<h3><a id="horizontal_stretch">horizontal_stretch</a></h3>
<p>Sets the amount of horizontal stretch, thus also the aspect ratio of the screen. More specifically, a setting of <code>n</code> means stretch the center <code>n</code> MSX pixels to the full width of the host output window (at <code><a class="internal" href="#scale_factor">scale_factor</a></code> 1).</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set horizontal_stretch</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set horizontal_stretch <value></code></td>
<td>Change the amount of horizontal stretch</td>
</tr>
</table>
<div class="subsectiontitle">
examples of typical useful values:
</div>
<div class="examples">
<code>set horizontal_stretch 320</code> (no horizontal stretch)<br />
<code>set horizontal_stretch 272</code> (approach real aspect ratio of MSX screen)<br />
<code>set horizontal_stretch 280</code> (default: show all generated border pixels, so that all border demo effects are still visible)<br />
<code>set horizontal_stretch 256</code> (borders are not visible at all; doesn't work well in combination with set-adjust)
</div>
<div class="note">
Note: when using the SDL renderer, this setting may cause a lot more CPU usage (e.g. on a Dingoo) when not using the value 320.
</div>
<h3><a id="inputdelay">inputdelay</a></h3>
<p>Input events for the MSX machine are delayed by this amount. Increase this value when the MSX machine misses keyboard presses when you type very fast. Decrease this value to reduce the latency between pressing a key on the host machine and seeing it being typed in the MSX machine.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set inputdelay</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set inputdelay <time></code></td>
<td>Sets the input delay to the specified number of seconds</td>
</tr>
</table>
<div class="note">
Note: The default value of 0.0 seconds (no extra delay) should almost
always be OK. It only makes sense to increase this setting if you have
a slow host machine and you're typing text very fast and the emulated
MSX machine misses (some of) the keys you typed.
</div>
<h3><a id="interleave_black_frame">interleave_black_frame</a></h3>
<p>Insert a black frame in between each normal MSX frame. Useful on (100Hz+)
lightboost enabled monitors to reduce motion blur and double frame
artifacts.</p>
<p>Make sure you configure your monitor to use a refresh rate of 100Hz (for a
PAL MSX machine) or to 120Hz (for a NTSC machine). The brightness will
decrease, so adjust the <a class="internal" href="#gamma">gamma</a>,
<a class="internal" href="#brightness">brightness</a> and
<a class="internal" href="#contrast">contrast</a> settings to compensate.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set interleave_black_frame</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set interleave_black_frame true</code></td>
<td>Enable this feature.</td>
</tr>
</table>
<h3><a id="invalid_psg_directions_callback">invalid_psg_directions_callback</a></h3>
<p>Selects the Tcl procedure to be called when the running MSX software has selected invalid PSG port directions (port A should always be set as input).</p>
<p>The default openmsx startup scripts initialize this setting with a proc that prints a warning message just once. Though if you're a developer you may want to change this to always print the warning or automatically break emulation when this happens so you can debug the problem.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set invalid_psg_directions_callback</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set invalid_psg_directions_callback my_callback_proc</code></td>
<td>Sets a new callback proc</td>
</tr>
</table>
<h3><a id="joystickN_config">joystick<n>_config</a></h3>
<p>This setting configures how the buttons/axis of the host joystick(s) are
mapped to the corresponding inputs of the emulated MSX joystick(s). For many
joysticks the initial value of this setting provides an acceptable default
mapping. But depending on your joystick type and taste you may want to tweak
it.</p>
<p>The value of this setting is a Tcl dictionary. This means it's a list of
key/value pairs where each even element is a key and each odd element is the
corresponding value. The keys in this dictionary represent the 6 possible MSX
joystick inputs. Possible key values are <code>LEFT</code>,
<code>RIGHT</code>, <code>UP</code>, <code>DOWN</code>, <code>A</code> and
<code>B</code>. The corresponding dictionary-values are lists of host
joystick inputs. Possible elements for these lists are
<code>button<n></code>, <code>+axis<n></code>,
<code>-axis<n></code> and <code>{L,R,U,D}_hat<n></code>.</p>
<p>Let's explain this with an example. The following is the default value for
this setting:<br/>
<code>LEFT -axis0 RIGHT +axis0 UP -axis1 DOWN +axis1 A {button0 button2} B {button1 button3}</code><br/>
Axis 0 is usually the primary X-axis of the host joystick. When that axis is
moved towards negative values the LEFT input switch on the emulated joystick
is activated. When it is moved towards positive values the RIGHT MSX input
switch is activated. Similarly host axis1 is mapped to the UP and DOWN MSX
inputs. The (default) configuration for the buttons is slightly more
complicated. Here both host button 0 and 2 will activate MSX button A, and
both button 1 and 3 will activate MSX button B. (This example shows a host
joystick with 4 buttons, but in general (by default) all even host buttons
will active MSX button A and all odd host buttons will active MSX button
B).</p>
<p>There are no restrictions on the possible mappings. For example it is
allowed to map host axis/buttons to MSX buttons/axis or vice-versa. This
allows to for example map a host joypad (which acts like 4 buttons) to the
MSX directional inputs. (Technically speaking the MSX axis inputs LEFT,
RIGHT, UP and DOWN are just 4 input switches, just like the buttons A and B
are just 2 input switches). It's also allowed to map the same host action to
multiple MSX inputs. This allows to for example make one specific host button
press both MSX buttons simultaneously (e.g. to have a 'crouch button' in
Metal Gear).</p>
<p>It is possible to set this setting directly using the <code>set</code>
command, but often using the Tcl <code>dict</code> command is more
convenient. See below for some examples.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set joystick1_config</code></td>
<td>Shows the current configuration of the first joystick</td>
</tr>
<tr>
<td><code>dict set joystick1_config A button5</code></td>
<td>(Re)map MSX button A to (only) host button 5. Leave the mapping of the
other MSX inputs unchanged.</td>
</tr>
<tr>
<td><code>dict set joystick1_config A {button0 button2}<br/>
dict set joystick1_config B {button1 button2}</code></td>
<td>Map button 0 to A, 1 to B and 2 to A+B. So pressing host button 2
will press both MSX buttons.</td>
</tr>
<tr>
<td><code>dict set joystick1_config LEFT {-axis0 -axis2 button10}<br/>
dict set joystick1_config RIGHT {+axis0 +axis2 button11}<br/>
dict set joystick1_config UP {-axis1 -axis3 button12}<br/>
dict set joystick1_config DOWN {+axis1 +axis3 button13}</code></td>
<td>Map 2 pairs of axis and 1 keypad (4 buttons) to the MSX direction inputs.</td>
</tr>
<tr>
<td><code>dict lappend joystick1_config LEFT L_hat0<br/>
dict lappend joystick1_config RIGHT R_hat0<br/>
dict lappend joystick1_config UP U_hat0<br/>
dict lappend joystick1_config DOWN D_hat0</code></td>
<td>Additionally map hat0 to the 4 MSX directions.</td>
</tr>
</table>
<h3><a id="joystickN_deadzone">joystick<n>_deadzone</a></h3>
<p>This setting configures how big the dead center zone of an (analogue)
joystick is. This is expressed as a percentage: 0 means no dead zone, 100
means everything falls inside the dead zone.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set joystick1_deadzone</code></td>
<td>Shows the current size of the dead zone of the first joystick</td>
</tr>
<tr>
<td><code>set joystick1_deadzone 25</code></td>
<td>Set the size of the dead zone to ¼ of the total range</td>
</tr>
</table>
<h3><a id="kbd_auto_toggle_code_kana_lock">kbd_auto_toggle_code_kana_lock</a></h3>
<p>Switches the "Automatically toggle the CODE/KANA lock" feature on or off. When it's on, openMSX will
automatically toggle the CODE/KANA lock when a user enters a character for which the CODE/KANA lock
state must be changed.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_auto_toggle_code_kana_lock</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_auto_toggle_code_kana_lock on</code></td>
<td>Automatically toggle the CODE/KANA lock when required</td>
</tr>
<tr>
<td><code>set kbd_auto_toggle_code_kana_lock off</code></td>
<td>Only toggle CODE/KANA lock status when user presses the CODE/KANA lock key</td>
</tr>
</table>
<div class="note">
Note: This only works on MSX models for which the CODE/KANA key locks (e.g. Japanese MSX models and the Philips VG8010). On other models, this setting is ignored.
</div>
<h3><a id="kbd_code_kana_host_key">kbd_code_kana_host_key</a></h3>
<p>Host key that maps to the MSX CODE/KANA key. By default right-ALT (RALT) key.</p>
<p>It is especially useful for
people with AZERTY host keyboard, on which the RALT key has a special function; on
azerty keyboards it is called the ALT-GR key and not the right-ALT key and it's used to
enter some special characters (some keys are tagged with 3 characters; normal, key+SHIFT, key+ALT-GR).</p>
<p>It is also useful for people with a Japanese (jp106) keyboard; they can map the HENKAN_MODE key (which is similar to the KANA Lock on Japanese MSX models) to the CODE/KANA key.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_code_kana_host_key</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_code_kana_host_key MENU</code></td>
<td>Binds the <a class="external" href="http://en.wikipedia.org/wiki/Menu_key">MENU key</a> on the host keyboard to the MSX CODE/KANA key</td>
</tr>
<tr>
<td><code>set kbd_code_kana_host_key HENKAN_MODE</code></td>
<td>Binds the HENKAN_MODE key on the host keyboard to the MSX CODE/KANA key</td>
</tr>
</table>
<h3><a id="kbd_deadkey1_host_key">kbd_deadkey1_host_key</a></h3>
<p>Host key that maps to the (1st) dead key. By default right-CTRL (RCTRL) key.</p>
<p>Some MSX models have one dead key that can be used to enter accented charachters. For example the MSX
models sold in the Netherlands have a dead key that has following four accents printed on it: ` ´ ^ ¨.
On the other hand, the Brazilian Gradiente Expert XP-800 has following four accents on its
dead key: ` ´ ^ <sup>~</sup>.</p>
<p>There are also some MSX models with multiple dead keys like for example the Brazilian Gradiente Expert Plus,
which has two dead keys and the different Sharp Hotbit models that have three dead keys. On such machines,
this setting is for the first dead key which can be used to enter following two accents: ´ `.</p>
<p>In order to enter an accented character on the MSX, you first have to press and release the dead key, optionally
together with SHIFT, CODE or CODE+SHIFT and then the correct character. The combination with CODE or CODE+SHIFT is
only relevant for the MSX models with a single dead key that can be used to enter four different accents.</p>
<p>Following table shows for example how to
enter respectively ù, ú, û or ü on the MSX models sold in the Netherlands:</p>
<table>
<tr><th>Key presses</th><th>Charachter</th></tr>
<tr><td>DEAD_KEY1 followed by u</td><td>ù</td></tr>
<tr><td>DEAD_KEY1+SHIFT followed by u</td><td>ú</td></tr>
<tr><td>DEAD_KEY1+CODE followed by u</td><td>û</td></tr>
<tr><td>DEAD_KEY1+SHIFT+CODE followed by u</td><td>ü</td></tr>
</table>
<p>In order to use the dead key in openMSX, you must map an appropriate host key to the DEAD_KEY1 of the MSX and
another one to the CODE key of the MSX with respectively this <code>kbd_deadkey1_host_key</code> setting and the above
documented <code><a class="internal" href="#kbd_code_kana_host_key">kbd_code_kana_host_key</a></code> setting.</p>
<p>Note that especially the last key combination (DEAD_KEY1+SHIFT+CODE) can be impossible to enter on some
host systems; depending on the host operating system, keyboard type and keyboard driver it may be impossible
for the host system to send a combination of three keys at once to an application like openMSX. Unfortunately
openMSX or its developers can't do anything about that.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_deadkey1_host_key</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_deadkey1_host_key PAGEUP</code></td>
<td>Binds the PAGEUP key on the host keyboard to the 1st dead key</td>
</tr>
</table>
<p>Note that to use for example PAGEUP as 1st dead key you will have to unbind it from the <code>go_back_one_step</code>
command in the console; by default openMSX has bound the PAGEUP key to the <code>go_back_one_step</code> command and such
a binding takes precedence over keyboard mappings, so if you want to use PAGEUP as the 1st dead key you will have
to enter following additional command in the console: <code>unbind PAGEUP</code>.</p>
<h3><a id="kbd_deadkey2_host_key">kbd_deadkey2_host_key</a></h3>
<p>Host key that maps to the 2nd dead key. By default Page Up (PAGEUP) key.</p>
<p>This is only applicable to MSX models that have at least two dead keys, like the Brazilian Hotbit models
or the Brazilian Gradiente Expert Plus or other Gradiente models with Gradiente basic version 1.1.</p>
<p>On the Hotbit models, the second dead key can be used to enter accent ¨ while on the Gradiente 1.1
models, the second dead key can be used to enter following accents: <sup>~</sup> ^.</p>
<p>It can be used in the same manner as the first dead key, explained in previous section.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_deadkey2_host_key</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_deadkey2_host_key PAGEDOWN</code></td>
<td>Binds the PAGEDOWN key on the host keyboard to the 2nd dead key</td>
</tr>
</table>
<p>Note that to use for example PAGEUP or PAGEDOWN as a dead key you will have to unbind them from the
default functions in openMSX using the console; by default openMSX has bound the PAGEUP key to the
<code>go_back_one_step</code> command and the PAGEDOWN key to the <code>go_forward_one_step</code> command. Such a binding
takes precedence over keyboard mappings, so if you want to use PAGEUP or PAGEDOWN as the second dead key
you will have to enter following additional commands in the console: <code>unbind PAGEUP</code> or
<code>unbind PAGEDOWN</code>.</p>
<h3><a id="kbd_deadkey3_host_key">kbd_deadkey3_host_key</a></h3>
<p>Host key that maps to the 3rd dead key. By default Page Down (PAGEDOWN) key.</p>
<p>This is only applicable to MSX models with at least three dead keys, like the Sharp Hotbit models.</p>
<p>On the Hotbit models, the third dead key can be used to enter following two accents: <sup>~</sup> ^.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_deadkey3_host_key</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_deadkey3_host_key RCTRL</code></td>
<td>Binds the Right CTRL (RCTRL) key on the host keyboard to the 3rd dead key</td>
</tr>
</table>
<p>Note that to use for example PAGEDOWN (default setting!) as the 3rd dead key you will have to unbind
it from the <code>go_forward_one_step</code> command in openMSX using the console; by default openMSX has bound
the PAGEUP key to the <code>go_back_one_step</code> command. It is a very useful setting for many openMSX users when
playing games but unfortunately it conflicts with the default set-up for the third dead key. Such a command
binding takes precedence over keyboard mappings, so if you want to use PAGEDOWN as the third dead key you
will have to enter following additional command in the console: <code>unbind PAGEDOWN</code>.</p>
<h3><a id="kbd_mapping_mode">kbd_mapping_mode</a></h3>
<p>The keyboard driver can work in two mapping modes; KEY mapping and CHARACTER mapping.</p>
<dl>
<dt>KEY mapping:</dt>
<dd>A key pressed on the host keyboard maps to one specific key on the MSX keyboard. This mode
is convenient when the host keyboard and the MSX keyboard have the same layout or when working with a program
that directly reads the keyboard matrix and forces the user to enter a certain key combination that can not
be auto-generated in the CHARACTER mapping mode.</dd>
<dt>CHARACTER mapping:</dt>
<dd>A character entered by the user is mapped to the correct key combination on the MSX to
enter that character. For example, when the user enters an ! character and openMSX is emulating an 'international'
MSX model, the keyboard driver will press SHIFT and 1 on the MSX keyboard. This will be done regardless of the key
or keys that the user pressed on the host keyboard to enter the ! character.<br/>
This is especially useful when the user has an AZERTY host keyboard and is working on a QWERTY style MSX or
when he has a US-QWERTY keyboard and is working on a Japanese MSX.<br/>
Note that special keys (like CAPSLOCK) are mapped directly, just like in the KEY mapping mode.</dd>
</dl>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_mapping_mode</code></td>
<td>Shows the current mode</td>
</tr>
<tr>
<td><code>set kbd_mapping_mode CHARACTER</code></td>
<td>Set the CHARACTER mapping mode</td>
</tr>
<tr>
<td><code>set kbd_mapping_mode KEY</code></td>
<td>Set the KEY mapping mode</td>
</tr>
</table>
<h3><a id="kbd_numkeypad_always_enabled">kbd_numkeypad_always_enabled</a></h3>
<p>Some real MSX computers do not have a numeric keypad. openMSX will ignore
key presses on the host numeric keypad when emulating such an MSX model.
With this parameter, you can indicate that even on such MSX models, presses
on the host numeric keypad must be mapped to the MSX numeric keypad. So, you
can override accurate behaviour with it, which is the reason that by default,
this setting is set to 'off'.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_numkeypad_always_enabled</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_numkeypad_always_enabled on</code></td>
<td>Enables numeric keypad, even if the emulated MSX does not have one</td>
</tr>
</table>
<h3><a id="kbd_numkeypad_enter_key">kbd_numkeypad_enter_key</a></h3>
<p>There is a subtle difference between numeric keypad of MSX computers and
of most host computers; the MSX computers have a '.' and a ',' on the numeric
keypad. On the other hand, the host computers have a '.' and an 'ENTER' key
on the keypad.</p>
<p>In some respect it is logical that the 'ENTER' key on the host numeric
keypad is mapped to the 'normal' MSX 'ENTER' key. On the other hand, that
would make it impossible to enter the ',' on the MSX numeric keypad.
Therefore, the user can choose whether the host numeric keypad ENTER key
should be mapped to the MSX numeric keypad ',' (which is the default) or to
the main 'ENTER' key.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_numkeypad_enter_key</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set kbd_numkeypad_enter_key ENTER</code></td>
<td>Maps the keypad enter key to the main 'ENTER' key, instead of the comma key on the MSX keypad</td>
</tr>
</table>
<h3><a id="kbd_trace_key_presses">kbd_trace_key_presses</a></h3>
<p>Log SDL key code, SDL modifiers and Unicode value for each key that gets
pressed on the host keyboard on stderr. Also show Unicode value and
corresponding MSX key-presses for characters that get 'pasted' into the MSX
by the console <code><a class="internal" href="#type">type</a></code>
command. This setting is especially useful when defining unicode keymap
files, so that you can find out the unicode values belonging to certain
keys/characters.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set kbd_trace_key_presses</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set kbd_trace_key_presses on</code></td>
<td>Turn logging of key presses on</td>
</tr>
</table>
<h3><a id="keyjoystick_n_button">keyjoystick<n>.<button></a></h3>
<p>Configure the keys of the keyjoysticks. It's likely this will change in the future.</p>
<p>Valid values for <code><n></code>: <code>1</code>, <code>2</code>.</p>
<p>Valid values for <code><button></code>: <code>up</code>, <code>down</code>, <code>left</code>, <code>right</code>, <code>triga</code>, <code>trigb</code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set keyjoystick1.up W</code></td>
</tr>
<tr>
<td><code>set keyjoystick1.down S</code></td>
</tr>
<tr>
<td><code>set keyjoystick1.left A</code></td>
</tr>
<tr>
<td><code>set keyjoystick1.right D</code></td>
</tr>
<tr>
<td><code>set keyjoystick1.triga SPACE</code></td>
</tr>
</table>
<h3><a id="led">led_<name></a></h3>
<p>These are read-only settings. Their value reflects the current status of the corresponding LED on the emulated MSX machine. The currently supported LED names are: <code>power</code>, <code>caps</code>, <code>kana</code>, <code>pause</code>, <code>turbo</code> and <code>FDD</code>.</p>
<p>As for any setting you can use the native <code>trace</code> Tcl command to trigger a callback when the value of these settings changes. (In fact this possibility was the main motivation to make these read-only settings instead of topics of the <code><a class="internal" href="#machine_info">machine_info</a></code> command.)</p>
<h3><a id="limitsprites">limitsprites</a></h3>
<p>Controls whether the VDP has a limit on the number of sprites it can display per line. The default is on, because the real VDP has such a limit. You can turn off the limit to reduce sprite flashing in games such as Aleste. Note that some games (Penguin Adventure, among others) make use of this limitation, so they will display incorrectly if the limit is turned off.</p>
<p>The 5th/9th sprite status flag of the VDP is not influenced by the <code>limitsprites</code> setting: the flag always takes the limit into account.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set limitsprites</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set limitsprites on</code></td>
<td>Limits number of sprites per line</td>
</tr>
<tr>
<td><code>set limitsprites off</code></td>
<td>Turns off number of sprites per line limit</td>
</tr>
</table>
<h3><a id="master_volume">master_volume</a></h3>
<p>Controls the overall openMSX volume. The volume of individual sound devices can be controlled with the <code><a class="internal" href="#soundchip_volume"><soundchip>_volume</a></code> settings.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set master_volume</code></td>
<td>Shows current setting</td>
</tr>
<tr>
<td><code>set master_volume 50</code></td>
<td>Sets master volume to 50%</td>
</tr>
</table>
<h3><a id="maxframeskip">maxframeskip</a></h3>
<p>Sets the maximum amount of frames to skip: show a frame and then skip at most <number> frames. So 0 means show everything (no frame skipping), 1 means show at least every second frame etc.</p>
<p>Frame skipping is done on demand, as a way to keep the flow of time for the emulated MSX in sync with the flow of real time. You can set limits on the amount of frame skipping with the <code><a class="internal" href="#minframeskip">minframeskip</a></code> and <code>maxframeskip</code> setting.</p>
<p>In a situation where the number of consecutive frames specified by <code>maxframeskip</code> has been skipped, openMSX will display the next frame, even if that means emulation will start lagging behind real time.</p>
<p>When <code><a class="internal" href="#throttle">throttle</a></code> is off, the number of skipped frames will be equal to <code>maxframeskip</code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set maxframeskip</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set maxframeskip <number></code></td>
<td>Sets the maximum number of consecutive frame skips</td>
</tr>
</table>
<h3><a id="midi-in-readfilename">midi-in-readfilename</a></h3>
<p>Sets the file from which the MIDI input is read. By default, it is set to <code>/dev/midi</code> when available.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set midi-in-readfilename</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set midi-in-readfilename mymidilog.dat</code></td>
<td>Read MIDI events from "mymidilog.dat"</td>
</tr>
</table>
<h3><a id="midi-out-logfilename">midi-out-logfilename</a></h3>
<p>Sets the file to which the MIDI output is logged. By default, it logs to <code>/dev/midi</code> when available.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set midi-out-logfilename</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set midi-out-logfilename mymidilog.dat</code></td>
<td>Log MIDI events to "mymidilog.dat"</td>
</tr>
</table>
<h3><a id="minframeskip">minframeskip</a></h3>
<p>Sets the minimum amount of frames to skip: show a frame and then skip at least <number> frames.
So 0 means no forced frame skipping, 1 means skip at least every second frame etc.</p>
<p>Frame skipping is done on demand, as a way to keep the flow of time for the emulated MSX in sync with the flow of real time. You can set limits on the amount of frame skipping with the <code>minframeskip</code> and <code><a class="internal" href="#maxframeskip">maxframeskip</a></code> setting.</p>
<p>The <code>minframeskip</code> setting can be useful if you want to ease the burden on your PC processor, for example for longer battery life on a laptop. It can also be useful if your PC is consistently too slow to run without frame skipping: in such cases video might be smoother with a low but constant frame rate than with a fluctuating frame rate.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set minframeskip</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set minframeskip <number></code></td>
<td>Sets the number of frame skips</td>
</tr>
</table>
<h3><a id="mode">mode</a></h3>
<p>Sets the active mode. A mode is a set of settings (mostly key bindings, but also OSD widgets that are activated) that are most suitable for a certain task. Currently only mode 'normal' and 'tas' exist.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set mode</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set mode tas</code></td>
<td>Change mode to TAS mode</td>
</tr>
<tr>
<td><code>set mode normal</code></td>
<td>Set mode back to normal, which is the default (all purpose) mode</td>
</tr>
</table>
<h4>TAS mode</h4>
<p>So far, the only special mode is the TAS mode, which is made for doing Tool Assisted Speedruns, with TAS widgets and easier ways to save replays. It is still experimental, but already very useful for doing a TAS. This mode enables the following widgets:</p>
<ul>
<li>frame counter (can also be toggled with <code>toggle_frame_counter</code>), which shows the VDP (not V9990) frame number on screen</li>
<li>cursors (can also be toggled with <code>toggle_cursors</code>), shows which keys (important for games) are pressed</li>
</ul>
<p>It also (re)enables the reverse bar widget.</p>
<p>The mode configures the following key bindings, overriding any existing key bindings (note: Mac key bindings are not proper yet...):</p>
<table>
<tr> <th>keys (PC)</th> <th>keys (Mac)</th> <th>function</th> </tr>
<tr> <td>F6</td> <td>(F6)</td> <td>Load replay from current slot</td></tr>
<tr> <td>F7</td> <td>(F7)</td> <td>Open slot select menu</td></tr>
<tr> <td>F8</td> <td>(F8)</td> <td>Save replay to current slot</td></tr>
<tr> <td>End</td> <td>(End)</td> <td>Advance one frame (<code>advance_frame</code>)</td></tr>
<tr> <td>ScrollLock</td><td>(ScrollLock)</td><td>Reverse one frame (<code>reverse_frame</code>)</td></tr>
</table>
<p>Note that this mode may change in future releases!</p>
<h3><a id="mute">mute</a></h3>
<p>Mute/unmute all sound output.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set mute</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set mute on</code></td>
<td>Mute sound</td>
</tr>
<tr>
<td><code>set mute off</code></td>
<td>Unmute sound</td>
</tr>
</table>
<h3><a id="noise">noise</a></h3>
<p>Controls the amount of Gaussian noise that is added to the video output. A small amount of noise can give a more authentic look to the video output on TFTs. Values can be between 0 and 100, where 0 is no noise and 100 is lots of noise.</p>
<p>This setting is best combined with <code><a class="internal" href="#brightness">brightness</a></code> and <code><a class="internal" href="#contrast">contrast</a></code>: noise creates small random fluctuations in the brightness of pixels. When noise is applied to pure black, it is not possible to make it any darker, so half of the time the noise is ineffective. The same happens with pure white. By setting the <code><a class="internal" href="#brightness">brightness</a></code> slightly above 0 and <code><a class="internal" href="#contrast">contrast</a></code> slightly below 0, you will get a better looking noise effect.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set noise</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set noise 7</code></td>
<td>Add a moderate amount of noise</td>
</tr>
</table>
<h3><a id="pause">pause</a></h3>
<p>Pauses the emulation.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set pause</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set pause on</code></td>
<td>Pauses emulation</td>
</tr>
<tr>
<td><code>set pause off</code></td>
<td>Unpauses emulation</td>
</tr>
</table>
<div class="note">
Note: Some video settings cannot be applied to an already rendered frame and will therefore not take effect until openMSX is unpaused.
</div>
<h3><a id="pause_on_lost_focus">pause_on_lost_focus</a></h3>
<p>When this setting is enabled, the emulation will be paused when the
openMSX window loses focus.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set pause_on_lost_focus</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set pause_on_lost_focus on</code></td>
<td>Emulation will be paused when the openMSX window loses focus</td>
</tr>
<tr>
<td><code>set pause_on_lost_focus off</code></td>
<td>Emulation will continue when the openMSX window loses focus (default)</td>
</tr>
</table>
<h3><a id="pointer_hide_delay">pointer_hide_delay</a></h3>
<p>The amount of seconds before the mouse pointer will be automatically
hidden after it got shown due to mouse activity. A negative amount means that
it will never be hidden, an amount of 0 means that it will be always hidden.
By default the pointer is hidden 1 second after the last mouse activity.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set pointer_hide_delay</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set pointer_hide_delay -1</code></td>
<td>Never hide the mouse pointer</td>
</tr>
<tr>
<td><code>set pointer_hide_delay 0</code></td>
<td>Always hide the mouse pointer</td>
</tr>
<tr>
<td><code>set pointer_hide_delay 3.4</code></td>
<td>Hide the mouse pointer after 3.4 seconds of inactivity</td>
</tr>
</table>
<h3><a id="power">power</a></h3>
<p>Turn the power of the emulated MSX machine on or off.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set power</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set power on</code></td>
<td>Turns the MSX machine on (the default)</td>
</tr>
<tr>
<td><code>set power off</code></td>
<td>Turns the MSX machine off</td>
</tr>
</table>
<h3><a id="printerlogfilename">printerlogfilename</a></h3>
<p>Sets the file to which the printer logger writes.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set printerlogfilename</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set printerlogfilename myprinterlog.txt</code></td>
<td>Log to "myprinterlog.txt"</td>
</tr>
</table>
<h3><a id="print-resolution">print-resolution</a></h3>
<p>Sets the resolution (in dpi) for the emulated dot-matrix printer.</p>
<p>The emulated printer 'prints' pages as PNG files. This settings determines the resolution of those images.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set print-resolution</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set print-resolution 600</code></td>
<td>Sets resolution to 600 dpi</td>
</tr>
</table>
<h3><a id="r800_freq">r800_freq / r800_freq_locked</a></h3>
<p>These two settings control the R800 clock frequency. See <code><a class="internal" href="#z80_freq">z80_freq / z80_freq_locked</a></code> for details.</p>
<h3><a id="renderer">renderer</a></h3>
<p>Switch to a different video renderer. See the User's Manual for <a class="external" href="user.html#renderers">a description of the available renderers</a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set renderer</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set renderer <name></code></td>
<td>Switches to the given renderer</td>
</tr>
</table>
<h3><a id="renshaturbo">renshaturbo</a></h3>
<p>Sets the speed of the built-in auto fire on some Japanese MSX models, for example the turboR machines. A value of 0 turns off auto fire, while 100 selects the most rapid auto fire.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set renshaturbo</code></td>
<td>Shows the current renshaturbo value</td>
</tr>
<tr>
<td><code>set renshaturbo <num></code></td>
<td>Sets speed to value <num></td>
</tr>
</table>
<div class="note">
Note: This setting is only available if the current MSX machine has hardware Rensha Turbo support.
</div>
<h3><a id="resampler">resampler</a></h3>
<p>Sets the method to resample the sound of sound chips from their native frequency to the <a class="internal" href="#frequency">desired output frequency</a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set resampler</code></td>
<td>Shows the currently active resampler</td>
</tr>
<tr>
<td><code>set resampler fast</code></td>
<td>Sets a fast, but low quality resampler. This uses simple linear interpolation, which can result in very audible aliasing effects in some cases. Although this is a relatively low quality algorithm, it's the algorithm that was used in pre-0.6.3 openMSX versions (and most other MSX emulators).</td>
</tr>
<tr>
<td><code>set resampler blip</code></td>
<td>Sets the <a href="http://slack.net/~ant/libs/audio.html#Blip_Buffer">Blip_Buffer</a> based resampler, which has the best quality per CPU usage ratio (this is the default value).</td>
</tr>
<tr>
<td><code>set resampler hq</code></td>
<td>Sets the highest quality resampler, but it also takes the most CPU time. It's based on the <a href="http://www.mega-nerd.com/SRC/">libsamplerate</a> algorithm.</td>
</tr>
</table>
<h3><a id="rs232-inputfilename">rs232-inputfilename</a></h3>
<p>Sets the file from which the RS232-tester reads data. Note that the
<code>rs232-tester</code> has to be plugged in the <code>msx-rs232</code>
connector for this to become useful. When plugging the tester, this setting
needs to point to a valid file.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set rs232-inputfilename</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set rs232-inputfilename myrs232input.txt</code></td>
<td>Reads from "myrs232input.txt"</td>
</tr>
</table>
<h3><a id="rs232-outputfilename">rs232-outputfilename</a></h3>
<p>Sets the file to which the RS232-tester writes the data. Note that the
<code>rs232-tester</code> has to be plugged in the <code>msx-rs232</code>
connector for this to become useful. When plugging the tester, this setting
needs to point to a valid file.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set rs232-outputfilename</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set rs232-outputfilename myrs232output.txt</code></td>
<td>Write to "myrs232output.txt"</td>
</tr>
</table>
<h3><a id="rtcmode">rtcmode</a></h3>
<p>Sets the Real Time Clock mode. Can be either <code>RealTime</code> or <code>EmuTime</code>.</p>
<p>In <code>RealTime</code> mode the MSX clock is always synchronized with the host clock, even when for example emulation is paused for a while or when emulation is run at 200% of real speed.</p>
<p>In <code>EmuTime</code> mode the time is only synchronized with the host clock when openMSX starts. From then on the clock ticks at the same pace as the emulated machine. So when emulation is paused, the clock is paused as well. If emulation is run at 200% speed, the clock also ticks twice as fast.</p>
<p>In <code>EmuTime</code> mode it's not possible for a MSX program to detect whether it's running on a real or on an emulated machine. That's why this is the default mode. On the other hand the <code>RealTime</code> mode might be better if for example you care that timestamps of files written by the emulated MSX machine are in sync with the host machine time.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set rtcmode</code></td>
<td>Shows the current mode</td>
</tr>
<tr>
<td><code>set rtcmode EmuTime</code></td>
<td>Set EmuTime mode (the default)</td>
</tr>
<tr>
<td><code>set rtcmode RealTime</code></td>
<td>Set RealTime mode</td>
</tr>
</table>
<h3><a id="samples">samples</a></h3>
<p>Sets the size of the sound mixer buffer. Higher values help against buffer underruns (hickups), but increase the latency of the sound output.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set samples</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set samples 1024</code></td>
<td>Use a mixing buffer of 1024 samples</td>
</tr>
</table>
<h3><a id="save_settings_on_exit">save_settings_on_exit</a></h3>
<p>Automatically save the current settings when openMSX exits: execute a <code><a class="internal" href="#save_settings">save_settings</a></code> command on exit.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set save_settings_on_exit</code></td>
<td>Show current setting</td>
</tr>
<tr>
<td><code>set save_settings_on_exit on</code></td>
<td>Enable auto save</td>
</tr>
<tr>
<td><code>set save_settings_on_exit off</code></td>
<td>Disable auto save</td>
</tr>
</table>
<h3><a id="scale_algorithm">scale_algorithm</a></h3>
<p>Selects the algorithm used to transform MSX pixels to host pixels. The User's Manual contains <a class="external" href="user.html#scalers">more information about scalers</a>.
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set scale_algorithm</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set scale_algorithm simple</code></td>
<td>Selects the default scale algorithm</td>
</tr>
<tr>
<td><code>set scale_algorithm hq</code></td>
<td>Selects the HQ2x/3x/4x scale algorithm</td>
</tr>
</table>
<div class="note">
Note: Not all renderers support all scale algorithms.
</div>
<h3><a id="scale_factor">scale_factor</a></h3>
<p>Selects the scale factor. Scale factor <n> means the typical MSX pixel (MSX resolution 256×212) is mapped on <n> by <n> host pixels. For the moment the possible values are 1 to 4. In the future we may support a wider range or even non-integer values. The User's Manual contains <a class="external" href="user.html#scalers">more information about scalers</a>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set scale_factor</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set scale_factor <n></code></td>
<td>Sets a new scale factor</td>
</tr>
</table>
<div class="note">
Note: Not all renderers support all scale factors.
</div>
<h3><a id="scanline">scanline</a></h3>
<p>Sets the amount of scanline effect.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set scanline</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set scanline <value></code></td>
<td>Changes the value</td>
</tr>
</table>
<div class="note">
Note: Some scalers will not render scanlines at all.
</div>
<h3><a id="sound_driver">sound_driver</a></h3>
<p>Select the sound output driver. The list of available sound drivers is platform specific.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set sound_driver sdl</code></td>
<td>Selects the SDL sound driver</td>
</tr>
<tr>
<td><code>set sound_driver null</code></td>
<td>Selects the null sound driver (no sound)</td>
</tr>
</table>
<h3><a id="speed">speed</a></h3>
<p>Sets the emulation speed relative to the speed of a real MSX. Speed 100 means as fast as a real MSX, lower values are slower than real MSX, higher values are faster than real MSX.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set speed</code></td>
<td>Shows current emulation speed</td>
</tr>
<tr>
<td><code>set speed <num></code></td>
<td>Sets new emulation speed</td>
</tr>
</table>
<h3><a id="soundchip_balance"><soundchip>_balance</a></h3>
<p>Sets the balance (distribution over the left and right channel) for individual sound chips. It replaces the previously available <code><soundchip>_mode</code> setting. The range is between -100 (totally left) and 100 (totally right).</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_balance</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_balance 0</code></td>
<td>Plays the output of this chip on both the left and right channel</td>
</tr>
<tr>
<td><code>set <soundchip>_balance -100</code></td>
<td>Plays the output of this chip on only the left channel</td>
</tr>
<tr>
<td><code>set <soundchip>_balance 75</code></td>
<td>Plays the output of this chip mostly on the right channel, but also a bit on the left channel</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set PSG_balance</code><br />
<code>set PSG_balance -100</code><br />
<code>set FMPAC_balance 0</code>
</div>
<h3><a id="soundchip_channel_record"><soundchip>_ch<channel>_record</a></h3>
<p>Sets the filename to which the sound of an individual channel of
individual sound chips should be recorded. When this setting is not set, no
recording takes place and recording starts as soon as the setting is set.
Normally, you would probably prefer to use the <code><a class="internal"
href="#record_channels">record_channels</a></code> command to set up channel
recording instead of this low level setting.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_ch<channel>_record</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_ch<channel>_record filename</code></td>
<td>Starts recording the sound of the specified chip and channel to the file with name <filename></td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set SCC_ch1_record</code><br />
<code>set PSG_ch3_record /tmp/PSG_ch3.wav</code>
</div>
<h3><a id="soundchip_channel_mute"><soundchip>_ch<channel>_mute</a></h3>
<p>Use to mute a specific channel of an individual sound chip.
Normally, you would probably prefer to use the <code><a class="internal"
href="#mute_channels">mute_channels</a></code> command to set up channel
muting instead of this low level setting.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_ch<channel>_mute</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_ch<channel>_mute on</code></td>
<td>Mutes the sound of the specified channel of the specified chip</td>
</tr>
<tr>
<td><code>set <soundchip>_ch<channel>_mute off</code></td>
<td>Unmutes the sound of the specified channel of the specified chip</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set SCC_ch1_mute</code><br />
<code>set PSG_ch3_mute on</code><br />
<code>set SCC_ch5_mute off</code>
</div>
<h3><a id="soundchip_detune_frequency"><soundchip>_detune_frequency</a></h3>
<p>Sets the frequency of the detune (a random variation in a sound's frequency) effect. It makes a sound fatter and more natural, as if played by a human being.
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_detune_frequency</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_detune_frequency <num></code></td>
<td>Sets new detune frequency in Hz; 1 is minimum, 100 is maximum</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set PSG_detune_frequency</code><br />
<code>set PSG_detune_frequency 5</code> (default)<br />
</div>
<div class="note">
Note: For now, this setting is only available for the PSG soundchip.
</div>
<div class="note">
Note: It is often more convenient to use the <code><a class="internal" href="#psg_profile">psg_profile</a></code> command.
</div>
<h3><a id="soundchip_detune_percent"><soundchip>_detune_percent</a></h3>
<p>Sets the strength of the detune effect. By default it is 0, which means the effect is switched off.
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_detune_percent</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_detune_percent <num></code></td>
<td>Sets new detune strength; 0 is minimum, 10 is maximum</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set PSG_detune_percent</code><br />
<code>set PSG_detune_percent 0</code> (switched off, default)<br />
<code>set PSG_detune_percent 0.5</code> (recommended)<br />
</div>
<div class="note">
Note: For now, this setting is only available for the PSG soundchip.
</div>
<div class="note">
Note: It is often more convenient to use the <code><a class="internal" href="#psg_profile">psg_profile</a></code> command.
</div>
<h3><a id="soundchip_vibrato_frequency"><soundchip>_vibrato_frequency</a></h3>
<p>Sets the frequency of the vibrato (a periodic variation in a sound's frequency) effect.
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_vibrato_frequency</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_vibrato_frequency <num></code></td>
<td>Sets new vibrato frequency in Hz; 1 is minimum, 10 is maximum</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set PSG_vibrato_frequency</code><br />
<code>set PSG_vibrato_frequency 5</code> (default)<br />
</div>
<div class="note">
Note: For now, this setting is only available for the PSG soundchip.
</div>
<div class="note">
Note: It is often more convenient to use the <code><a class="internal" href="#psg_profile">psg_profile</a></code> command.
</div>
<h3><a id="soundchip_vibrato_percent"><soundchip>_vibrato_percent</a></h3>
<p>Sets the strength of the vibrato effect. By default it is 0, which means the effect is switched off.
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_vibrato_percent</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_vibrato_percent <num></code></td>
<td>Sets new vibrato strength; 0 is minimum, 10 is maximum</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set PSG_vibrato_percent</code><br />
<code>set PSG_vibrato_percent 0</code> (switched off, default)<br />
<code>set PSG_vibrato_percent 1</code> (recommended)<br />
</div>
<div class="note">
Note: For now, this setting is only available for the PSG soundchip.
</div>
<div class="note">
Note: It is often more convenient to use the <code><a class="internal" href="#psg_profile">psg_profile</a></code> command.
</div>
<h3><a id="soundchip_volume"><soundchip>_volume</a></h3>
<p>Sets the volume for individual sound chips. The overall volume is controlled by the <code><a class="internal" href="#master_volume">master_volume</a></code> setting.
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set <soundchip>_volume</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set <soundchip>_volume <num></code></td>
<td>Sets new volume; 0 is off, 100 is maximum</td>
</tr>
</table>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
<code>set PSG_volume</code><br />
<code>set PSG_volume 60</code><br />
<code>set "FMPAC_volume" 50</code>
</div>
<h3><a id="throttle">throttle</a></h3>
<p>Sets throttle mode. In throttle mode the emulator tries to run at the specified speed relative to a real MSX (see <a class="internal" href="#speed">speed</a> command). When throttling is turned off the emulator runs as fast as possible. The speed may be limited to the framerate of your monitor (e.g. 60fps) due to how the OpenGL driver works, when using the (default) SDLGL-PP renderer. To increase the speed, set the <a class="internal" href="#maxframeskip">maxframeskip</a> setting to a high value (e.g. 100).</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set throttle</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set throttle on</code></td>
<td>Turn throttle mode on (normal operation)</td>
</tr>
<tr>
<td><code>set throttle off</code></td>
<td>Turn throttle mode off (fast forward)</td>
</tr>
</table>
<h3><a id="too_fast_vram_access">too_fast_vram_access</a></h3>
<p>How should software that accesses the VDP-VRAM too fast be emulated?
Most existing MSX software should not access VRAM too fast, and in that case
this setting has no effect. But you may want to change it when you e.g.
emulate an overclocked Z80 (see <a class="internal" href="#z80_freq">
z80_freq</a>).</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set too_fast_vram_access</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set too_fast_vram_access real</code></td>
<td>Accessing the VRAM too fast results in dropped VRAM accesses, just like on a real machine.</td>
</tr>
<tr>
<td><code>set too_fast_vram_access ignore</code></td>
<td>All VRAM accesses are executed, so timing of VRAM access is ignored.</td>
</tr>
</table>
<h3><a id="too_fast_vram_access_callback">too_fast_vram_access_callback</a></h3>
<p>Selects the Tcl procedure to be called when a too-fast-VRAM-access (read
or write) has been detected. This is useful for debugging MSX programs that
show certain kinds of VRAM corruption, especially on MSX1.</p>
<p>By default this setting is empty, which means that nothing is done when a
too-fast-VRAM-access is detected. We ship a few example procedures called
<code>warn_too_fast_vram_access</code> and
<code>debug_too_fast_vram_access</code> which respectively print a warning or
break CPU emulation when this condition occurs. You can find the source code
for these procedures in <code>scripts/callbackprocs.tcl</code>. Feel free to
write your own procedure that does exactly what you need.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set VDP.too_fast_vram_access_callback</code></td>
<td>Shows the currently installed callback</td>
</tr>
<tr>
<td><code>set VDP.too_fast_vram_access_callback warn_too_fast_vram_access</code></td>
<td>Print warning when too fast VRAM access is detected</td>
</tr>
<tr>
<td><code>set VDP.too_fast_vram_access_callback debug_too_fast_vram_access</code></td>
<td>Print warning and also break emulation right after the Z80 instruction that triggered this callback</td>
</tr>
<tr>
<td><code>set VDP.too_fast_vram_access_callback my_custom_callback_handler</code></td>
<td>Install a custom callback handler</td>
</tr>
<tr>
<td><code>set VDP.too_fast_vram_access_callback ""</code></td>
<td>Remove any installed callback handler</td>
</tr>
</table>
<h3><a id="touchpad_transform_matrix">touchpad_transform_matrix</a></h3>
<p>Specify a 2×3 transformation matrix that maps host mouse coordinates
to MSX touchpad coordinates.
To get the following coordinate transformation:</p>
<pre>
| a b c | | host-X | | touchpad-X |
| d e f | × | host-Y | = | touchpad-Y |
| 1 |
</pre>
<p>Use this command:</p>
<pre>
set touchpad_transform_matrix {{a b c} {d e f}}
</pre>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set touchpad_transform_matrix</code></td>
<td>Shows the current value</td>
</tr>
<tr>
<td><code>set touchpad_transform_matrix {{256 0 0} {0 256 0}}</code></td>
<td>This is the default, map the full host window to 256×256 touchpad input</td>
</tr>
<tr>
<td><code>set touchpad_transform_matrix {{320 0 -64} {0 240 -14}}</code></td>
<td>Attempt to map touch coordinates to corresponding MSX pixel coordinates.</td>
</tr>
</table>
<!-- TODO write Tcl scripts to setup this matrix
<div class="note">
Note: It is often more convenient to use the <code><a class="internal" href="#monitor_type">monitor_type</a></code> command.
</div>
-->
<h3><a id="turborpause">turborpause</a></h3>
<p>Controls the pause key on a MSX turboR machine.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set turborpause</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set turborpause on</code></td>
<td>Activate the pause key</td>
</tr>
<tr>
<td><code>set turborpause off</code></td>
<td>Deactivate the pause key</td>
</tr>
</table>
<div class="note">
Note: If you use this setting often, it may be useful to bind it to a key on your PC keyboard. See the <code><a class="internal" href="#bind">bind</a></code> and <code><a class="internal" href="#toggle">toggle</a></code> commands.
</div>
<h3><a id="umr_callback">umr_callback</a></h3>
<p>Selects the Tcl procedure to be called when an Uninitialized Memory Read has been detected. This is useful for debugging MSX programs: uninitialized memory is not guaranteed to have any particular value, so reading it is most likely a bug.</p>
<p>By default this setting is empty, which means that nothing is done when an Uninitialized Memory Read is detected. We ship a useful procedure called <code>umrcallback</code> which logs all UMRs. You can activate it with <code>set umr_callback umrcallback</code>. You can find the source code for this procedure in <code>scripts/callbackprocs.tcl</code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set umr_callback</code></td>
<td>Shows the current UMR callback setting</td>
</tr>
<tr>
<td><code>set umr_callback umrcallback</code></td>
<td>Sets callback proc to <code>umrcallback</code></td>
</tr>
</table>
<h3><a id="vdpcmdinprogress_callback">vdpcmdinprogress_callback</a></h3>
<p>Selects the Tcl procedure to be called when a write to a VDP command engine register is detected while there is still a VDP command in progress. Often this is an indication of a bug in the running MSX program. Note that writes to VDP register R#44 with a command in progress are normal behaviour, so the callback is not triggered for such writes.</p>
<p>By default this setting is empty, which means that nothing is done when a suspicious VDP command engine write is detected. We ship an example proc called <code>vdpcmdinprogresscallback</code> which simply logs all occurrences. You can activate it with <code>set vdpcmdinprogress_callback vdpcmdinprogresscallback</code>. You can find the source code for this proc in <code>scripts/callbackprocs.tcl</code>. Feel free to write your own proc that does exactly what you need. For example it might be a good idea to execute <code>debug break</code> in your callback, so that you can easily examine what code triggered this write.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set vdpcmdinprogress_callback</code></td>
<td>Shows the current value. Default is "" (meaning no action)</td>
</tr>
<tr>
<td><code>set vdpcmdinprogress_callback vdpcmdinprogresscallback</code></td>
<td>Sets callback to <code>vdpcmdinprogresscallback</code></td>
</tr>
</table>
<h3><a id="vdpcmdtrace">vdpcmdtrace</a></h3>
<p>Enable/disable VDP command tracing. When enabled, every VDP command is logged on stdout. This is useful when debugging MSX programs that use the VDP command engine.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set vdpcmdtrace</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set vdpcmdtrace on</code></td>
<td>Enables VDP command tracing</td>
</tr>
<tr>
<td><code>set vdpcmdtrace off</code></td>
<td>Disables VDP command tracing</td>
</tr>
</table>
<h3><a id="videosource">videosource</a></h3>
<p>Switch between video sources: <code>MSX</code> (V99x8, default when no
Video 9000 is available), <code>GFX9000</code> (V9990),
<code>Video9000</code> (V9990 superimposed on top of V99x8, default if
available) and <code>Laserdisc</code> (for Palcom machines). There can be
even more video sources, e.g. due to cartridges with a built in VDP like
the Neos MA-20(V).
</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set videosource</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set videosource MSX</code></td>
<td>Switch to normal MSX screen</td>
</tr>
<tr>
<td><code>set videosource GFX9000</code></td>
<td>Switch to GFX9000 screen</td>
</tr>
</table>
<div class="note">
Note: This setting is only available if multiple videosources are present.
</div>
<h3><a id="v9990cmdtrace">v9990cmdtrace</a></h3>
<p>Enable/disable V9990 command tracing. This is the V9990 equivalent of <code><a class="internal" href="#vdpcmdtrace">vdpcmdtrace</a></code>.</p>
<div class="subsectiontitle">
usage:
</div>
<table>
<tr>
<td><code>set v9990cmdtrace</code></td>
<td>Shows the current setting</td>
</tr>
<tr>
<td><code>set v9990cmdtrace on</code></td>
<td>Enables V9990 command tracing</td>
</tr>
<tr>
<td><code>set v9990cmdtrace off</code></td>
<td>Disables V9990 command tracing</td>
</tr>
</table>
<div class="note">
Note: This setting is only available if the <code>gfx9000</code> or
<code>video9000</code> extension is present.
</div>
<h3><a id="z80_freq">z80_freq / z80_freq_locked</a></h3>
<p>These two settings control the Z80 clock frequency. When <code>z80_freq_locked</code> is true the emulated Z80 runs at the normal 3.579545 MHz (or optionally 5.369318 MHz on some machines). When <code>z80_freq_locked</code> is false the value of <code>z80_freq</code> is taken as the Z80 clock frequency.</p>
<p>WARNING: be careful when changing these settings. When saving the settings in which a different clock is activated, this will be applied for all machines, as these are global settings. Some software (like demos) may stop working properly with a changed CPU clock frequency. Specifically, using a value (just) below the normal value may cause problems loading CAS images, as these are converted to a high baud rate WAV file internally and when the MSX becomes slower it cannot handle that high baud rate.</p>
<div class="subsectiontitle">
examples:
</div>
<div class="examples">
Overclock Z80 to 14 MHz:<br />
<code>set z80_freq 14318180</code><br />
<code>set z80_freq_locked false</code><br />
<br />
F8 switches between 3.5 MHz and 7 MHz:<br />
<code>set Z80_freq 7159090</code><br />
<code>bind F8 "toggle z80_freq_locked"</code><br />
</div>
<h3><a id="othersettings">other settings</a></h3>
<p>Like with the commands, there are also some specialized settings, for which we only list a very brief overview. As always execute "<code>help setting <setting-name></code>" to get a more detailed description of the setting.</p>
<table>
<tr>
<td><code>fast_cas_load_hack_enabled</code></td>
<td>Enable a hack that lets you quickly load CAS files, without having openMSX convert them to WAV</td>
</tr>
</table>
<p>The source code of all these scripts is located in <code>share/scripts</code> directory. Feel free to inspect these scripts and modify them to suit your needs.</p>
</body>
</html>
|
