README
1Hatari UI
2---------
3
4Hatari UI is an out-of-process user interface for the Hatari Atari
5ST/STe/TT/Falcon emulator and its built-in debugger which can
6(optionally) embed the Hatari emulator window.
7
8Having the UI in another process allows doing it with a higher level
9language while avoiding adding GUI toolkit dependencies to Hatari
10itself. The UI is written in Python language, using Gtk widget set.
11
12The main points of this new UI over the Hatari internal one are its
13configurability, more usable file selector, internationalization
14support and providing a (very) simple GUI for the (console based)
15debugger included with the Hatari emulator.
16
17Note: this is an additional UI, the built-in Hatari SDL UI isn't being
18replaced or going anywhere!
19
20
21Requirements
22------------
23
24- Python >= 2.7
25- python-gi (Python GObject Introspection)
26- Gtk v3 and its gir bindings (gir1.2-gtk-3.0)
27
28Hatari UI is included with the Hatari sources:
29 http://hg.tuxfamily.org/mercurialroot/hatari/hatari/file/tip/python-ui
30
31Hatari UI has been tested on several Linux versions. I would assume
32it to work also on other unix systems such as Apple OSX. It may work
33with the Hatari Windows version, as long as it is built with socket
34support.
35
36Embedding the Hatari emulator window is currently supported only for
37systems using an X window system (from libSDL sources it would seem
38that Windows would also support window embedding, but support for that
39would need to be added both to Hatari and Hatari UI because SDL's
40own embedding disables all keyboard events in SDL program).
41
42Here are instructions on installing the dependencies for non-Linux
43platforms (neither tested nor supported as I don't use/have them):
44 http://pygtk.org/downloads.html
45
46
47Running
48-------
49
50Being a Python program, Hatari UI doesn't need to be built.
51You can just run it from where you extracted it (or checked
52it out of TuxFamily HG repo) by calling its wrapper script:
53 /path/to/script/hatariui
54
55Or you can run just the debugger:
56 /path/to/script/debugui.py
57
58But you can also install it to system along with Hatari:
59 make install
60
61
62Notes
63-----
64
65Hatari UI runs a Hatari version found on $PATH. If you want
66to use a version of Hatari that hasn't been installed, you
67need to modify the search path, for example like this:
68 PATH=../build/src:.:$PATH hatariui
69
70If UI is started without the embedding option, the actions
71(in menus and toolbars) have also shortcuts. They cannot
72be used when Hatari window is embedded because then those
73shortcuts couldn't be used with Hatari.
74
75
76A www-page with more information about Hatari UI is here:
77 http://eerott.mbnet.fi/hatari/hatari-ui.shtml
78