goreader

README

goreader

FORK From taylorskalyo/goreader

Changed

2024/06/26(#1) [version: v0.0.7]

1. change bookmark file name

   [{book.Title}.mark => {bookFileName}.mark]

2. support add multi bookmark

   save bookmark: pressed m + key1,key2,key3 and then release the m

   load bookmark: pressed n + key1,key2,key3 and then release the n

   e.g.

   pressed m (keeping) and then put down and up 1,2,3 save the bookmark named "123"

   pressed n (keeping) and then put down and up 1,2,3 load the bookmark named "123"

2024/06/07(#2) [version: v0.0.6]

1. add mouse wheel support

2024/06/07(#1) [version: v0.0.5]

1. add hotkey for switch global hotkey hooker
   1. ctrl/command+1,2,3 to switch (hold ctrl/command;press(not hold) 1,2,3;release ctrl/command)

2024/06/06(#3) [version: v0.0.4]

1. add goreader version in help infomation
2. update go version to 1.20

2024/06/06(#2) [version: v0.0.3]

1. fix: use -g model when exit goreader left the hotkey which you have pressed in terminal

2024/06/06(#1)

1. add Hot key hooker when the terminal is not in focus

2024/06/05(#2)

1. Add -nb (not blank line mode)
2. Use the golang flag package instead os.Args

2024/06/05(#1)

1. change Hot key for Next/Previous Chapter
2. Automatically save/restore the last read place of each book
   1. just save chapter and page scroll_Y
   2. the mark is named .{BookTitle}.mark, in the same path with the book.
3. add -d param for print debug log into file(same path with the book)

Terminal epub reader

Goreader is a minimal ereader application that runs in the terminal. Images are displayed as ASCII art. Commands are based on less.

Installation

go install github.com/wormggmm/goreader@[v0.0.1]

Usage

goreader [-h] [-d] [-g] [-nb] [epub_file]

# help print
goreader -h

# print debug info to log file, same path of the book
goreader -d [epub_file]

# none blank line mode
goreader -nb [epub_file]

# hook hotkey can without focus
goreader -g [epub_file]

Keybindings

Key	Action
q	Quit
k / Up arrow	Scroll up
j / Down arrow	Scroll down
h / Left arrow	Scroll left
l / Right arrow	Scroll right
b	Previous page
f	Next page
B	Previous chapter
F	Next chapter
g	Top of chapter
G	Bottom of chapter
Ctrl/Cmd + 1,2,3	switch global hotkey listener
mouse wheel	Scroll like j/h