0d17038e4c798842e2174748cc5c3107b543088e
[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>[Maemo:] At the moment EmuFront installs to /usr/local/bin</li>
62                         <li>Add platform(s) (e.g. Colecovision)</li>
63                         <li>Add media type(s) (e.g. Cartridge) </li>
64                         <li>Add setup(s): Assign a media type to platform and
65                         set supported file extensions (e.g. 'dsk')</li>
66                         <li> <ul>
67                                 <li>Currently only zipped files are
68                                 supported.</li>
69                                 <li>All the files inside a zip archive with extensions configured by user
70                                 will be scanned to database</li>
71                                 <li>A Zip archive can contain 1...<i>n</i> files</li>
72                         </ul></li>
73                         <li>TODO: If no extensions are configured for
74                         setup, the zip archive will be used AS IS with
75                         emulator configuration (this is useful with M.A.M.E.
76                         and similar emulators)</li>
77                         <li>Assign path to files with setup, select path scan
78                         the files</li>
79                         <li>Configure emulator</li>
80                         <li><ul>
81                                 <li>Set an unique name for emulator
82                                 configuration, one emulator can have many
83                                 configurations with different name</li>
84                                 <li>Set the emulator executable or path to
85                                 executable if the exutable is not on the
86                                 system path</li>
87                                 <li>Set the command line options</li>
88                                 <li><ul>
89                                 <li>$1 is a placeholder for filename in the command parameters, this is <b>obligatory</b></li>
90                                 <li>Multiple files are also supported using placeholders $1 ... $<i>n</i>, e.g. '-diska $1 -diskb $2'</li>
91                         </ul></li>
92                         </ul></li>
93                         <li>In the main window select a platform and a media
94                         type, press update, selected file(s), emulator and press
95                         launch</li>
96                         <li>Multiple files can be selected and they all will
97                         be extracted to /tmp/</li>
98                         <li>More detailed instructions will be added later...</li>
99                 </ul>
100
101                 <h2>Screenshots</h2>
102
103                 <h3>v0.01a</h3>
104                 <h4>Maemo on N900</h4>
105                 <p><img src="img/emufront001-maemo-01.png" alt="v0.01a Maemo N900" />
106                 <img src="img/emufront001-maemo-02.png" alt="v0.01a Maemo N900" />
107                 <img src="img/emufront001-maemo-03.png" alt="v0.01a Maemo N900" />
108                 <img src="img/emufront001-maemo-04.png" alt="v0.01a Maemo N900" />
109                 <img src="img/emufront001-maemo-05.png" alt="v0.01a Maemo N900" />
110                 <img src="img/emufront001-maemo-06.png" alt="v0.01a Maemo N900" />
111                 <img src="img/emufront001-maemo-07.png" alt="v0.01a Maemo N900" />
112                 <img src="img/emufront001-maemo-08.png" alt="v0.01a Maemo N900" />
113                 <img src="img/emufront001-maemo-09.png" alt="v0.01a Maemo N900" />
114                 <img src="img/emufront001-maemo-10.png" alt="v0.01a Maemo N900" />
115                 <img src="img/emufront001-maemo-11.png" alt="v0.01a Maemo N900" />
116                 <img src="img/emufront001-maemo-12.png" alt="v0.01a Maemo N900" />
117                 <img src="img/emufront001-maemo-13.png" alt="v0.01a Maemo N900" />
118                 <img src="img/emufront001-maemo-14.png" alt="v0.01a Maemo N900" /></p>
119                 <h3>v0.00a</h3>
120                 <h4>PC UI/Scanning media images</h4>
121                 <p><img src="img/emufrontv06-1.png" alt="v0.1 PC UI" /></p>
122                 <h3>v0.01a</h3>
123                 <h4>PC UI/Main window</h4>
124                 <p><img src="img/emufrontv01-1.png" alt="v0.1 PC UI" /></p>
125
126                 <hr />
127
128                 <p>EmuFront &copy; 2010 Mikko Keinänen</p>
129         </body>
130 </html>