Version 2.0.x features - natowi/prs-plus GitHub Wiki

Whats new / has changed from 2.0.x

First of all, PRS+ custom dictionary support is on its way, but still not integrated into the current nightly versions!


Author List

This addon allows you to browse your books by author. It is a basic implementation of the 'Books by Author' functionality already available on non-touch models.

Minimum Books per Author Only list authors with at least this number of books.

Book Management

Pre-x50 models support only a few of the options listed below.

Customize Home Menu Booklist

Show Home Menu Arrows

With this enabled, four arrows will appear in the Home Menu, allowing you to control the booklist.

Page Buttons in Home Menu

This option allows you to change the behaviour of the page buttons when in the Home Menu. By default, they behave as follows:

Previous Previous Books
Next Next Books
Holding Previous Cycle Backward (previous booklist)
Holding Next Cycle Forward (next booklist)

Note that if actions are assigned to the same buttons in "Key Bindings", those will take precedence.

Collections

Add Read Books Collection

Adds a collection showing all opened/read books (the inverse of the 'Unread Books' collection).

Sub-Collections

Allows you to create unlimited extra levels of collections by putting separators in the name.
Here are a few examples based on the default separator (|):

Name Will become
Genres|Fantasy Genres -> Fantasy
Genres|Fantasy|Series|Harry Potter Genres -> Fantasy -> Series -> Harry Potter

It is recommended to use Calibre to automatically create such collection names from available tags/series/etc (for example, like this).

Sub-Collections Separator

This setting determines which character is used to split sub-collections. The default is the pipe character (|).
The other options are: period (.) comma (,) colon (:) semi-colon (;) forward slash (/) tilde (~).

Show Reading Progress

Show for Thumbnails

This option now also allows you to show progress only in the Home Menu.

Hide Saved Notepads

Hides text files created by the 'Save Notepad Data' addon from the home menu & regular booklists.

Book Flags

Allows you to change the looks and behaviour of the 'New' flag.
Automatic 'New' Flag Default behaviour.
Manual 'New' Flag Keep the 'New' flag, but don't remove it automatically.
Manual Checkmark Don't show the 'New' flag. Mark read books with a checkmark instead.

If set to either of the manual options, an entry is added to the book option menu to allow you to toggle the flag.

Mark All Books

Use this entry to mark all your books read or unread in one go.

Clear Page History on Shutdown

If enabled, all page history in all books is wiped on shutdown, to decrease the size of the cache file and improve loading times.
Note that 'current position' information is not removed.

Content Search

This allows the user to search through the text of all books in a list / collection / folder. Access is via the regular search function: when starting a new search, the user is asked whether to do a content search or a regular (title) search.
Note: the content search is a relatively slow and cpu-intensive process. We recommend to use it sparingly.

Page Option Items

This list of settings allows you to hide items from the book option menu. This is mostly useful to prevent the menu from getting longer than 10 items due to new options ('Add to Collection', 'Mark as Read/Unread').

Book Viewer

Most options are only for 600/x50 models, except where 300/505 support is explicit stated!

Touch-related options have been moved to Touch Settings.

Automatic Page Turner

Note that this feature was (by mistake) not included for 600 models. (where it would also consume much power as with 300/505 models)

This option allows you to set the time between page turns. The page turner itself is toggled using an action.
Note: on 300/505 (and on 600, once we add it), the automatic page turner might lead to high battery drain.

Custom View Settings

Activate Custom Settings

Not restricted to the 'Restore' button anymore: you can now choose to overrule any of the default presets (Original, Saturated, Details, Brighter, Darker).

No Flash when Closing Overlays

Enabling this prevents full screen refreshes when closing overlays (option menus, dictionary popup, etc).

Show Parent Items in ToC

For multi-level ToC's, this adds parent items as bookmarks to their own submenu. For instance, say your ToC has an entry 'Part I', which contains other bookmarks (say 'Chapter 1' and 'Chapter 2'). Normally, selecting 'Part I' just shows you the sub-items, but you cannot go to 'Part I' itself. So now, the 'Part I' sub-menu will get an extra entry, which points to the start of 'Part I'.

User EPUB Style (CSS File)

This item is now available from the Option menu while reading a book.

MarginCut (for 300/505)

