Return to README CVS log

Up to [HATARI the Atari ST Emulator] / hatari / python-ui

Annotation of hatari/python-ui/README, revision 1.1.1.2

1.1       root        1: Hatari UI
                      2: ---------
                      3: 
                      4: Hatari UI is an out-of-process user interface for the Hatari Atari
                      5: ST/STe/TT/Falcon emulator and its built-in debugger which can
                      6: (optionally) embed the Hatari emulator window.
                      7: 
                      8: Having the UI in another process allows doing it with a higher level
1.1.1.2 ! root        9: language while avoiding adding GUI toolkit dependencies to Hatari
1.1       root       10: itself. The UI is done with PyGtk i.e. in Python language, using the
                     11: Gtk widget set.
                     12: 
                     13: The main points of this new UI over the Hatari internal one are its
                     14: configurability and providing a GUI for the (console based) debugger
                     15: included with the Hatari emulator.
                     16: 
                     17: Note: this is an additional UI, the built-in Hatari SDL UI isn't being
                     18: replaced or going anywhere!
                     19: 
                     20: 
                     21: Requirements
                     22: ------------
                     23: 
                     24: My guess at the required versions for the dependencies are:
                     25: - Python >=2.4
                     26: - PyGtk >= 2.8   (on Ubuntu PyGtk is in python-gtk2 package)
                     27: 
1.1.1.2 ! root       28: Hatari UI is included with the Hatari sources:
        !            29:        http://hg.berlios.de/repos/hatari/file/tip/
        !            30: 
        !            31: Hatari UI has been tested only on Linux (Ubuntu v7.04 and Debian Etch
        !            32: & Lenny). I would assume it works also on other unix systems such as
        !            33: Apple OSX. It won't work on Windows as the required Windows socket
        !            34: support is missing from the Hatari emulator.
1.1       root       35: 
                     36: Embedding the Hatari emulator window is currently supported only for
                     37: systems using an X window system (from libSDL sources it would seem
                     38: that Windows would also support window embedding, but support for that
                     39: would need to be added both to Hatari and Hatari UI).
                     40: 
                     41: 
                     42: Running
                     43: -------
                     44: 
                     45: Being a Python program, Hatari UI doesn't need to be built.
                     46: You can just run it from where you extracted it (or checked
1.1.1.2 ! root       47: it out of BerliOS HG repo) by calling its wrapper script:
1.1       root       48:        /path/to/script/hatariui
                     49: 
                     50: Or you can run just the debugger:
                     51:        /path/to/script/debugui.py
                     52: 
1.1.1.2 ! root       53: But you can also install it to system along with Hatari:
1.1       root       54:        make install
                     55: 
1.1.1.2 ! root       56: There's also a command line interface for Hatari's remote API
        !            57: called hatari-console.py.
        !            58: 
1.1       root       59: 
                     60: Notes
                     61: -----
                     62: 
1.1.1.2 ! root       63: Hatari UI runs a Hatari version found on $PATH.  If you want
        !            64: to use a version of Hatari that hasn't been installed, you
        !            65: need to modify the search path, for example like this:
        !            66:        PATH=../src:$PATH hatariui
        !            67: 
1.1       root       68: If UI is started without the embedding option, the actions
                     69: (in menus and toolbars) have also shortcuts.  They cannot
                     70: be used when Hatari window is embedded because then those
                     71: shortcuts couldn't be used with Hatari.
                     72: 
                     73: 
                     74: URL: http://koti.mbnet.fi/tammat/hatari/hatari-ui.shtml

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.