A command line client for the matrix protocol written in Python 3, largely inspired by Weechat and Poezio.

bobbyblues 9806118641 Creation of a CLI class with stupid ncurse example. 1 month ago
config 2e4a33f3a5 Added shiny rooms when talked to. 1 year ago
old f1b6f84236 Moved python project in an old directory. 2 months ago
src 9806118641 Creation of a CLI class with stupid ncurse example. 1 month ago
.gitignore 72561b917c Initialization of the project, and successful connection to a matrix server. 1 month ago
CMakeLists.txt 9806118641 Creation of a CLI class with stupid ncurse example. 1 month ago
LICENSE.txt 6db490fa41 Creation of skeleton for Stokes. 1 year ago
README.md 91485386c9 Updated readme file. 1 year ago

README.md

Stokes

A command line client for the matrix protocol written in Python 3, largely inspired by Weechat and Poezio.

This client is still work in progress.

How to install

Clone the project, and copy the configuration file to your config directory

mkdir $XDG_CONFIG_HOME/stokes
cp -R Stokes/config/* $XDG_CONFIG_HOME/stokes

If $XDG_CONFIG_HOME is not set, use ~/.config/ instead.

Then edit the config.json file to add your login information. Finally, launch the stokes.py file.

How to use

Here are some available shortcuts:

  • F2/F3: change the rooms list width
  • F4: Hide or show the rooms list
  • F5 or Ctrl+P: Go to previous room
  • F6 or Ctrl+N: Go to next room

Here are some available commands (that you can type as if you were sending a message):

  • /exit: exits Stokes
  • /set-theme X: changes the theme for X where X is the name of a theme file in your config directory.

License

Unless stated otherwise, all files are subject to the zlib license as described in the LICENSE.txt file.

Files in the poezio directory are — or were at some point — part of the poezio (https://poez.io) project and are subject to their own license. See the poezio/POEZIO.txt file for more information.