Implements a basic Margin-Cut-Functionality for 300/505.
Especially for PDF's (but is working with EPUB und LRF too) with zoom-setting "S". Margin-Cut rectangle can only be set in portrait-mode, but will also work in landscape if rotated afterwards.
There is a key-bindable action, but can also be accessed with the size-popup-menu.

New PopUpMenu for 300/505 when Size-Button is pressed

PopUpMenu with direct access to all three (3) base-font-sizes, rotate and margin-cut.
For EPUBs there are additional options to choose from 7 extra-fontsizes, control linespacing, indent and margin.

Extended SizeOverlay for x50

SizeOverlay (the dialog shown when you press the Size-/Magnifier-button) provides extra buttons to control fine-fontsize-tuning, lineheight and text-align. Use the middle-button to access more CSS-Options. Working only with epubs by modifying style.css.
At first use of the extended options in the font dialoge, book font will revert to default. Just select your custom font again.

User Values for CSS Tweaking (see above)

User values for CSS can be put in the file userCSSValues.js in /database/system/PRSPlus/
(After installation there should be two (2) templates ending 300_505 / x50, delete the ending and alter the content in the square-brackets [] to your liking. (Notice that the values for Lineheight in the x_50 dialoge will not change)

Edit extern.css in /database/system/PRSPlus/epub/ to choose which selectors are affected by CSS-tweaking.

PageStyle will be retained

With unaltered reader PageStyle (like margin-remove or multi-columns) will be reset once you change back to the home-screen.
With this alteration, PageStyle will be retained for the current book.
It will be reset to "original" if you open another book.

Browse Folders

Browse Folders can now handle archives (including comic archives) and audio files.

Remark: Development still in progress. There is a problem with the character-encoding (CP-850) in archive processing. Thus archived filenames involving Unicode characters (like German umlauts) may fail.

Archives

Archives have an icon that looks like a folder being squeezed in a vice. If you click on an archive you will see the contents of the archive.

Then if you click on a BOOK in an archive you will be given the choice to "Copy", "Copy and Open" or "Preview" the book. (Note that there is no Preview option on the 505/300 models.) If you choose to Copy (or Copy and Open) the file will be copied to the internal memory. If you choose "Preview" the book will be extracted to a temporary directory and will then open. Once you stop looking at the book it will be deleted (and your previous current book will be restored.)

If you click on an IMAGE in an archive the image will appear. To get back to the file list you need to press OPTIONS and select "Return to List". (PREVIOUS, NEXT and SIZE will work if there are other images in the current folder. This is essentially the same thing as Comics.)

Comics

If, on the other hand, the archive is a CBR, CBZ or CB7 file (let's just call it a COMIC), the icon will be a speech bubble. If you click on a COMIC, you will see the contents of the archive (which may itself be a folder, so click on that). You should (eventually) see a list of images. Click on the first image to start reading the COMIC.

Note that reading a COMIC does not interfere with your current book. It also means that when you browse away from the COMIC your place will not be remembered.

You can use the PREVIOUS and NEXT buttons to move through the COMIC. You can also press the SIZE button to open the zoom function. If you press NEXT while using the zoom function you will stay in the zoom function and the next image will be automatically repositioned to the top left corner.

Audio

Audio (MP3 and AAC) files will now appear in Browse Folders (but not in archives). Click on the audio file to start the music player. Pressing PREVIOUS and NEXT will move through the music files that are located in the current folder. (Note that if there are items of a different sort, like a book or an image, then these will open, thereby closing the music player.)

You can use the shuffle option. However, using shuffle is incompatible with the ".." item (which if randomly selected as "the next track" will send you to the parent folder thereby closing the music player). So if you want to use shuffle make sure you disable the ".." setting in the Browse Folder's settings page.

You can also continue reading if you wish, just as you can with the built-in Audio library, but only the songs in the current folder will be played.

Configuration file to hide specific folders from scanning

All folders noted in /database/system/PRSPlus/dontscan.cfg
are excluded from scanning. All books and pictures in those folders will not show up in any media-node.
Content can by access via BrowseFolders
Initially all folders starting with "Beta" and "ScreenShots" are hidden from the media-nodes.

Dictionary Options (x50)

In addition to the options below, the dictionary popup now shows left/right arrows. These allow you to view the previous/next entry in the dictionary.
No Dictionary with DoubleTap Don't activate the dictionary when double-tapping words.
Popup Position Move the dictionary popup to the top, or 'avoid overlapping selection' (popup shows at the top if selected text is at the bottom, and vice versa).
Close Popup by Page Tap Tap the page to close the popup.
Popup Lines Change the number of lines in the popup.
Keep Selection after Dictionary When going from popup to full-screen dictionary, retain text selection afterwards, so you can see where you left off.
Maximum Word Log Items Maximum number of items to store in Word Logs (both books and dictionaries)
Clear Word Logs on Shutdown Wipe all Word Logs, to decrease the size of the cache file and improve loading times.
Remember Book Dictionary On opening a book, change the dictionary to the one last used for that book.

Key Bindings

Actions can now also be assigned to the Page buttons.

Menu Customizer (600/x50)

Standard apps can now be added to the Home page:
  • Music Player (to show the currently playing song if there is one; if it is not playing it will automatically start; if there is no current song, then the Music Library will open instead)
  • Music Library
  • Text Memos
  • Handwritings
  • Dictionary

Music Player

Volume Increment

Allows you to choose the size of the steps with which the volume is increased/decreased.

Standby/Shutdown

In addition to showing images in standby, it is now also possible to show images when the device is turned off.

Standby/Shutdown Image

Image Type System Standby Function, White Screen, Black Screen, Current Book Cover, Current Screen, Calendar and Events.

If set to 'Calendar and Events', when the reader goes into Standby (or Shutdown) a calendar displaying the current month (including event icons) is displayed, as well as a list of events. If there are any events on the current day, these will be at the top of the event box underneath the "Today's Events" heading. If there are up-coming events in the rest of the current month and in the next month, these will be displayed underneath the "Up-coming Events" heading. (Note that there is a size limit to this box, so only up to six or seven events will be displayed.)
Display Icon Shows an icon in the corner, by which you can tell if the device is in standby or shut down.
Display Custom Text Show custom text in the bottom. To change the text, edit /database/system/PRSPlus/customtext.cfg.
Display Events Overlay If there are events (either today's or up-coming) then an overlay event box will be displayed on top of whatever the standby (or shutdown) image is. So using this option, you can, for example, display the current book cover and also see your events at the same time.

Image Scaling

Allows you to either stretch book covers to fit the screen, or maximize size while keeping aspect ratio.

USB Transfer Mode Dialog

Allows you to either keep reading while charging via USB, or enter data transfer mode.

Auto Standby Time

Allows you to change the time before the reader goes into standby when idle.

Auto Shutdown Time

Allows you to change the time before the reader shuts down when in standby.

Save Notepad Data (600/x50)

This addon allows you to extract text from Notepads created using the reader's Text Memo and Handwriting applications.

Save Text Memo as TXT File If this option is on, whenever you create (or edit) a Text Memo a TXT file will be created containing the contents of the Text Memo. It will be saved in the location indicated by the last option. (Note that if you edit an existing Text Memo, the associated TXT file will be overwritten.) In addition, if you make notes attached to bookmarks, these notes will be saved into a single TXT file associated with that particular book. In this case, changes to existing notes will appear in the TXT file as separate notes. Note that notes attached to bookmarks (and the content of highlights) will be listed in the order they were added, not according to the book's page numbers.
Override Text Memo with TXT File If this option is on, any changes made to the TXT file associated with a particular Text Memo (made while your reader was connected to your computer) will be loaded when the Text Memo is loaded. Note, though, that the Text Memo on the reader will not be updated unless you save the Text Memo after making a change using the reader's Text Memo edit function.
Save Handwriting as SVG File If this option is on, whenever you create (or edit) a Handwriting an SVG file will be created. It will be saved in the location indicated by the last option. This SVG file can then be loaded into an SVG-compatible program (such as Inkscape). (Note that if you edit an existing Handwriting, the associated SVG file will be overwritten.) In addition, if you make scribbles attached to bookmarks, these scribbles will be saved as separate SVG files.
Save Handwriting as JPG File If this option is on, whenever you create (or edit) a Handwriting JPG file will be created. It will be saved in the location indicated by the last option. (Note that if you edit an existing Handwriting, the associated JPG file will be overwritten.) In addition, if you make scribbles attached to bookmarks, these scribbles will be saved as separate JPG files.
Save Contents of Highlights If this option is on, whenever you highlight any text in a book the content of the highlight will be saved into the single TXT file associated with that particular book. Note that the content of highlights (and notes attached to bookmarks) will be listed in the order they were added, not according to the book's page numbers.
Show Save Progress If this option is on, a message will appear on the reader screen indicating that the Notepad data is being saved. Note that error messages will be displayed even if this option is off.
Save to This option allows you to choose where the Notepad data will be saved to. The choices are "Memory Stick", "SD card" and "Internal Memory". Then, in the location you choose, the Notepad data will be saved into a directory entitled "Notepads".

Status Bar

Page Index

Index Style in Books

New option: '5 / 100 (pages to next chapter)'.

Touch Settings

Tap Options

Custom Page Tap Actions This option lets you assign any actions (not only pageturns) to single taps into specific areas of the page. Other than in version 2.0.x, the screen is divided into four areas.
Disable Bookmark Tapping Disable (de)bookmarking by tapping the top right corner of the page.
Extend Link Tap Areas Makes it easier to hit links (e.g. footnotes). Especially useful if Custom Page Tap Actions are enabled.
DoubleTap Speed Set the maximum time between two taps. Increase to make double tapping easier, decrease to improve response time.
Switch Page Tap/DoubleTap Page tap behaves as a doubletap, and vice versa.

Swipe Options

Custom Swipe Actions Assign any actions to four swipe directions (left, right, up, down).
Disable All Swipes Disables all swipe functionality.

Zoom Options

ZoomLock: Panning Enable panning (dragging the page) while in ZoomLock.
ZoomLock: Single Tap Action Zoom out or zoom in when tapping the page.
ZoomLock: Double Tap Action Zoom out or zoom in when double tapping the page.
Move to Top on Next Page In ZoomLock, move to the top of the page after a page turn.

Disable Predictive Text

The keyboard will no longer show words it thinks you're typing.

Developer Tools

CLI App

The CLI (command-line interface) app allows the user to enter bash commands directly on the reader. It should work like a proper linux terminal. You can change the current directory using the 'cd' command (and the current directory is indicated in the prompt). Note that you should probably only use commands that will terminate.

If you want to output the content of a file, use 'more':
more /Data/runonce.sh

The "^" button immediately below the "OK" button will cycle through previous commands.

This app is NOT included in the reader interface by default. If you want to use this app, you will need to uncomment the following lines in the config file for your particular reader model:

600/x50:

{ name: "Cli", parent: "more" },

505/300:

{ name: "Cli", parent: "gamesAndUtils" },

Then build a custom installer.


Available Actions

Utilities

Action Launcher Allows you to execute an action of your choice.
Delete Current Item
Toggle Swiping
Toggle Touchscreen Enables/disables the touch screen. Note: can only be used when bound to a key.
Switch Page Tap/DoubleTap

Book

Go to Previous Book Go to the book opened before the current one.
Reformat Current Book Reformat current lrf/txt book (useful if PRS+ text scale setting has been changed).
User EPUB Style (CSS File) Change CSS file for current book (no reload necessary).
Next Chapter Jump to next chapter.
Previous Chapter Jump to previous chapter.
Toggle True Landscape Mode Enables 'true' landscape mode, which reflows the text instead of Sony's silly default behaviour.
Toggle Automatic Page Turner
Activate ZoomLock

Other

No Action
Goto various nodes Games, Pictures, Periodicals, Collections, Text Memos, Handwritings... and More!
Delete Current Item should work for book, audio and picture
Pause/Play Audio if there is a current song
Booklist: Cycle Forward Home Menu booklist: next booklist
Booklist: Cycle Backward Home Menu booklist: previous booklist
Booklist: Next Books Home Menu booklist: next books
Booklist: Previous Books Home Menu booklist: previous books
Booklist: Select Collection Home Menu booklist: jump to 'Select Collection'

Games

Chess

The AI has been greatly improved. It now uses Toga II v1.3.1 (see http://www.superchessengine.com/toga_ii.htm).

The three levels are defined by the maximum time the AI can take to decide on a move:
  • Fast - 2 seconds
  • Medium - 10 seconds
  • Slow - 30 seconds

The AI also uses a "book" to speed up moves in the early stages of a game. This file is named 'performance.bin' and can be found in the GamesSave folder for Chess:
database/system/PRSPlus/GamesSave/Chess/ in the Internal Memory.
The one that comes with PRS+ was downloaded from http://wbec-ridderkerk.nl/html/download.htm.
You can use your own file, but remember that it will be over-written every time that you update PRS+.

You can now play as black if you wish. Just click the "New Game" button twice (it changes to say "As Black" after the first click; the button says "As Black" when you start Chess so you only need to click it once). The black pieces will now be at the bottom of the screen (and white will make its first move if you are in auto mode).

Interactive Fiction

Interactive Fiction is essentially a "front-end" for Frotz (http://frotz.sourceforge.net/) and Nitfol (http://www.ifarchive.org/indexes/if-archiveXinfocomXinterpretersXnitfol.html). Unfortunately, due to space issues, only Frotz is available on the 505/300 models. Both Frotz and Nitfol are available on the 600/x50 models.

Game files (either .dat or .z5 files; 600/x50 users can also use .z8 and .zblorb files) need to be copied into a specific folder on the reader:
database/system/PRSPlus/GamesSave/Frotz/ in the Internal Memory.

However, 600/x50 models will be able to play a game straight away. The PRS+ installer now comes with "Mortlake Manor", a fairly simple adventure game which should provide people with a gentle introduction to Interactive Fiction: you can't die, you cannot get into a non-winnable situation, and the puzzles are not too hard. (You may find it helps to draw a map as you go, though...)

The following classic Infocom games have been tried and run. (At least, they start. They may not work correctly throughout the entire game.) Many of these only work with customised settings, so make sure the filename is the same as the game name listed below (or given in brackets if the filename differs from the game name):

  • A Mind Forever Voyaging (amfv)
  • Ballyhoo
  • Bureaucracy (bureau) - see note below
  • Enchanter
  • Hitchhiker's Guide To The Galaxy (hhgg)
  • Infidel
  • Leather Goddesses of Phobos (phobos)
  • The Lurking Horror (lurking)
  • Moonmist
  • Planetfall
  • Plunderer
  • Sorcerer
  • Spellbreaker
  • Stationfall
  • Suspect
  • Suspended
  • Trinity
  • Wishbringer
  • Witness
  • Zork1 - see note below
  • Zork2
  • Zork3

SPECIAL NOTE REGARDING BUREAUCRACY:
You will need to create an initial gamesave before you can play the game on your reader. For example, start the game using WinFrotz (http://www.ifarchive.org/if-archive/infocom/interpreters/frotz/WindowsFrotzInstaller.exe), and fill in the license form. When this is completed, the first room description appears. Save the game now, calling the save file 'userinput.sav'. Then copy this file to your reader into database/system/PRSPlus/GamesSave/Frotz/bureau/ in the Internal Memory.

SPECIAL NOTE REGARDING ZORK1:
There was a problem saving and restoring a game in the 'loud' room (Frotz would crash). So, as a work-around, as soon as the player gets close to the 'loud' room, "echo" is added to the input stream automatically, thereby dealing with the 'loudness' problem and allowing the game to continue. Once the 'loud' room has been dealt with, "echo" is not added to the input stream any more. (Note that this workaround will affect the number of moves slightly.)

SPECIAL NOTE FOR 600/X50 USERS:
More recent Interactive Fiction files now work on 600/x50 using Nitfol. However, a particular game may require customised input/output to run correctly. If you would like to play a particular game and it doesn't start or behave properly, please let us know.

The following games have been tested successfully:

  • 9:05 (905.z5)
  • Adventure, also known as Colossal Cave (advent.z5)
  • All Things Devours (devours.z5)
  • Anchorhead (anchor.z8)
  • Bronze (bronze.zblorb)
  • Curses! (curses.z5)
  • Lost Pig (lostpig.z8)
  • Party Foul (partyfoul.zblorb)
  • Savoir-Faire (savoir-faire.zblorb)
  • Slouching Towards Bedlam (slouch.z5)
  • Spider and Web (tangle.z5)

Get games from

⚠️ **GitHub.com Fallback** ⚠️