~exprez135/castor

ref: 193de0c2079abf371286916b814804f34dd97087 castor/README.md -rw-r--r-- 2.4 KiB
193de0c2Julien Blanchard [gopher] Fix parsing of h type 1 year, 8 months ago

#Castor

A graphical client for plain-text protocols written in Rust with GTK. It currently supports the Gemini, Gopher and Finger protocols.

Gemini:

Screenshot

Gopher:

Screenshot

Finger:

Screenshot

Gemini with some theming:

Screenshot

#Installation

Castor needs a recent Rust version >= 1.39. Please consider using Rustup if you OS does not package a recent version.

#Dependencies

You will need some development libraries:

  • openssl
  • gtk+3
  • gdk-pixbuf
  • pango
  • atk
  • cairo

#Build and install

#Changing settings

You can change some settings like initial URL, colors and delimiters for Headers, Lists, Text and Background. Edit ~/.config/castor/settings.toml and add the values you need. These are the keys currently supported, you can use hex codes, plain colors names or even emojis!

[general]
start_url = "gemini://gemini.circumlunar.space/capcom"

[colors]
h1 = "red"
h2 = "#FF6347"
h3 = "green"
list = "#C71585"
text = "#FF1493"
background = "#FFC0CB"

[characters]
h1 = ">"
h2 = "))"
h3 = "}}}"
list = "🌼"

[monospace]
gemini=false
gopher=true
finger=true

#Using client certificate

Castor expects your certificates to be placed in your home directory and named after the gemini capsule domain. For example to water your plant on gemini://astrobotany.mozz.us/plant you will need to have astrobotany.mozz.us.crt and astrobotany.mozz.us.key available in your home.

#Mailing list

If you have questions, feature requests, bugs or you just want to keep up to date with Castor you can send a message to the mailing list

#Roadmap

You can view my current roadmap here

#Thanks

  • Leonora Tindall for the great article on Rust and GTK that helped me bootstrap this project
  • tiwesdaeg for the incredible icon
  • sloum for the great advices
  • the gemini/gopher/finger community for being awesome