-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocs.html
269 lines (251 loc) · 12.1 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>openMSX » Documentation</title>
<meta name="keywords" content="openmsx msx emulator">
<link href="styles/keys_style.css" type="text/css" title="Keyboard" rel="stylesheet">
<link href="styles/blue_style.css" type="text/css" title="Blue" rel="alternate stylesheet">
<script src="styleswitcher.js" type="text/javascript"></script>
</head>
<body>
<div id="title">
<img src="./images/penguin.gif" alt="[*]">
<h1>openMSX</h1>
<div id="subtitle">
the MSX emulator that aims for perfection
</div>
</div>
<div id="navigation">
<div id="navilinks">
<h1>Navigation</h1>
<div class="linkblock">
<ul>
<li><a href="index.html">Home</a></li>
<li class="this"><a href="docs.html">Documentation</a></li>
<li><a href="screenshots.html">Screenshots</a></li>
<li><a href="features.html">Features</a></li>
<li><a href="3rdparty.html">3rd Party</a></li>
<li><a href="contact.html">Contact</a></li>
<li><a href="http://www.msx.org/forum/semi-msx-talk/openmsx">Forum (MRC)</a></li>
<li><a href="https://github.com/openMSX/">Project Page</a></li>
</ul>
</div>
</div>
<div id="navidownloads">
<h1><a href="https://github.com/openMSX/openMSX/releases/latest">Download</a></h1>
<div class="linkblock">
<h2>openMSX</h2>
<ul>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_20_0/openmsx-20.0-windows-vc-x64-bin-msi.zip">
20.0 / Win 64bit (install)</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_20_0/openmsx-20.0-windows-vc-x64-bin.zip">
20.0 / Win 64bit (zip)</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_16_0/openmsx-16.0-windows-vc-x86-bin-msi.zip">
16.0 / Win 32bit (install)</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_16_0/openmsx-16.0-windows-vc-x86-bin.zip">
16.0 / Win 32bit (zip)</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_20_0/openmsx-20.0-mac-x86_64-bin.dmg">
20.0 / macOS Intel 64bit</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_20_0/openmsx-20.0-mac-aarch64-bin.dmg">
20.0 / macOS Apple 64bit</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_20_0/openmsx-20.0-linux-x86_64-bin.zip">
20.0 / Linux x86 64bit</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_0_15_0/openMSX-openmsx-0.15.0.apk">
0.15.0 / Android 4.1+ ARM (apk)</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_19_1/openmsx-19.1.opk">
19.1 / OpenDingux (opk)</a></li>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_20_0/openmsx-20.0.tar.gz">
20.0 / Source code</a></li>
</ul>
<!--
<ul>
<li><a href="https://github.com/openMSX/openMSX/archive/master.zip">Git master snapshot</a></li>
</ul>
-->
<h2>Catapult</h2>
<p>(deprecated)</p>
<ul>
<li><a href="https://github.com/openMSX/openMSX/releases/download/RELEASE_19_0/openmsx-catapult-19.0.tar.gz">
19.0 / Source code</a></li>
</ul>
<!--
<ul>
<li><a href="https://github.com/openMSX/wxcatapult/archive/master.zip">Git master snapshot</a></li>
</ul>
-->
<h2>Debugger</h2>
<p>(deprecated)</p>
<ul>
<!--<li><a href="https://openmsx.dev/builds/windows/x64/debugger/openMSX_Debugger_x64_20201008.zip">
Snapshot / Win 64bit (zip)</a></li>
<li><a href="http://openmsx.sourceforge.net/temp/openmsx-debugger-win32-bin-snapshot.zip">
Snapshot / Win 32bit (MinGW build, zip)</a></li>
<li><a href="https://openmsx.dev/builds/mac/debugger/openMSX-debugger-469-g9b57b83-mac-x86_64.tbz">
Snapshot / macOS 64bit (tbz, requires separate Qt5 download)</a></li> -->
<li><a href="https://github.com/openMSX/debugger/archive/master.zip">
Snapshot / Source code (zip)</a></li>
<!--<li><a href="http://openmsx.sourceforge.net/temp/openmsx-debugger-latest-snapshot-windows-x86-vc-bin.zip">
Snapshot / Win 32bit (VC build, zip)</a></li>
<li><a href="http://openmsx.sourceforge.net/temp/openmsx-debugger-latest-snapshot-windows-x64-vc-bin.zip">
Snapshot / Win 64bit (VC build, zip)</a></li>
<li><a href="http://openmsx.sourceforge.net/temp/Qt-4.4.3-x86.zip">
Qt libs / Win 32bit (zip)</a></li>
<li><a href="http://openmsx.sourceforge.net/temp/Qt-4.4.3-x64.zip">
Qt libs / Win 64bit (zip)</a></li> -->
<li><a href="https://github.com/openMSX/debugger/releases/tag/nightly/">GitHub nightly builds</a></li>
</ul>
<h2>Development builds</h2>
<ul>
<li><a href="https://vampier.net/openMSX/">Vampier's Windows Builds</a></li>
<li><a href="https://github.com/openMSX/openMSX/actions/workflows/build_snapshots.yml?query=branch%3Amaster+">GitHub Actions Snapshot builds</a></li>
<!-- <li><a href="http://openmsx.fixato.net/">FiXato's openMSX Builder site</a></li> -->
</ul>
<!--
<ul>
<li><a href="#">Source</a></li>
</ul>
<ul>
<li><a href="http://openmsx.sourceforge.net/temp/openmsx-debugger-SVN-snapshot.tar.gz">SVN snapshot / Source code</a></li>
<li><a href="http://openmsx.sourceforge.net/temp/openmsx-debugger-win32-bin-snapshot.zip">SVN snapshot / Win32</a></li>
</ul>
-->
<!-- <p>Note: snapshots may be (very) outdated!</p> -->
</div>
</div>
<div id="openhub">
<h1>
<iframe src="https://www.openhub.net/p/5389/widgets/project_thin_badge.html" scrolling="no" marginHeight=0 marginWidth=0 style="height: 32px; width: 145px; border: none;"></iframe>
</h1>
</div>
<div id="styleswitcher">
<ul>
<li>
<a href="#"
onclick="setActiveStyleSheet('Keyboard'); return false;">
<img src="images/theme-keys.png"
alt="Theme: keys"></a></li>
<li>
<a href="#"
onclick="setActiveStyleSheet('Blue'); return false;">
<img src="images/theme-blue.png"
alt="Theme: blue"></a></li>
</ul>
</div>
</div>
<div id="content">
<h1>Documentation</h1>
<h2>Most Frequently Asked Questions</h2>
<dl>
<dt class="toc">
<a href="http://en.wikipedia.org/wiki/OpenMSX">What is openMSX?</a>
</dt>
<dd>
openMSX is an emulator for the MSX home computer system. Its goal is to emulate all
aspects of the MSX with 100% accuracy: perfection in emulation.
You can find everything you ever wanted to know about MSX, and more, in
<a href="http://faq.msxnet.org/">the Ultimate MSX FAQ</a>.
</dd>
<dt class="toc">
<a href="/manual/faq.html#c-bios">
All I get is "Cartridge not found." What's wrong?
</a>
</dt>
<dd>
Nothing, actually. Your openMSX is running a machine named 'C-BIOS'.
<a href="http://cbios.sourceforge.net/">C-BIOS</a> is a free BIOS
for MSX, which—like openMSX—is still in development, and
therefore doesn't provide all functionality to run a complete MSX
machine, yet. <br />
<br />
It can, however, still load and run ROM files,
such as homebrew games obtained from the
<a href="https://www.msxdev.org/">MSXdev competition</a>, or
<a href="https://www.msx.org/wiki/Copying_cartridge_software">dumped</a>
from your own cartridges.<br />
To run these files, just drag-and-drop them onto the open openMSX
window or shortcut, or watch this video showcasing one of the other
<a href="https://www.youtube.com/watch?v=H7nPJdsRaRM">ways to load ROMs</a>.<br />
<br />
Read the <a href="/manual/setup.html">Setup Guide</a>
to learn how to make openMSX emulate real MSX machines.
</dd>
<dt class="toc">
<a href="/manual/faq.html">More Frequenty Asked Questions<!-- » --></a>
</dt>
<dd>
The openMSX FAQ answers more frequently asked questions.
</dd>
</dl>
<h2>Installing and Running openMSX</h2>
<dl>
<dt class="toc"><a href="/manual/compile.html">Compilation Guide</a></dt>
<dd>
This guide describes how you can get the openMSX sources and compile
them. If you downloaded a binary release, you can skip this.
</dd>
<dt class="toc"><a href="/manual/setup.html">Setup Guide</a></dt>
<dd>
This guide describes how you can configure openMSX to emulate
actual MSX machines. It also describes how you can have openMSX
start up with your personal settings, how you can configure openMSX
and your system for optimal performance, and several other
configuration related topics.
</dd>
<dt class="toc"><a href="/manual/user.html">User's Manual</a></dt>
<dd>
This manual describes all the things you can do with openMSX once
it is fully running.
</dd>
<dt class="toc"><a class="external" href="/manual/commands.html">Console Command Reference</a></dt>
<dd>
An overview of all commands and settings that can be used from the openMSX built in console. Check this if you want to know exactly how to control openMSX. Because the current openMSX Catapult GUI is running behind in functionality, it is also useful to read this for some common settings not supported in Catapult yet.
</dd>
<dt class="toc"><a class="external" href="/manual/diskmanipulator.html">Diskmanipulator</a></dt>
<dd>
The <code>diskmanipulator</code> command is so powerful that we made a separate
manual for it. Use it to create (hard)disk images, import files to them, export
files from them, etc.
</dd>
</dl>
<h2>Installing and Running Catapult</h2>
<p>
Please note that Catapult isn't maintained anymore. We encourage you to use the built-in GUI in openMSX 20.0 and later instead. Use the documentation below only as a historic reference or when you insist on using Catapult.
</p>
<dl>
<dt class="toc"><a href="/catapult-manual/compile.html">Compilation Guide</a></dt>
<dd>
This guide describes how you can get the Catapult sources and
compile them. If you downloaded a binary release, you can skip this.
</dd>
<dt class="toc"><a href="/catapult-manual/user.html">User's Manual</a></dt>
<dd>
This manual describes all the things you can do with Catapult
once it is fully running.
</dd>
</dl>
<h2>Documentation For Developers</h2>
<dl>
<dt class="toc"><a href="/manual/openmsx-control.html">Controlling openMSX from External Applications</a></dt>
<dd>
A guide for application developers who want to control openMSX from their own programs. Very useful if you're planning to make a launcher, GUI, debugger or another kind of external program that needs to control openMSX.
</dd>
<!--<dt class="toc"><a href="/doxygen">Source Code Documentation</a></dt>
<dd>
Source code documentation generated using Doxygen.
</dd>-->
<dt class="toc"><a href="/vdp-vram-timing/vdp-timing.html">V9938 VRAM timings</a></dt>
<dd>
Specific V9938 timing information as measured and analyzed by some openMSX Team members. Part 1.
</dd>
<dt class="toc"><a href="/vdp-vram-timing/vdp-timing-2.html">V9938 VRAM timings, part II</a></dt>
<dd>
Specific V9938 timing information as measured and analyzed by some openMSX Team members. Part 2.
</dd>
</dl>
<p>
There is additional documentation for (would-be) developers in <a class="external" href="https://github.com/openMSX/openMSX/tree/master/doc">the <code>doc</code> directory in the openMSX code tree</a>.
</p>
</div>
</body>
</html>