Initial usage instructions.
[emufront] / www / index.html
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4         <head>
5                 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 
6                 <meta name="keywords" content="qt, emulator, emulation, front-end, frontend, linux, c++, sqlite" />
7                 <meta name="description" content="EmuFront is an universal (multi-system) computer and video game console emulator front-end implemented in QT, C++ and SQLite targeted on Linux operating systems. " />
8                 <meta name="author" content="Mikko Keinänen" />
9                 <meta name="lang" content="en" />
10                         
11                 <title>EmuFront :: an universal emulator front-end</title>
12                 <link rel="stylesheet" href="style.css" type="text/css" />
13         </head>
14         <body>
15                 <h1>Welcome to EmuFront!</h1>
16
17                 <h2>About</h2>
18                 <p>EmuFront is an universal (multi-system) computer and video game console emulator front-end implemented in
19                 QT, C++ and SQLite targeted on Linux operating systems.
20                 Although this project is currently hosted at Maemo Garage,
21                 this is pure QT project and doesn't have any Maemo specific
22                 dependencies. You can use EmuFront on any QT Linux platform. I'm
23                 planning to release two GUI options PC and Mobile (MeeGo,
24                 Maemo, ...)</p>
25
26                 <p>EmuFront is Open Source Software licenced under GPL version 2.</p>
27
28
29
30                 <h2>Project</h2>
31                 <ul>
32                         <li><a href="https://garage.maemo.org/projects/emufront/">Project page</a></li>
33                         <li><a href="https://garage.maemo.org/plugins/ggit/browse.php/?p=emufront">Browse Git Repository</a></li>
34                 </ul>
35
36                 <h2>Features</h2>
37                 <ul>
38                         <li>Configure platforms (Commodore 64, Sega Master
39                         System, ...)</li>
40                         <li>Configure media types (Cartridge, floppy disk,
41                         ...)</li>
42                         <li>Configure setups (platform, media type
43                         and supported file types)</li>
44                         <li>Configure and scan filepaths containing
45                         disk/rom/tape-images</li>
46                         <li>Configure emulators (executable, command line
47                         options, supported setup)</li>
48                         <li>Launch emulators with disk/rom/tape-images</li>
49                         <li>...</li>
50                 </ul>
51
52                 <h2>Prequisites</h2>
53                 <ul>
54                         <li><a href="http://qt.nokia.com/">QT</a> 4.x (tested on 4.6 and 4.7)</li>
55                         <li><a href="http://www.sqlite.org/">SQLite</a> 3.x.</li>
56                         <li>UnZip 6.x from <a href="http://www.info-zip.org/">Info-ZIP</a></li>
57                 </ul>
58
59                 <h2>Instructions</h2>
60                 <ul>
61                         <li>Add platform(s) (e.g. Colecovision)</li>
62                         <li>Add media type(s) (e.g. Cartridge) </li>
63                         <li>Add setup(s): Assign a media type to platform and
64                         set supported file extensions (e.g. col, zipped files are
65                         supported)</li>
66                         <li>Assign path to files with setup, select path scan
67                         the files</li>
68                         <li>Configure emulator: in the command parameters $1
69                         is a placeholder for filename, this is obligatory
70                         (multiple files are also supported, e.g. -diska $1
71                         -diskb $2 ...)</li>
72                         <li>In the main window select a platform and a media
73                         type, press update, selected file(s), emulator and press
74                         launch</li>
75                         <li>More detailed instructions will be added later...</li>
76                 </ul>
77
78                 <h2>Screenshots</h3>
79                 
80                 <h3>v0.01a</h3>
81                 <h4>Maemo on N900</h4>
82                 <img src="img/emufront001-maemo-01.png" alt="v0.01a Maemo N900" />
83                 <img src="img/emufront001-maemo-02.png" alt="v0.01a Maemo N900" />
84                 <img src="img/emufront001-maemo-03.png" alt="v0.01a Maemo N900" />
85                 <img src="img/emufront001-maemo-04.png" alt="v0.01a Maemo N900" />
86                 <img src="img/emufront001-maemo-05.png" alt="v0.01a Maemo N900" />
87                 <img src="img/emufront001-maemo-06.png" alt="v0.01a Maemo N900" />
88                 <img src="img/emufront001-maemo-07.png" alt="v0.01a Maemo N900" />
89                 <img src="img/emufront001-maemo-08.png" alt="v0.01a Maemo N900" />
90                 <img src="img/emufront001-maemo-09.png" alt="v0.01a Maemo N900" />
91                 <img src="img/emufront001-maemo-10.png" alt="v0.01a Maemo N900" />
92                 <img src="img/emufront001-maemo-11.png" alt="v0.01a Maemo N900" />
93                 <img src="img/emufront001-maemo-12.png" alt="v0.01a Maemo N900" />
94                 <img src="img/emufront001-maemo-13.png" alt="v0.01a Maemo N900" />
95                 <img src="img/emufront001-maemo-14.png" alt="v0.01a Maemo N900" />
96                 <h3>v0.00a</h3>
97                 <h4>PC UI/Scanning media images</h4>
98                 <img src="img/emufrontv06-1.png" alt="v0.1 PC UI" />
99                 <h3>v0.01a</h3>
100                 <h4>PC UI/Main window</h4>
101                 <img src="img/emufrontv01-1.png" alt="v0.1 PC UI" />
102
103                 <hr />
104
105                 <p>EmuFront &copy; 2010 Mikko Keinänen</p>
106         </body>
107 </html>