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.1

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
                      9: language and avoiding adding GUI toolkit dependencies to Hatari
                     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: 
                     28: You will need also Hatari emulator version newer than v1.0.1.
                     29: Currently (2008-07-10) you can get it only from its CVS, like
                     30: you got Hatari UI itself.
                     31: 
                     32: Hatari UI has been tested only on Linux (Ubuntu v7.04) and Debian
                     33: Etch.) I would assume it works also on other unix systems such as
                     34: Apple OSX. It won't work on Windows (the required Windows socket
                     35: support is missing from the Hatari emulator).
                     36: 
                     37: Embedding the Hatari emulator window is currently supported only for
                     38: systems using an X window system (from libSDL sources it would seem
                     39: that Windows would also support window embedding, but support for that
                     40: would need to be added both to Hatari and Hatari UI).
                     41: 
                     42: 
                     43: Running
                     44: -------
                     45: 
                     46: Hatari UI needs a Hatari configuration file to know what are
                     47: the current Hatari version options and their default values.
                     48: If you have never saved the options from the internal Hatari
                     49: UI (invoked normally by F12), do it before using this
                     50: external Hatari UI.
                     51: 
                     52: Being a Python program, Hatari UI doesn't need to be built.
                     53: You can just run it from where you extracted it (or checked
                     54: it out of SF CVS) by calling its wrapper script:
                     55:        /path/to/script/hatariui
                     56: 
                     57: Or you can run just the debugger:
                     58:        /path/to/script/debugui.py
                     59: 
                     60: But you can also install it to system directory by using:
                     61:        make install
                     62: 
                     63: 
                     64: Notes
                     65: -----
                     66: 
                     67: If UI is started without the embedding option, the actions
                     68: (in menus and toolbars) have also shortcuts.  They cannot
                     69: be used when Hatari window is embedded because then those
                     70: shortcuts couldn't be used with Hatari.
                     71: 
                     72: 
                     73: 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.