storm/cthulhu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This is a fork of the Orca screen reader, mostly just for fun. It's branched from the gnome 45 release. If you haven't heard about this in person and are working on it, you probably do not want to install it. Your distribution should include orca by default, and if you want the source, here is the [Orca git repository](https://gitlab.gnome.org/GNOME/orca).
13 Commits 2 Branches 3 Tags 31 MiB
Python 74%
HTML 13.2%
Roff 11.4%
M4 0.4%
CSS 0.4%
Other 0.6%
09bb9b149f
Go to file
Storm Dragon 09bb9b149f Updated TODO.
2024-10-17 20:48:44 -04:00
ci Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
distro-packages/Arch-Linux Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
docs Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
help Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
icons Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
m4 Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
po Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
src Fixed a bug, (me being forgetful), in the cthulhu-q shortcut. 2024-10-17 18:58:59 -04:00
test Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
.gitignore Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
acinclude.m4 Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
AUTHORS Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
autogen.sh Re-added autogen.sh. 2024-10-17 16:31:50 -04:00
ChangeLog Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
ChangeLog-pre-2.27.1 Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
configure.ac Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
COPYING Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
cthulhu-autostart.desktop Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
cthulhu-autostart.desktop.in Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
cthulhu.doap Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
HACKING Updated the HACKING file. 2024-10-17 17:50:50 -04:00
Makefile.am Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
NEWS Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
pyproject.toml Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
QUICKSTART Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
README.md Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
RELEASE-HOWTO Make sure all files that should be present are present. 2024-10-17 16:33:13 -04:00
TODO Updated TODO. 2024-10-17 20:48:44 -04:00

README.md

Cthulhu v45.3

Introduction

Cthulhu is a free, open source, flexible, and extensible screen reader that provides access to the graphical desktop via user-customizable combinations of speech and/or braille.

Cthulhu works with applications and toolkits that support the assistive technology service provider interface (AT-SPI), which is the primary assistive technology infrastructure for the Solaris and Linux operating environments. Applications and toolkits supporting the AT-SPI include the GNOME GTK+ toolkit, the Java platform's Swing toolkit, OpenOffice/LibreOffice, Gecko, and WebKitGtk. AT-SPI support for the KDE Qt toolkit is currently being pursued.

See also http://wiki.gnome.org/Projects/Cthulhu for detailed information on Cthulhu, including how to run Cthulhu, how to communicate with the Cthulhu user community, and where to log bugs and feature requests.

Dependencies

Cthulhu v45.x is supported on GNOME 45.x only. We highly suggest you use the latest releases of GNOME because they contain accessibility infrastructure and application bug fixes that help Cthulhu work better.

Cthulhu also has the following dependencies:

  • Python 3 - Python platform
  • pygobject-3.0 - Python bindings for the GObject library
  • gtk+-3.0 - GTK+ toolkit
  • json-py - a JSON (https://json.org/) reader and writer in Python
  • python-speechd - Python bindings for Speech Dispatcher (optional)
  • BrlTTY - BrlTTY (https://mielke.cc/brltty/) support for braille (optional)
  • BrlAPI - BrlAPI support for braille (optional)
  • liblouis - Liblouis (http://liblouis.org/) support for contracted braille (optional)
  • py-setproctitle - Python library to set the process title (optional)
  • gstreamer-1.0 - GStreamer - Streaming media framework (optional)

You are strongly encouraged to also have the latest stable versions of AT-SPI2 and ATK for the GNOME 45.x release.

NOTE FOR BRLTTY USERS:

Cthulhu depends upon the Python bindings for BrlAPI available in BrlTTY v4.5 or better. You can determine if the Python bindings for BrlAPI are installed by running the following command:

python -c "import brlapi"

If you get an error, the Python bindings for BrlAPI are not installed.

Running Cthulhu

If you wish to modify your Cthulhu preferences, you can press "Insert+space" while Cthulhu is running.

To get help while running Cthulhu, press "Insert+H". This will enable "learn mode", which provides a spoken and brailled description of what various keyboard and braille input device actions will do. To exit learn mode, press "Escape." Finally, the preferences dialog contains a "Key Bindings" tab that lists the keyboard binding for Cthulhu.

For more information, see the Cthulhu documentation which is available within Cthulhu as well as at: https://help.gnome.org/users/cthulhu/stable/

Scripting Cthulhu

So, you want to write a script for Cthulhu? The best thing to do is start by looking at other scripts under the src/cthulhu/scripts/ hierarchy of the source tree.