Updated the git clone command.
[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 Desktop PC and Mobile (MeeGo,
24                 Maemo, ...)</p>
25
26                 <p><b>Note: The EmuFront source code repository is hosted at Gitorious from 26th of December 2010.</b></p>
27
28                 <p>EmuFront is Open Source Software licenced under GPL version 2.</p>
29
30
31                 <h2>Project</h2>
32                 <ul>
33                         <li><a href="https://garage.maemo.org/projects/emufront/">Project page</a></li>
34                         <li><a href="http://gitorious.org/emufront">Browse Git Repository at Gitorious</a></li>
35                 </ul>
36
37                 <h2>Features</h2>
38                 <ul>
39                         <li>Configure platforms (Commodore 64, Sega Master
40                         System, ...)</li>
41                         <li>Configure media types (Cartridge, floppy disk,
42                         ...)</li>
43                         <li>Configure setups (platform, media type
44                         and supported file types)</li>
45                         <li>Configure and scan filepaths containing
46                         disk/rom/tape-images</li>
47                         <li>Configure emulators (executable, command line
48                         options, supported setup)</li>
49                         <li>Launch emulators with disk/rom/tape-images</li>
50                         <li>Multiple configurations for single emulator</li>
51                         <li>Multiple media images can be selected to a single
52                         emulator launch command</li>
53                         <li>...</li>
54                 </ul>
55
56                 <h2>Prequisites</h2>
57                 <ul>
58                         <li><a href="http://qt.nokia.com/">QT</a> 4.x (tested on 4.6 and 4.7)</li>
59                         <li><a href="http://www.sqlite.org/">SQLite</a> 3.x.</li>
60                         <li>UnZip 6.x from <a href="http://www.info-zip.org/">Info-ZIP</a></li>
61                 </ul>
62
63                 <h2>Installing from git repository</h2>
64
65                 <pre>
66         git clone git://gitorious.org/emufront/emufront.git
67         cd emufront/src
68         qmake -project
69         qmake emufront.pro
70         make
71         ./emufront
72                 </pre>
73
74                 <h2>Instructions</h2>
75                 <ul>
76                         <li>Set the directory path for temporary files</li>
77                         <li>Add platform(s) (e.g. Colecovision)</li>
78                         <li>Add media type(s) (e.g. Cartridge) </li>
79                         <li>Add setup(s): Assign a media type to platform and
80                         set supported file extensions (e.g. 'dsk')</li>
81                         <li> <ul>
82                                 <li>Currently only zipped files are
83                                 supported.</li>
84                                 <li>All the files inside a zip archive with extensions configured by user
85                                 will be scanned to database</li>
86                                 <li>A Zip archive can contain 1...<i>n</i> files</li>
87                                 <li>If no extensions are configured for
88                         setup, the zip archive will be used AS IS with
89                         emulator configuration (this is useful with M.A.M.E.
90                         and similar emulators)</li>
91                         </ul></li>
92                         <li>Assign a file path with media images (roms, disk images) to setup</li>
93                         <li>Select an assidned file path and push scan to scan the files to database</li>
94                         <li>Configure emulator(s)</li>
95                         <li><ul>
96                                 <li>Set an unique name for each emulator
97                                 configuration, one emulator can have many
98                                 configurations with different names</li>
99                                 <li>Set the emulator executable or path to
100                                 executable if the exutable is not on the
101                                 system path</li>
102                                 <li>Set the command line options</li>
103                                 <li><ul>
104                                 <li>$1 is a placeholder for filename in the command parameters, this is <b>obligatory</b></li>
105                                 <li>Multiple files are also supported using placeholders $1 ... $<i>n</i>, e.g. '-diska $1 -diskb $2'</li>
106                         </ul></li>
107                         </ul></li>
108                         <li>In the main window select a platform and a media
109                         type, press update, select file(s), emulator and press
110                         launch</li>
111                         <li>Multiple files can be selected and they all will
112                         be extracted to /tmp/</li>
113                         <li>More detailed instructions will be added later...</li>
114                 </ul>
115
116                 <h2>Screenshots</h2>
117
118                 <h3>v0.0.1.4</h4>
119                 <h4>PC UI/Configuring emulator with multiple disk drives</h4>
120                 <p>
121                         <img src="img/emufront-0.1.4-pc-1.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
122                         <img src="img/emufront-0.1.4-pc-2.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
123                         <img src="img/emufront-0.1.4-pc-3.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
124                         <img src="img/emufront-0.1.4-pc-4.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
125                 </p>
126                 <h4>PC UI/Zip archive container multiple disk images and
127                         emulator configuration supporting multiple drives</h4>
128                 <p>
129                         <img src="img/emufront-0.1.4-pc-5.png" alt="v0.0.4a PC UI Zip archive with multiple disk images" />
130                 </p>
131                 <h3>v0.01a</h3>
132                 <h4>Maemo on N900</h4>
133                 <p><img src="img/emufront001-maemo-01.png" alt="v0.01a Maemo N900" />
134                 <img src="img/emufront001-maemo-02.png" alt="v0.01a Maemo N900" />
135                 <img src="img/emufront001-maemo-03.png" alt="v0.01a Maemo N900" />
136                 <img src="img/emufront001-maemo-04.png" alt="v0.01a Maemo N900" />
137                 <img src="img/emufront001-maemo-05.png" alt="v0.01a Maemo N900" />
138                 <img src="img/emufront001-maemo-06.png" alt="v0.01a Maemo N900" />
139                 <img src="img/emufront001-maemo-07.png" alt="v0.01a Maemo N900" />
140                 <img src="img/emufront001-maemo-08.png" alt="v0.01a Maemo N900" />
141                 <img src="img/emufront001-maemo-09.png" alt="v0.01a Maemo N900" />
142                 <img src="img/emufront001-maemo-10.png" alt="v0.01a Maemo N900" />
143                 <img src="img/emufront001-maemo-11.png" alt="v0.01a Maemo N900" />
144                 <img src="img/emufront001-maemo-12.png" alt="v0.01a Maemo N900" />
145                 <img src="img/emufront001-maemo-13.png" alt="v0.01a Maemo N900" />
146                 <img src="img/emufront001-maemo-14.png" alt="v0.01a Maemo N900" /></p>
147                 <h3>v0.00a</h3>
148                 <h4>PC UI/Scanning media images</h4>
149                 <p><img src="img/emufrontv06-1.png" alt="v0.1 PC UI" /></p>
150                 <h3>v0.01a</h3>
151                 <h4>PC UI/Main window</h4>
152                 <p><img src="img/emufrontv01-1.png" alt="v0.1 PC UI" /></p>
153                 <hr />
154
155                 <p>EmuFront &copy; 2010 Mikko Keinänen</p>
156         </body>
157 </html>