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