Skip to content

reasonset/autoscrolling-text

Repository files navigation

autoscrolling-text

An auto scrolling text reader.

Description

This script generates HTML from text, and show auto-scrollable page with JavaScript.

Use Surf for viewing by default.

Dependency

  • Zsh
  • Pandoc (for Markup mode)
  • Surf (for Default viewer)
  • Python (for UnSurf)
  • PyQt5 (for UnSurf)
  • Python QtWebEngine (for UnSurf)
  • mpv (for BGM)

Usage

autoscroll-text [-m] [-b browser_command] [-c class] sourcefile

You can use $autoscroll_text_overide_browser environment paramater instead of -b option.

surf is used by default.

If you use -m option, sourcefile is treated as Pandoc's input format (e.g. Markdown).

-c option is set class to class on body. These classes are avilable in default stylesheet.

  • default
  • pinkCat
  • babyBlue
  • breezeDark
  • solarizedLight
  • solarizedDark
  • vimDark

If -p option is set, browser is invoked without file:// scheme prefix.

Shortcut keys

Key / Button Behavior
Space / Mouse right button Pause / Play
Up Arrow Speed up
Down Arrow Speed down

Configuration

autoscroll-text is underXDG_CONFIG_HOME .

You can configurate looks by editing scrollingtext.css .

If you are expart. You can configurate behavior by editing scrollingtext.js .

If BGM directory is exists under the directory, script plays it with mpv.

Install

You can install with install script.

This script will be installed for user. Script file will be put under ~/bin .

UnSurf

Description

Ultimate simple webbrowser with QWebEngineView.

You can use this program if you don't use Surf.

Usage

unsurf.py url

Install

Put unsurf.py on PATH.

About

An auto scrolling text reader.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published