fltrdr

A TUI text reader for the terminal.


fltrdr

/

example

/

config

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
# fltrdr config
#
# refer to the 'Commands' section of the help output with
# '--help' or '-h' to view all commands and their descriptions

# set the reader speed in words per minute (wpm)
# <60-1200>
wpm 250

# set number of words visible to the left of the focused word
# <0-8>
prev 1

# set number of words visible to the right of the focused word
# <0-8>
next 3

# set the offset of the focus point
# <0-6>
# 0 will center the focus point
# 1-6 will make the focus point increasingly more left-oriented
offset 2

# toggle full text line visibility
# <on|off>
set view off

# toggle progress bar visibility
# <on|off>
set progress on

# toggle status bar visibility
# <on|off>
set status on

# toggle border top and bottom visibility
# <on|off>
set border on

# toggle border top visibility
# <on|off>
set border-top on

# toggle border bottom visibility
# <on|off>
set border-bottom on

# border top symbol
# <char|unicode-char>
sym border-top ─

# border top mark symbol
# <char|unicode-char>
sym border-top-mark ┬

# border top and border top mark symbol
# <char|unicode-char>
# sym border-top-line ─

# border bottom symbol
# <char|unicode-char>
sym border-bottom ─

# border bottom mark symbol
# <char|unicode-char>
sym border-bottom-mark ┴

# border bottom and border bottom mark symbol
# <char|unicode-char>
# sym border-bottom-line ─

# progress bar symbol
# <char|unicode-char>
sym progress ▁

# meta style, sets the primary colour of the program
# <#000000-#ffffff|0-255|Colour>
# style primary 4feae7

# meta style, sets the secondary colour of the program
# <#000000-#ffffff|0-255|Colour>
# style secondary 2c323c

# meta style, sets the colours of all input text shown in the reader
# <#000000-#ffffff|0-255|Colour>
# style text f0f0f0

# set the text background colour shown to countdown
# after play is pressed and before the reader begins
# <#000000-#ffffff|0-255|Colour>
style countdown 2c323c

# set the colour of the border surrounding the reader
# <#000000-#ffffff|0-255|Colour>
style border 2c323c

# set the colour of the command prompt symbol shown at the start of the line
# <#000000-#ffffff|0-255|Colour>
style prompt 2c323c

# set the success status message colour
# <#000000-#ffffff|0-255|Colour>
style success 55ff00

# set the error status message colour
# <#000000-#ffffff|0-255|Colour>
style error ff5500

# set the progress bar primary colour
# <#000000-#ffffff|0-255|Colour>
style progress-primary 2c323c

# set progress bar secondary colour
# <#000000-#ffffff|0-255|Colour>
style progress-secondary 4feae7

# set the colour of the text in the status bar
# <#000000-#ffffff|0-255|Colour>
style status-primary 2c323c

# set the colour of the file path in the status bar
# <#000000-#ffffff|0-255|Colour>
style status-secondary 4feae7

# set the background colour of the status bar
# <#000000-#ffffff|0-255|Colour>
style status-background 4feae7

# set the colour of the current word in the reader
# <#000000-#ffffff|0-255|Colour>
style text-primary f0f0f0

# set the colour of the words shown on either side of the current word
# <#000000-#ffffff|0-255|Colour>
style text-secondary c0c0c0

# set the colour of the focus point character highlighted in the current word
# <#000000-#ffffff|0-255|Colour>
style text-highlight 4feae7

# set the colour of the punctuation shown in the reader
# <#000000-#ffffff|0-255|Colour>
style text-punct 4feae7

# set the colour of the quotes shown in the reader
# <#000000-#ffffff|0-255|Colour>
style text-quote 4feae7
Back to Top