mirror of https://github.com/YGGverse/Yoda.git synced 2025-01-11 15:28:00 +00:00

PHP-GTK Client for Gemini Protocol

altweb browser composer gemini gemini-browser gemini-client gemini-protocol gtk gtk3 php php-cpp php-gtk smallweb yoda yoda-browser

Go to file

yggverse fd9f69a9f0 update version		2024-12-26 20:58:19 +02:00
.github/workflows	add update step	2024-12-19 19:17:54 +02:00
src	apply escape action to the current page only	2024-12-26 20:55:02 +02:00
.gitignore	initial commit	2024-09-18 15:54:15 +03:00
Cargo.toml	update version	2024-12-26 20:58:19 +02:00
LICENSE	initial commit	2024-09-18 15:54:15 +03:00
README.md	update readme	2024-12-26 19:51:34 +02:00
rustfmt.toml	init rustfmt.toml	2024-09-20 19:09:23 +03:00

README.md

Yoda - Browser for Gemini protocol

GTK 4 / Libadwaita client written in Rust

Important

Project in development!

Features

Interface

Multi-tab
Hotkeys
Bookmarks
Build-in multimedia support
- Images
- Audio
- Video
Certificates
Downloads
History
Proxy
Session
- Window
  - Size
  - Tabs
    - Pin
    - Page
      - Content (cache)
      - Meta
        
        Title
      - Navigation
        
        Request
        
        History
User settings

Protocols

Gemini
- Status code
  - Success
    - 20
  - Input
    - 10 Input
    - 11 Sensitive input
  - Redirection
    - 30 Temporary
    - 31 Permanent
  - Temporary failure
    - 40 Unspecified condition
    - 41 Server unavailable
    - 42 CGI error
    - 43 Proxy error
    - 44 Slow down
  - Permanent failure
    - 50 General
    - 51 Not found
    - 52 Gone
    - 53 Proxy request refused
    - 59 Bad request
  - Client certificates
    - 60 Certificate requested
    - 61 Certificate not authorized
    - 62 Certificate not valid
- Gemtext (by ggemtext)
  - Code (inline/multiline)
    - Inline
    - Multiline
      - Alt
    - Syntax highlight* (by syntect)
    - Terminal emulation* (by ansi-parser)
      - foreground
      - background
      - intensity
      - italic
      - underline
      - blink
      - reversed
      - hidden
      - strikethrough
  - Header
    - H1
    - H2
    - H3
  - Link
    - Address
    - Date
    - Alt
  - List
  - Quote
- Gemfeed
- Titan
NEX - useful for networks with build-in encryption (e.g. Yggdrasil)
- NPS
Localhost
- file:// - local file browser
Request prefix
- about:
  - config - low-level key/value settings editor
- download: - save location to file
- source: - source viewer (by sourceview5)

Media types

Text

text/gemini
text/plain

Images

image/gif
image/jpeg
image/png
image/webp
image/svg+xml

Audio

audio/flac
audio/mpeg
audio/ogg

Video

Build

Requirements

Cairo 1.18
GdkPixBuf 2.42
Glib 2.80
Gtk 4.14
GtkSourceView 5.14
libadwaita 1.5 (Ubuntu 24.04+)
libspelling 0.1

Debian

sudo apt install git curl build-essential\
                 libgtk-4-dev libgtksourceview-5-dev libadwaita-1-dev libspelling-1-dev\
                 libsqlite3-dev libssl-dev

Fedora

sudo dnf install git curl gcc\
                 gtk4-devel gtksourceview5-devel libadwaita-devel libspelling-devel\
                 sqlite-devel openssl-devel

Rust

Use rustup installer to setup latest Rust compiler and Cargo package manager:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install

Stable

cargo install Yoda

run Yoda

Repository

git clone https://github.com/YGGverse/Yoda.git
cd Yoda
cargo build

cargo run

Development

Contribution

Before commit, please make sure:
- new branch created for every new PR git checkout -b 'contribution-name'
- new code follows common rustfmt style cargo fmt --check
- run cargo clippy for final optimization

Contributors

Releases

Package version in repository increase after crates.io release
Until DB migration not implemented, application will create new profile on CARGO_PKG_VERSION_MAJOR.CARGO_PKG_VERSION_MINOR change