You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
NunoSempere 8a1e0be30d
tweak README
3 months ago
images move images, add architecture image 3 months ago
plugins some code simplification 3 months ago
user-scripts check out that ubuntu 20 installation files also work with debian 12 6 months ago
.gitignore start keeping track of rose binary 1 year ago
README.md tweak README 3 months ago
TODO.md tweak README, extract TODO to separate file 3 months ago
config.h rename "keys" to shortcuts, put bar functions together 3 months ago
license chore: more upkeep. In particular, document wyebadblock better 1 year ago
makefile tweak README, extract TODO to separate file 3 months ago
rose tweak README to add architecture, tweak makefile to make fast. 3 months ago
rose-mklink Revert "tweak: move things around" 1 year ago
rose.c formatting pass. 3 months ago
style.css Revert "css tweaks; to be reverted" 1 year ago

README.md

Rosenrot

Rosenrot is a small browser forked from an earlier version of rose. It has some additional quality of life improvements tailored to my (@NunoSempere) tastes and setup, and detailed installation instructions for Ubuntu 20.04.

Installation and usage

You can see detailed instructions here, for Ubuntu 20.04 in particular—though they should generalize easily to other distributions. Or a video installing rosenrot in a fresh Ubuntu 20.04 virtual machine here.

The general steps are to install dependencies, and then

make build
make install # or sudo make install
rose

You can also collect some profiling info, and then use that to get a perhaps faster version:

make fast ## will ask you to use the browser for a bit
make install
rose

You can also create a rose.desktop file so that it will show up in your desktop environment. You can see this documented here.

Features

  • Tabs, cookies, caching
  • Minimal ui, autohiding elements
  • ~454L core code (the rose.c file)
  • Customize appearance of the browser through css
  • Built-in rose-mklink script for in-shell static links
  • Optional adblocking through wyebadblock
  • Plugin system, seeded with:
    • Libre redirect: Redirect annoying websites to open source frontends
    • Readability: Strip webpages of unnecessary elements for ease of reading with a custom shortcut
    • Custom style: Override the css of predetermined websites
    • Max number of tabs (by default 8), configurable.
    • Stand in plugin: Mimick function definitions which do nothing for the above plugins so that they can be quickly removed

You can see some screenshots in the images folder.

Comparisons

Relationship with rose

  • Rose is a small browser based on webkit2gtk. Previously, it described itself as aiming to be a "basement for creating your own browser using [the] gtk and webkit libraries". It has since diverged into a more featureful small browser with lua bindings, and rebased its history. You can see the original, minimal version here.
  • Rosenrot is my (@NunoSempere's) fork from that earlier minimal rose. It has accumulated quality of life features and, honestly, cruft, that I like, like a "readability" plugin that simplifies annoying websites like Matt Levine's Money Stuff newsletter. It also incorporates ad-blocking.
  • Rosenrot is also a song by the German hardcore rock band Rammstein.

Comparison with surf

  • Surf is another browser based on GTK/Webkit, from the suckless community.
  • It is significantly more complex: surf.c has 2170 lines, vs rose.c's 454.
  • I find its code messier and harder to understand.
  • Conversely, surf has significantly more configuration options, and digs deeper into webkit internals.
  • Anecdotically, surf feels slower, though I haven't tested this rigorously.
  • surf has a larger community, with patches and modifications.
  • surf is more opinionated, but also less amateurish.
  • My recommendation would be to use rosenrot, and if you find some feature missing, either look how surf does it and import it to rose, or move to surf.
    • But then again, I've built rosenrot to cater to my own tastes, so I'd say that.

Folk wisdom

Of general interest:

  • I just found out that you can inspect a GTK application with the GTK explorer if you set a certain command-line variable. Try this with make inspect.
  • Static variables keep their value between invocations.
  • By default the searchbar is pretty gigantic. I've made this so because I'm a bit myopic, but also work with my laptop in a laptop stand. Anyways, if you are a more normal person you can change this in the style.css.
  • The style.css usage isn't updated until installation. This is because by default rose uses the theme located in /usr/share/themes/rose/style.css, and that file isn't updated until make install.

The "architecture" of the application looks as follows:

Specific to my own system:

  • At some point, I tried to install libsoup-3 and borked some unknown installation option/paths. So now I need to run rose with GIO_MODULE_DIR=/usr/lib/x86_64-linux-gnu/gio/modules/ /bin/rose (or put export GIO_MODULE_DIR=/usr/lib/x86_64-linux-gnu/gio/modules/ in my .bashrc). This won't affect new users though, just double checked on a fresh machine.