Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a
time. Plugins have exclusive control over the user interface. This means you cannot switch
back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit
it to return to the Rockbox interface. Most plugins will not interfere with music
playback but some of them will stop playback while running. Plugins have the file
extension .rock. Most of them can be started from Browse Plugins in the Main
Menu.
Viewer plugins get started automatically by opening an associated file (i.e. text files, chip8 games), or from the Open with option on the Context Menu.
See also the Chip-8 emulator in section 12.3.3, Frotz in section 12.3.4, and ZXBox in section 12.3.14.
2048 is a simple, addictive puzzle game played by moving tiles in around on a 4x4 grid. Tiles slide as far as possible in the direction chosen by the player each turn until they are stopped by either another tile or the edge of the grid. If two tiles of the same number collide while moving, they merge into a tile with the total value of the two tiles that collided. The resulting tile cannot merge with another the same move. After each move, a tile with the value of 2 or 4 is created in an empty spot on the grid.
The game is won when a tile with a value of 2048 is created, and the player loses when there are no more possible moves.
Note: On players with a small screen tiles with a value greater than 1000 are shortened to “1k”, “2k” and so forth (k is the abbreviation of kilo, which – in computer talk – means a multiple of 1024).
Key | Action |
Play, Submenu, Left, Right | Slide tiles |
Power | Go to menu |
|
Blackjack, a game played in casinos around the world, is now available in the palm of your hand! The rules are simple: try to get as close to 21 without going over or simply beat out the dealer for the best hand. Although this may not seem difficult, blackjack is a game renowned for the strategy involved. This version includes the ability to split, buy insurance, and double down.
For the full set of rules to the game, and other fascinating information visit
http://www.blackjackinfo.com/blackjack-_rules.php
Key | Action |
Left / Right / Play / Submenu | Enter betting amount |
Select | Hit (Draw new card) / Select |
Right | Stay (End hand) |
Left | Double down |
Power | Pause game and go to menu / Cancel |
|
BrickMania is a clone of the classic game Breakout. The aim of the game is to destroy all the
bricks by hitting them with the ball once or more. Sometimes a special item falls down when
you destroy a brick. For a special item to take effect, you must catch it with the paddle. Look
out for the bad ones.
Displayed | Name | Description |
N | Normal | Returns paddle to normal. |
D | Die | Ball dies; lose a life. |
L | Life | Gain a life. |
F | Fire | Allows you to shoot bricks with paddle. |
G | Glue | Ball sticks to paddle each time it hits. |
B | Ball | Immediately fires another ball. |
FL | Flip | Flip left / right movement. |
Key | Action |
Left / Right |
|
Volume Down / Volume Up | Moves the paddle |
Select / Play | Release the ball / Fire |
Power | Open menu / Quit |
|
The goal of the game is to beat each level as quickly as possible by clearing the board of all bubbles. Bubbles are removed from the board when a cluster of three of more of the same type is formed. The game is over when any bubbles on the board extend below the bottom line. To make things more difficult, the entire board is shifted down every time a certain number of shots have been fired. Points are awarded depending on how quickly the level was completed.
Key | Action |
Play | Pause game |
Left / Right | Aim the bubble |
Select | Fire bubble |
Power or Long Power | Exit to menu |
|
Chessbox is a one-person chess game with computer artificial intelligence. The chess engine is a port of GNU Chess 2 by John Stanback.
It also works as a PGN file viewer. Instead of executing the game from the plugin menu, look for any file with .pgn extension in the file browser and execute it. Chessbox will show the list of matches included in the file and allow you to select the one you want to watch. After that, you can scroll back and forth through the moves of the game. If the menu is invoked while in the viewer, the user is allowed to select a new match from the same file or quit the game.
“Force play” while the computer is thinking will cause it to make its move immediately. If done while it’s your turn, the computer will move for you and flip the board so that you are playing from the other side. If you want, you can force play an entire game and watch the artificial intelligence fight against itself.
When you quit the game the current state will be saved and restored when you resume the game. The menu also allows the user to reload the last game saved, save the current position and start a new game without having to quit the game.
Key | Action |
Direction keys | Move the cursor |
Select | Pick up / Drop piece |
Home | Change level |
Volume Up | Force play |
Power | Show the menu |
|
Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper?
Key | Action |
Select | Make chopper fly |
Power | Enter menu |
|
Dice is a simple dice rolling simulator. Select number and type of dice to roll in a menu and start by choosing “Roll Dice”. The result is shown as individual numbers as well as the total of the rolled dice.
Key | Action |
Select | Roll dice again |
Power | Quit |
|
Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor. The aim is to end up with a screen containing tokens of only one colour.
Key | Action |
Play / Submenu / Left / Right | Move the cursor |
Home | Flip |
Home+Left | Shuffle |
Home+Right | Solve |
Home+Select | Solve step by step |
Power | Quit the game |
|
Goban is a a plugin for playing, viewing and recording games of Go (also known as Weiqi,
Baduk, Igo and Goe). It uses standard Smart Game Format (SGF) files for saving and loading
games. You can find a short introduction to Go at http://senseis.xmp.net/?WhatIsGo and more
information about SGF files can be read at http://senseis.xmp.net/?SmartGameFormat or the
SGF specification at http://www.red-_bean.com/sgf/.
This plugin can load all modern SGF files (file format 3 or 4) with few problems. It attempts
to preserve SGF properties which it doesn’t understand, and most common SGF properties
are handled fully. It is possible to view (and edit if you like) Kogo’s Joseki Dictionary
(http://waterfire.us/joseki.htm) with this plugin, although the load and save times can be on
the order of a minute or two on particularly slow devices. Large SGF files may stop
audio playback for the duration of the plugin’s run in order to free up more memory
and some very large SGF files will not even load on devices with little available
memory.
Note: The plugin does NOT support SGF files with multiple games in one file. These are
rare, but if you have one don’t even try it (the file will most likely be corrupted if you save
over it). You have been warned.
The file /sgf/gbn_def.sgf is used by the plugin to store any unsaved changes in the most
recently loaded game. This means that if you forget to save your changes, you should load
/sgf/gbn_def.sgf immediately to offload the changes to another file. If you load another file
first then your changes will be lost permanently. The /sgf/gbn_def.sgf file is also the file
loaded if another is not selected.
The information panel which displays the current move number may also contain these markers:
Mark | Meaning |
+ | There are nodes after the current node in the SGF tree. |
* | There are sibling variations which can be navigated to using the Next Variation menu option of the Context Menu or the Home button. |
C | There is a comment at the current node. It can be viewed/edited using the Add/Edit Comment menu option of the Context Menu. |
Key | Action |
Play | Move cursor up |
Submenu | Move cursor down |
Left | Move cursor left |
Right | Move cursor right |
Select | Play a move (or use a tool if play-mode has been changed). |
Volume Down | Retreat one node in the game tree |
Volume Up | Advance one node in the game tree |
Power | Main Menu |
Home | Go to the next variation when at the first node in a branch |
|
This is a jackpot slot machine game. At the beginning of the game you have 20$. Payouts are given when three matching symbols come up.
Key | Action |
Select | Play |
Power | Exit the game |
|
Jewels is a simple yet addicting game which involves swapping pairs of jewels in order to form connected segments of three or more of the same type.
The goal of the game is to score as many points as possible before running out of available moves. Higher points are awarded to larger combos. The game advances to the next level after every one hundred points and randomly clears several jewels.
In puzzle mode the aim of the game is to connect the puzzles, by skillfully swapping pairs of jewels.
Key | Action |
Left/Right/ Play/Submenu | Move the cursor around the jewels |
Select | Select a jewel |
Power | Menu |
|
This is a simple maze generator that creates perfect mazes that have only one solution.
Key | Action |
Play/Submenu/Left/Right | Navigate maze |
Power | Exit plugin |
Long Select | New Maze |
Select | Display solution (toggle) |
|
The goal of this puzzle game is to escape a dungeon consisting of ten “mazezams”. These are rooms containing rows of blocks which can be shifted left or right. You can move the rows only by pushing them and if you move the rows carelessly, you will get stuck. You can have another go by selecting “retry level” from the menu, but this will cost you a life. You start the game with three lives. Luckily, there are checkpoints at levels four and eight.
Key | Action |
Play, Submenu, Left, Right | Move Character |
Power | Menu |
|
The classic game of minesweeper. The aim of the game is to uncover all of the squares on the board. If a mine is uncovered then the game is over. If a mine is not uncovered, then the number of mines adjacent to the current square is revealed. The aim is to use the information you are given to work out where the mines are and avoid them. When the player is certain that they know the location of a mine, it can be tagged to avoid accidentally “stepping” on it.
Key | Action |
Play / Submenu / Left / Right | Move the cursor across the minefield |
Select / Volume Down | Toggle flag on / off |
Long Select / Volume Up | Reveal the contents of the current square |
Select+Play | Display the current game status |
Power | Exit the game |
|
To beat each level, you must destroy all of the pegs. If two like pegs are pushed into each other they disappear except for triangles which form a solid block and crosses which allow you to choose a replacement block.
Key | Action |
Play, Submenu, Left, Right | to move around |
Select | to choose peg |
Home | to restart level |
Volume Up | to go up a level |
Volume Down | to go down a level |
Power | to quit |
|
Pong is a simple one or two player “tennis game”. Whenever a player misses the ball the other scores.
The game starts in demo mode, with the CPU controlling both sides.
As soon as a button to control one of the paddles is pressed, control of that paddle passes to the player, so for a single player game, just press the appropriate buttons to control the side you want to play. For a two player game, both players should just press the appropriate buttons for their side.
Key | Action |
Volume Up | Left player up |
Volume Down | Left player down |
Play | Right player up |
Submenu | Right player down |
Power | Quit |
|
This is a simple implementation of the Reversi game. The objective of the game is to have a majority of own coloured pieces showing at the end of the game. The game rules can be found in the internet.
You can choose to play manually (you place both the white and dark pieces) or to play against a (not very smart) robot.
In this game, you are robot (#). Your job is to find kitten. This task is complicated by the existence of various things which are not kitten. Robot must touch items to determine if they are kitten or not. The game ends when robotfindskitten.
Key | Action |
Play, Submenu, Left, Right | Move robot |
Power | Quit |
|
Rockblox is a Rockbox version of the classic falling blocks game from Russia. The aim of the game is to make the falling blocks of different shapes form full rows. Whenever a row is completed, it will be cleared away, and you gain points. For every ten lines completed, the game level increases, making the blocks fall faster. If the pile of blocks reaches the ceiling, the game is over.
Key | Action |
Home | Restart game |
Left | Move left |
Right | Move right |
Submenu | Move down |
Volume Down | Rotate anticlockwise |
Volume Up/Play | Rotate clockwise |
Select | Drop |
Hold switch | Pause |
Power | Quit |
|
Rockblox1d is a game for people who find rockblox too hard. In this version the second dimension is missing so the user only has to move the bricks down. No horizontal moving anymore and no need to rotate the brick!
Key | Action |
Submenu | Move down faster |
Power or Long Power | Quit |
|
The games that begin with the “sgt-” prefix are ports of certain puzzles from Simon Tatham’s Portable Puzzle Collection, an open source collection of single-player puzzle games.
Note: Certain puzzles may crash when run with demanding configurations. To prevent this, avoid setting extreme configuration values.
For documentation on the games included, please see the “Extensive Help” menu option from inside the plugin to read puzzle-specific instructions or visit their official website at https://www.chiark.greenend.org.uk/~sgtatham/puzzles/.
By default, each game will only use one of two fonts in drawing: the hard-coded system font for fixed-width text, and the theme’s UI font for variable-width text. For improved puzzle rendering, each puzzle is capable of using a special font pack when it is installed. This font pack is available from http://download.rockbox.org/useful/sgt-_fonts.zip. To install, simply extract the contents of this file to the /.rockbox/fonts/ directory on your device. Once this has been done, each game will dynamically load and use properly-sized fonts whenever needed.
Note: On hard disk-based devices, this may cause a slight delay as the disk spins up to load the fonts when a puzzle is first started, and after using the “Extensive Help” feature.
The “Zoom In” feature is available as an option from the pause menu. It has two modes: viewing mode, and interaction mode. The current mode is indicated in the title bar at the bottom of the screen. This feature is most useful with low-resolution devices and large puzzles.
Viewing mode is entered when the “Zoom In” option is selected, or when Power is pressed in interaction mode. It allows you to pan around an enlarged version of the game. The directional keys pan the image by a small amount in their respective directions, and Select should toggle interaction mode. To return to the pause menu from viewing mode, press Power.
In interaction mode, activated from viewer mode by pressing Select, your device’s buttons all function as they do in the normal gameplay mode, with the exception of Power, which returns the game to viewing mode, whereas in the normal gameplay mode it would return directly to the pause menu. To return to the pause menu from interaction mode, press Power twice.
Note: Using certain features such as the “Zoom In” option may stop audio playback. This is normal, as the game requires additional memory from the system, which will automatically stop playback. The “Playback Control” menu will be hidden whenever this happens. Exiting the game will allow the resumption of audio playback.
The classic sliding puzzle game. Rearrange the pieces so that you can see the whole picture, or switch to number tiles if you like it a little easier Includes one picture puzzle. You can also use the sliding puzzle plugin as a viewer for supported image types, to turn your own pictures into a puzzle.
Key controls:
Key | Action |
Left, Right, Play and Submenu | Move Tile |
Home | Shuffle |
Select | Switch between pictures (default puzzle, and your own image if launched via Open With), and numbered tiles |
Power | Stop the game |
|
This is the popular snake game. The aim is to grow your snake as large as possible by eating the dots that appear on the screen. The game will end when the snake touches either the borders of the screen or itself.
Key | Action |
Play / Submenu / Left / Right | Move snake |
Select | Toggle Play/Pause |
| Go to the plugin’s menu |
|
Another version of the Snake game. Move the snake around, and eat the apples that pop up on the screen. Each time an apple is eaten, the snake gets longer. The game ends when the snake hits a wall, or runs into itself.
Key | Action |
Play / Submenu / Left / Right | Steer the snake |
Select | Pause and resume the game |
Power | Quit |
|
In game A, the maze stays the same, in game B after an increasing number of apples eaten the maze is replaced by a new one.
The object of the game is to push boxes into their correct position in a crowded warehouse with a minimal number of pushes and moves. The boxes can only be pushed, never pulled, and only one can be pushed at a time.
Sokoban may be used as a viewer for viewing saved solutions and playing external level sets with the .sok extension. Level sets should be in the standard Sokoban text format or RLE (Run Length Encoded). For more information about the level format, see http://sokobano.de/wiki/index.php?title=Level_format
Key | Action |
In game
| |
Play, Submenu, Left, Right | Move the “sokoban” up, down, left, or right |
Power | Menu |
Volume Down | Back to previous level |
Select+Right | Restart level |
Volume Up | Go to next level |
Select | Undo last movement |
Home | Redo previously undone move |
Solution playback
| |
Select | Pause/resume |
Play/Submenu | Increase/decrease playback speed |
Left/Right | Go backward/forward (while paused) |
Power | Quit |
|
Some places where can you can find level sets:
Note that some level sets may contain levels that are too large for this version of Sokoban and are unplayable as a result.
This is the classic Klondike solitaire game for Rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist. Though the name may not be familiar, the game itself certainly is. This is due in no small part to Microsoft’s inclusion of the the game in every version of Windows. Though popular, the odds of winning are rather low, perhaps one in thirty hands.
For the full set of rules to the game, and other interesting information visit http://www.solitairecentral.com/rules/Klondike.html
Key | Action |
Play / Submenu / Left / Right | Move Cursor around. |
Select | Select cards, move cards, reveal hidden cards... |
Volume Down | If a card was selected – unselect it, else |
| Draw 3 new cards from the remains stack |
Home | Put the card from the top of the remains stack on top of the cursor |
Long Select | Put the card under the cursor on one of the 4 final colour stacks. |
Volume Up | Put the card on top of the remains stack on one of the final colour stacks. |
Power | Show menu |
|
Spacerocks is a clone of the old arcade game Asteroids. The goal of the game is to blow up the asteroids and avoid being hit by them. Once in a while, a UFO will appear – shoot this for extra points.
Key | Action |
Select | Shoot |
Play | Thrust |
Left/ Right | Turn left/right |
Submenu | Teleport |
Home | Pause game |
Power | Quit |
|
This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator.
Rules: Take all of the “o”s to go to the next level. You can switch control between the filled circle, which can take “o”s, and the filled square, which is used as a mobile wall to allow your filled circle to get to places on the screen it could not otherwise reach. The block cannot take “o”s.
Key | Action |
Left | Move Left |
Right | Move Right |
Play | Move Up |
Submenu | Move Down |
Select | Switch between circle and square |
Select+Left | Previous level |
Select+Submenu | Reset level |
Select+Right | Next level |
Power | Exit the game |
|
Sudoku in Rockbox can act as both a plugin and a viewer. When starting Sudoku from the Browse Plugins menu, a random game will be generated automatically, and an estimate of its difficulty (very easy, easy, medium, hard or fiendish) will be displayed on the screen. New games can be generated from the Generate menu option. When “playing” an existing Sudoku game file from Rockbox’ file browser the plugin is invoked as viewer. The selected Sudoku will get loaded and you can start solving it. The sudoku games need to be stored as text files with the extension .ss as single file per game.
You can create and save your own grids under the New menu option. Enter the menu (as described in the key table below) when you have finished and enter the full path to save to including the .ss extension (e.g. /sudoku/new.ss).
When you play Sudoku on paper most people like to mark numbers in cells that are possible candidates for the cells. This can be done with the scratchpad, shown as separate column. Change the number under the cursor to the number you want to put on the scratchpad and press the scratchpad button, the number will then be added. If the number was already on the scratchpad it will get removed again. The column is stored separately for every cell on the board. The stored values can be displayed inline as small dots by enabling the Show Markings settings.
Note: The scratchpad is not saved when saving the game.
Key | Action |
Play / Submenu / Left / Right | Move the cursor |
Select / Volume Up / Volume Down | Change number under the cursor |
Long Select / Volume Up / Volume Down | Constantly changing the number under the cursor |
Power | Open Menu |
Home | Add/Remove number to scratchpad |
Long Power | Quit |
|
Some places where can you can find .ss files:
Wormlet is a multi-worm game on a multi-threaded multi-functional Rockbox console. You navigate a hungry little worm. Help your worm to find food and to avoid poisoned argh-tiles. The goal is to turn your tiny worm into a big worm for as long as possible.
Game controls:
Key | Action |
Left | Turn left |
Right | Turn right |
Play | Turn Up |
Submenu | Turn Down |
|
Use the control keys of your worm to navigate around obstacles and find food. Worms do not stop moving except when dead. Dead worms are no fun. Be careful as your worm will try to eat anything that you steer it across. It won’t distinguish whether it is edible or not.
On the right side of the game field is the score board. For each worm it displays its status and its length. The top most entry displays the state of worm 1, the second worm 2 and the third worm 3. When a worm dies its entry on the score board turns black.
Xobox is a simple clone of the well known arcade game Qix. The aim of the game is to section off parts of the arena with your trail in order to remove that section from the game. Be careful not to get in the way of enemy balls because, if they hit you or your trail, you lose a life. To finish a level you have to section off more than 75%.
Key | Action |
Play, Submenu, Left, Right | Move around the arena |
Home | Pause |
Power | Open menu |
|
This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background. In Scroll mode the bouncing text is replaced by a different one scrolling from right to left.
Key | Action |
Play/ Submenu | Moves to next/previous option |
Right / Left | Increases/decreases option value |
Select | Toggles Scroll mode |
Power or Long Power | Exits bounce demo |
|
Available options are:
The credits plugin scrolls the entire list of the names of all the Rockbox contributors after displaying the Rockbox logo and version. This plugin is called when selecting Version from the System section of the Rockbox main menu. Exit at any time by pressing Left.
This is a rotating cube screen saver in 3D.
Key | Action |
Select | Display at maximum frame rate |
Play | Pause |
Submenu | Cycle draw mode |
Right / Left | Select axis to adjust |
Volume Down / Volume Up | Change speed/angle (speed can not be changed while paused) |
Power | Quit |
|
Demystify is a screen saver like demo.
Key | Action |
Left / Right | Increase / decrease speed |
Play / Submenu | Add / remove polygon |
Power | Quit |
|
This plugin is a basic frequency analyzer with 3 different frequency-amplitude plots (lines, bars, and spectrogram).
Fire is a demo displaying a fire effect.
Key | Action |
Play / Submenu | Increase / decrease number of flames |
Left | Toggle flame type |
Right | Toggle moving flames |
Power | Quit |
|
This demonstration draws fractal images from the Mandelbrot set using the greyscale engine.
Key | Action |
Direction keys | Move about the image |
Volume Up | Zoom in |
Volume Down | Zoom out |
Select+Left | Decrease iteration depth (less detail) |
Select+Right | Increase iteration depth (more detail) |
Home | Reset and return to the default image |
Power | Quit |
|
Demo showing the Rockbox logo bouncing around the screen.
Key | Action |
Right / Left | Increase / decrease speed on the x-axis |
Play / Submenu | Increase / decrease speed on the y-axis |
Power or Long Power | Quit |
|
This plugin is a visual demo resembling the scrolling code from “The Matrix” (https://en.wikipedia.org/wiki/The_Matrix).
This simple graphics demo draws a mosaic picture on the screen of the player.
Key | Action |
Play | Change the gap between the drawing lines. |
Select | Restart the drawing process. |
Power or Long Power | Exits Mosaique demo |
|
This demo shows the shape of the sound samples that make up the music being played. At faster speed rates, the player is less responsive to user input and music may start to skip.
Key | Action |
Select | Toggle filled / curve / plot |
Submenu | Toggle whether to scroll or not |
Long Select | Toggle drawing orientation |
Play | Pause the demo |
Volume Up / Volume Down | Increase / decrease volume |
Right / Left | Increase / decrease speed |
Power | Exit demo |
|
PictureFlow provides a visualisation of your albums with their associated cover art. It is possible to start playback of the selected album from PictureFlow. Playback will start from the selected track. The PictureFlow plugin will continue to run while your tracks are played.
PictureFlow uses both the album art (see section C) and database (see section 4.2) features of Rockbox. It is therefore important that these are working correctly before attempting to use PictureFlow. In addition, there are some other points of which to be aware:
Key | Action |
Left / Right | Scroll through albums |
Play / Submenu | Scroll through track list |
Select | Enter track list / Play album from selected track |
Left | Exit track list |
Home Home | Enter menu |
Power | Exit PictureFlow |
|
Plasma is a demo displaying a 80’s style retro plasma effect.
Key | Action |
Play / Submenu | Increase / decrease Frequency |
Power / Long Power | Exit |
|
This an implementation of J. H. Conway’s Game of Life (see http://en.wikipedia.org/wiki/Conway%27s_Game_of_Life for a detailed description).
Rockbox can open files with a configuration description (.cells files). Just “play” such file and the game configuration stored in it will be loaded into this plugin.
A .cells file is a text file. A capital ‘O’ marks a live cell, a dot marks a dead cell, all other characters are ignored. Everything on a line starting with an exclamation sign (and including it) is a comment and is ignored.
Key | Action |
Select | Play/pause |
Submenu | Change growth mode |
Right | Next generation |
Left | Status (only when paused) |
Power | Exit |
|
This demo replicates snow falling on your screen. If you love winter, you will love this demo. Or maybe not. Press Power or Long Power to quit.
Starfield simulation (like the classic screensaver).
Key | Action |
Right / Left | Increase / decrease number of stars |
Play / Submenu | Increase / decrease speed |
Power or Long Power | Quit |
|
This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style. The digital meter is modelled after LED volume displays, and the mini-meter option allows for the display of small meters in addition to the main display (as above). From the settings menu the decay time for the meter (its memory), the meter type and the meter scale can be changed.
Key | Action |
Power | Save settings and quit |
Home | Help |
Select | Settings |
Volume Up | Raise Volume |
Volume Down | Lower Volume |
|
Viewers are plugins which are associated with specific file extensions. They cannot be run directly but are started by “playing” the associated file. Viewers are stored in the /.rockbox/rocks/viewers/ directory.
Note: Some viewer plugins can only be used by selecting the Open With... option from the Context Menu (see section 4.1.2).
Viewer Plugin | Associated filetype(s) | Context Menu only |
Shortcuts | .link | |
MS Windows shortcuts | .lnk | |
Chip-8 Emulator | .ch8 | |
Frotz | .z1 to .z8 | |
Image Viewer | .bmp, .jpg, .jpeg, .png | |
Lua scripting language | .lua | |
MP3 Encoder | .wav | x |
Rockboy | .gb, .gbc | |
Search | .m3u, .m3u8 | x |
Shopping list | .shopper | |
Sort | .* | x |
Text Viewer | .txt,.nfo, .* | |
VBRfix | .mp3 | x |
ZXBox | .tap, .tax, .sna, .z80 | |
|
The Shortcuts Plugin allows you to jump to places within the file browser without having to navigate there manually. The plugin works with .link files. A .link file is just a text file with every line containing the name of the file or the directory you want to quickly jump to. All names should be full absolute names, i.e. they should start with a /. Directory names should also end with a /.
Note: This plugin cannot read Microsoft Windows shortcuts (.lnk files). These are handled by a separate plugin; see section 12.3.2.
You can use your favourite text editor to create a .link file on the PC an then copy the file to the player. Or you can use the context menu on either a file or a directory in the file browser tree, and use the “Add to shortcuts” menu option. This will append a line with the full name of the file or the directory to the shortcuts.link file in the root directory of the player. (The file will be created if it does not exist yet.) You can later rename the automatically created shortcuts.link file or move it to another directory if you wish. Subsequent calls of the context menu will create it again.
To use a .link file just “play” it from the file browser. This will show you a list with the entries in the file. Selecting one of them will then exit the plugin and leave you within the directory selected, or with the file selected in the file browser. You can then play the file or do with it whatever you want. The file will not be “played” automatically.
If the .link file contains only one entry no list will be shown, you will directly jump to that location. The file shortcuts.link in the root directory is an exception. After “playing” it, the list will be shown even if the file contains just one entry.
If the list you are seeing is from shortcuts.link in the root directory, you can delete the selected entry by pressing Home. Deleting entries from other .link files is not possible.
Placing the line “#Display last path segments=n” (where n is a number) in the beginning of a .link file will leave just the last n segments of the entries when they are shown. For example, if n is chosen to be 1, then the entry /MyMusic/collection/song.mp3 will be shown as song.mp3. This allows you to hide common path prefixes.
You can also provide a custom display name for each entry individually. To do so, append a tabulator character after the entry’s path followed by your custom name. That name will then be used for showing the entry. For example:
This plugin follows Microsoft Windows Explorer shortcuts (.lnk files). In Rockbox, these types of shortcuts will show up as .lnk files. To follow a shortcut, just “play” a .lnk file from the file browser. The plugin will navigate the file browser to the linked file (which will be highlighted) or directory (which will be opened). Linked files will not be automatically opened; you must do this manually.
Only relative links across the same volume are supported.
Note: You may like to use native Rockbox shortcuts instead. These can be created from within Rockbox itself and have advanced capabilities. See section 12.3.1.
Chip8 is a kind of assembly language for a long-gone architecture. This plugin runs games written using the chip8 instructions. To start a game open a .ch8 file in the File Browser
There are lots of tiny Chip8 games (usually only about 256 bytes to a couple of KB) which were made popular by the HP48 calculator’s emulator for them. The original Chip8 had 64×32 pixel graphics, and the new superchip emulator supports 128×64 graphics.
The only problem is that they are based on a 4×4 keyboard, but since most games do not use all of the buttons, this can easily be worked around.
To do this, one may put a .c8k file with the same name as the original program which contains new key mappings (for BLINKY.ch8, one writes a BLINKY.c8k file). That .c8k file contains 16 characters describing the mapping from the Chip8 keyboard to the default key mapping (that way, several Chip8 keys can be pressed using only one Rockbox key). For example, a file containing the single line:
would correspond to the following non-default mappings:
3 → 2, 6 → 8, 7 →4, 8 → 6.
The default keymappings are:
Chip8 | Off | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F |
Key | |||||||||||||||||
Some places where can you can find .ch8 files:
Frotz is a Z-Machine interpreter for playing Infocom’s interactive fiction games, and newer games using the same format. To start a game open a .z1 to .z8 file in the File Browser. Most modern games are in the .z5 or .z8 format but the older formats used by Infocom are supported.
Z-Machine games are text based and most depend heavily on typed commands. The virtual keyboard is used for text entry, both for typing entire lines and for typing single characters when the game requires single character input.
Sounds, pictures, colour and Unicode are not currently supported, but the interpreter informs the game of this and almost all games will adapt so that they are still playable. This port of Frotz attempts to be compliant with the Z-Machine Specification version 1.0.
Some places where you can find Z-Machine games, and information about interactive fiction:
Key | Action |
Play | Display keyboard to enter text |
Select | Press enter |
Power | Open Frotz menu (not available at MORE prompts) |
Long Power | Quit |
|
This plugin opens image files from the File Browser to display them using Rockbox’s greyscale library. Supported formats are as follows.
Format | File-extension(s) |
BMP | .bmp |
JPEG | .jpg, .jpe, .jpeg |
PNG | .png |
GIF | .gif |
Note: This plugin will cause playback to stop.
Key | Action |
Play / Submenu / Left / Right | Move around in zoomed in image |
Select | Zoom in |
Long Select | Zoom out |
Volume Up | Next image in directory |
Volume Down | Previous image in directory |
Home | Toggle slide show mode |
Power | Show menu / Abort |
|
The menu has the following entries.
Note: Progressive scan and other unusual JPEG files are not supported, and will result in various “unsupported xx” messages. Processing could also fail if the image is too big to decode which will be explained by a respective message.
This plugin encodes a .wav file to MP3 format. The supported input format is uncompressed, linear PCM with 16 bit per sample and a maximum of 2 channels. Allowed sample rates are 16, 22.05, 24, 32, 44.1 and 48 kHz. The user will be asked to select the desired output bitrate of the compressed MP3 file.
Remark: Bitrates above 160 kbps cannot be used in MPEG 2 Layer 3 bitstreams. The encoder plugin automatically limits the output bitrate to 160 kbps for input files with a sample rate of 16, 22.05 or 24 kHz. The same limitation is valid for mono files.
The output .mp3 file is written to the same path as the .wav file using the same filename. To use this plugin, open the Context Menu (see section 4.1.2) on a .wav file and select Open With…→ mp3_encoder.
Note: The encoder will choose the appropriate bitstream format from the sample rate of the input file. The output bitstream format is MPEG 1 Layer 3 for 32, 44.1 and 48 kHz, and MPEG 2 Layer 3 for 16, 22.05 and 24 kHz. MPEG 2.5 Layer 3 is not supported.
Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the
gnuboy emulator. To start a game, open a ROM file saved as .gb or .gbc in the file
browser.
Key | Action |
Play / Submenu Left / Right | Direction keys |
Select | A button |
Home | B button |
Volume Down | Start |
Volume Up | Select |
Power | Open Rockboy menu |
|
This plugin can be used on playlists. It searches through the playlist that it opened on looking for any occurrences of the string entered by the user. The results of this search are saved to a new playlist, search_results.m3u, within the same directory as the original playlist.
Shopper is a plugin which allows you to maintain reusable shopping lists. To create a list, use a text editor to write down a list of items (one per line; note that the line length should not exceed 40 characters) and save the file as <name>.shopper. If you want to separate the items you can do so by creating categories, which are prepended with ‘#’. To open a .shopper file just “play” it from the file browser.
Note that it isn’t possible to choose exact quantities, but you can create a number of entries with different quantities in the name of the item, such as for the apples in the above example.
There are two modes, edit mode and view mode. The edit mode shows all the items, and it allows you to select which of the items you want to buy. When you have finished selecting the items, use the menu to go to the view mode, and you will see only the items you wish to buy. If you ‘select’ an item in view mode then that item will be removed from the list.
When you exit Shopper the last view is saved, including which items you have selected, so if you re-open the shopping list it will be as you left it. There are additional menu options for clearing the list, selecting all items, showing and hiding the categories, toggling the categories, and displaying the playback menu.
Key | Action |
Select or Right | Select or clear an item |
Home or Long Select | Show menu |
Left | Exit |
|
This plugin takes a file and sorts it in ascending alphabetical order. Case is ignored. This is useful for ordering playlists generated by the Create Playlist menu option (see section 5.10).
This is a Viewer for text files with word wrap. Just open a .txt or .nfo file to display it. The text viewer features controls to handle various styles of text formatting and has top-of-file and bottom-of-file buttons. You can view files without a .txt or .nfo extension by using Open with from the Context Menu (see section 4.1.2). You can also bookmark pages.
Key | Action |
Volume Up | Scroll-up |
Volume Down | Scroll-down |
Left | Top of file (Narrow mode) / One screen left (Wide mode) |
Right | Bottom of file (Narrow mode) / One screen right (Wide mode) |
Play | One line up |
Submenu | One line down |
Home | Toggle autoscroll |
Submenu+Select | Set/Reset bookmarks |
Select | Enter menu |
Power | Exit text viewer |
|
To add a bookmark, press Submenu+Select. The bookmark will be displayed as shown below. To delete the bookmark press the same button again.
This plugin offers a way to remove a theme. Open the Context Menu (see section 4.1.2) upon a theme.cfg file and select Open With... → theme_remove. Some files are not removed regardless of the Remove Options such as rockbox_default.wps and the font file currently in use.
One of the following options can be chosen for each setting.
This function scans a VBR (Variable Bitrate) MP3 file and updates/creates the Xing VBR header. The Xing header contains information about the VBR stream used to calculate average bit rate, time information and to more accurately fwd/rew in the stream. This function is especially useful when the playback of a file skips, fwd/rew does not work correctly or the time display is incorrect. To use this plugin, open the Context Menu (see section 4.1.2) upon a .mp3 file and select Open With…→ vbrfix.
Note: VBRfix can only run when music is turned off (since it uses the same memory as the player) and can take a while to complete if run on big files.
ZXBox is a port of the “Spectemu” ZX Spectrum 48k emulator for Rockbox
(https://sourceforge.net/projects/spectemu/). To start a game open a tape file or snapshot
saved as .tap, .tzx, .z80 or .sna in the file browser.
Note: As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible.
The emulator is set up for 5 different buttons: Up, Down, Left, Right and Jump/Fire. Each one of these can be mapped to one key of the Spectrum Keyboard or they can be used like a “Kempston” joystick. Per default the buttons, including an additional but fixed menu button, are assigned as follows:
Key | Action |
Play/Submenu/ Left/Right | Directional movement |
Select | Jump/Fire |
Power | Open ZXBox menu |
|
Due to ZXBox’s simple (but fast) scaling to the screen by dropping lines and columns some games can become unplayable. It is possible to hack graphics to make them better visible with the help of an utility such as the “Spectrum Graphics Editor”. Useful tools can be found at the “World of Spectrum” site (http://www.worldofspectrum.org/utilities.html).
This plugin is an alarm clock, which resumes a paused song at a given time.
Key | Action |
Left / Right | Switch between hours/minutes selection |
Play / Submenu | Increase/Decrease hours/minutes |
Select | Set the alarm |
Power | Exit |
|
First select a track and play it, then launch the “alarmclock” plugin. The plugin pauses the playback. Enter a 24h-time (e.g. 13:58) and set the alarm. Music playback will resume when the set time is reached.
The Battery Benchmark plugin enables you to test your battery’s performance whilst using your player normally. Results can be submitted to the BatteryRuntime wiki page.
Once loaded, Battery Benchmark runs in the background recording various information about your battery to memory. A new point is written to memory every minute. Every time the disk is accessed for any reason (such as refilling the audio buffer, opening a directory or entering USB mode etc.) then the information in memory is written to disk. Once the memory becomes full (after many hours), then the data are written to disk anyway. This is done so that the data are not biased by excessive additional disk accesses. The file is written to the root directory of your player and is called battery_bench.txt. The plugin will continue to log info until:
Benchmarks can be resumed if you accidentally load a plugin, or turn off your player, so long as the log file battery_bench.txt is not deleted.
At the top of the battery_bench.txt file is various information on how to use the plugin, followed by the data themselves.
The log file can be used to tell you how long the battery lasted (with some limitations, see below), but it is most useful for graphing discharge curves in order to improve Rockbox’s estimation of battery level and time remaining. The battery log (battery_bench.txt) is in CSV format (comma separated variables) and thus can be easily imported into a spreadsheet or similar program.
As Battery Benchmark needs to write the data held in memory to disk in order to save them, it is possible that should Rockbox shut down due to low battery then there will not be enough power remaining to write the data to disk. Therefore all measurements since the previous save will be lost.
This is a simple scientific calculator for use on the player. It works like a standard calculator. Pressing the “1st” and “2nd” buttons will toggle between other available math functions.
Key | Action |
Left / Right / Play / Submenu | Move around the keypad |
Select | Select a button |
Home | Delete last entered digit or clear after calculation |
Long Select | Calculate |
Power | Quit |
|
This is a small and simple calendar application with memo saving function. Dots indicate dates with memos. The available memo types are: one off, yearly, monthly, and weekly memos.
You can select what day is first day of week by the setting First Day of Week in the menu.
Key | Action |
Left / Right / Play / Submenu | Move the selector |
Select | Show memos for the selected day |
Volume Up / Volume Down | Previous / Next month |
Power | Quit |
|
The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players.
Key | Action |
Right / Left | Increase / decrease displayed Value |
Select | Move to next screen |
Power | Move to previous screen |
|
The number of the current player is displayed on the top line. The time below is the time remaining for that round (and possibly also the total time left if different).
Keys are as follows:
Key | Action |
Power | Exit plugin |
Submenu | Restart round for the current player |
Select | Pause the time (press again to continue) |
Right | Switch to next player |
Left | Switch to previous player |
Play | Open menu (Select to select.) |
|
From the menu it is possible to delete a player, modify the round time for the current player or set the total time for the game. When the round time is up for a player the message “ROUND UP!” is shown (press NEXT to continue). When the total time is up for a player the message “TIME UP!”is shown. The player will then be removed from the timer.
This is a fully featured analogue and digital clock plugin.
Key | Action |
Left / Right | Cycle through modes |
Play / Submenu | Cycle through skins |
Power | Main Menu |
Select | Start / Stop Counter |
Long Select | Reset Counter |
|
Clock Menu
Note: This setting is not saved to disk.
Small, round, analog clock is displayed in the middle of the LCD. Time readout, if enabled, is displayed at the upper left. If Time readout is in 12-hour (“12h”) mode, AM or PM will be displayed at the upper right. The Date readout, if enabled, is displayed at the lower left. The Counter, if enabled, is displayed at the lower right. The second hand, if enabled, is displayed along with the hour and minute hands. Digit display, if enabled, places “12”, “3”, “6”, and “9” around the face of the clock in their respective positions.
An imitation of an LCD, this mode shows a Clock comprised of digital “segments”. The Date readout, if enabled, is displayed at the bottom, center. The Second readout, if in “Text” mode, is displayed at the top, center; if in “Bar” mode, is displayed as a progress bar at the top of the LCD; if in “Invert” mode, will invert the LCD left-to-right as the seconds pass (a fully-inverted LCD means the entire minute has passed). The Counter, if displayed, is shown at the upper left. The Blinking Colon, if enabled, blinks the colon once every second. 12-hour mode, if enabled, will display the time in a 12-hour format.
Based on the Digital Mode, the LCD mode is another imitation of an LCD. The settings available in this mode are exactly the same as Digital Mode, but they are independent of Digital Mode. For example, you can have the Date Readout enabled in Digital Mode and disabled in LCD Mode.
A Fullscreen clock is displayed. Show Border, if enabled, will draw a small box at every hour position (1 to 12 inclusive). Invert Seconds, if enabled, will invert the LCD as the seconds pass. Second Hand, if enabled, will draw a second hand among the hour and minute hands.
This mode shows a Binary clock. The hour is displayed on the top line, the minute is displayed on the middle line, and the seconds are on the last line. Circle mode, if enabled, draws empty and full circles, instead of zeros and ones. For help on reading binary, please visit: http://en.wikipedia.org/wiki/Binary_numeral_system
This mode shows a “plain” clock in large text that takes up nearly the whole LCD.
To use the plugin, firstly you need to have the dictionary files which contain the words (index) and their description – dict.index and dict.desc, respectively – on /.rockbox/rocks/apps/ folder.
The dictionary files can be created by yourself, or you can get them crafted from the web. More information can be found at PluginDict.
Now that you already have the two necessary files in place, you can launch the dict plugin (under Applications on the Browse plugins menu). The first thing you will see is the text input screen.
Type part of a word (or the whole word) or anything the dict files have a definition to and accept the text input. The plugin will search for matching entries on the dict.index file and display according description/meaning contained in the dict.desc file.
If no matches are found on the dictionary, a “Not found” message will be displayed and the plugin will exit. You can do another search by relaunching the plugin.
Disk Tidy deletes junk files commonly left behind by Windows, Linux and OS X after connecting your player over USB. Select the files you want to delete in the “Files to Clean” menu and select “Start Cleaning” to begin the process. The settings are stored in the plain text file .rockbox/rocks/apps/disktidy.config that is user-modifiable to allow custom entries to be added.
The asterisk character (“*”) can be used as a wild-card which will match any string; however
only the first asterisk will be recognised as a wild-card with any additional uses being taken as
literal.
Warning: Be careful when you use custom entries as you could accidentally delete important files.
Key | Action |
Left | Exit / Abort |
|
Keybox is an encrypted password storage using the “Tiny Encryption Algorithm” with a key derived using md5.
To get started, start up the plugin and select Enter Keybox. The first time you enter Keybox you will be prompted for a master password and for confirmation of the master password. The master password is the password that you must use to access your stored passwords.
Once inside, enter the context menu by pressing Long Select. From the context menu you can create new entries, delete entries and edit entries. Each entry has a “title”, a “user name” and a “password”.
Selecting Reset Keybox from the main menu will delete the current list of passwords and a new, empty list will be created the next time you select Enter Keybox after prompting for a new master password. Entries are automatically saved when the plugin is exited.
Lamp is a simple plugin to use your player as a lamp (flashlight, torch). You get an empty screen with maximum brightness.
Key | Action |
Select | Toggle the button light |
Power or Long Power | Exit to menu |
|
This plugin displays lyrics in .lrc files (and some other formats) synchronized with the song being played.
.lrc8 files are the same as .lrc files except that they are UTF8 encoded. The Lyrics3 tag is not supported.
The following tags are supported:
Each line should resemble one of the following:
The time tag must be in the form [mm:ss], [mm:ss.xx], or [mm:ss.xxx] where mm is minutes, ss is seconds, xx is tenth of milliseconds, and xxx is milliseconds. Any other tags and lines without time tags are ignored.
The plugin checks the following directories for lyrics files. If no lyrics file is found and the audio file is a .mp3, it also checks for SYLT and USLT tags in the id3v2 tags.
If the audio file currently playing is /Music/Artist/Album/Title.mp3, then the following files will be searched for, in this order. .ext is one of the supported extensions from the list above, and will be searched for in the same order as in that list.
Key | Action |
Volume Up / Volume Down | Volume up/down. |
Left | Go to beginning of track, or if pressed while in the first seconds of a track, go to the previous track. |
Long Left | Rewind in track. |
Right | Go to the next track. |
Long Right | Fast forward in track. |
Play | Toggle play/pause. |
Power or Select | Exit the plugin. |
Long Select | Enter timetag editor. |
Home | Enter Lrcplayer Menu. |
|
The display time for each line can be changed with the timetag editor. Selecting a line changes its time to the current position of the track. To set a specific time or to adjust the time, press Long Select to bring up a screen to adjust the time. Changes will be saved automatically when the song is changed. Editing words in lyrics is not supported.
This plugin helps you customizing the main menu (i.e. reorder or hide menu items). It changes the appropriate configuration file as described in section 13.1.1.
When you start the plugin, the available main menu items will be displayed. By pressing Select or Right you open a menu with the following options:
You can leave the plugin without saving by pressing Left.
Open a file, a directory or just launch it from the plugin menu to create an md5sum of the file, the directory’s contents or the whole filesystem. If the file’s extension is .md5 or .md5sum, it will check the md5 sums in the file instead. If the file’s extension is .md5list it will compute md5 sums for all the files listed.
This plugin can be used as a metronome to keep time during music practice. It supports two modes of operation, depending on it being started from the plugin menu or as viewer for tempomap (.tempo) files.
The sound is a piercing square wave that can be heard well also through loud music from a band. In addition, the display also indicates the beats while playing so that you can discreetly place the device in your sight for checking the tempo instead of wearing headphones at a concert.
This is the mode of operation that is active when starting the plugin directly from the menu. It offers a uniform metronome sound at a constant tempo. You can adjust the tempo through the interface or by tapping it out on the appropriate button.
Key | Action |
Long Power | Exit plugin |
Power | Stop |
Long Select | Start |
Select | Tap tempo |
Left / Right | Adjust tempo |
Play / Submenu | Adjust volume |
|
When starting the plugin as a viewer for tempomap files (ending in .tempo), it starts in the track mode that offers playback of a preprogrammed metronome track consisting out of multiple parts, each with possibly different properties.
In contrast to the simple mode, there exists the notion of meter and bars, along with emphasis on certain beats. Parts can have these properties:
The button mapping is different to enable navigation in the programmed track.
Key | Action |
Long Power | Exit plugin |
Power | Stop (stay at position) |
Select | Start from / Stop at current position |
Left / Right | Seek in track |
Play / Submenu | Adjust volume |
|
Navigation The display indicates the part properties and position in track as such:
In this example, the part label is “Interlude”, the meter is 3/4 and the tempo 120 quarter beats per minute (bpm). The volume setting is at -25 and this is the second part of a track with 13 total. In that part, the position is at the second beat of the first bar of five.
The syntax of programmed tracks in tempomap files follows the format defined by http://das.nasophon.de/klick/. Actually, the goal is to keep compatibility between klick and this Rockbox metronome. The parts of a track are specified one line each in this scheme (pieces in [] optional):
The bar count and tempo always have to be specified, the rest is optional.
One example is
for a part named “part I” , 12 bars long, in 3/4 meter with a tempo of 133 quarter beats per minute. Tempo changes are indicated by specifying a tempo range and the acceleration in one of these ways:
The first one goes from 90 to 150 bpm in an endless part with 0.25 bpm increase per bar. The second one goes down from 150 to 90 with 4 bars per bpm change, which is the same acceleration as in the first line. The last one is a part of 16 bars length that changes tempo from 100 to 200 smoothly during its whole lifetime (6.25 bpm/bar). For details on how the acceleration works, see http://thomas.orgis.org/science/metronome-_tempomath/tempomath.html.
It is also possible to provide a tempo for each individual beat in a part by separating values with a comma (no spaces),
where the beat duration is first according to 135 bpm, then 90 bpm, and so forth. You are required to provide a value for each beat in all bars of the part.
You can provide a pattern that controls how the beats are played:
Symbol | Meaning |
X | emphasized beat (Tick) |
x | normal beat (Tock) |
. | silent beat |
Some examples:
The 12/12 for the shuffle create 1/4 triplets. Just do a bit of math;-) This is still a metronome, not a drum machine, but it can act like a basic one, helping you to figure out a certain rhythm within the meter.
The UI is developed so that it fits into the display of a Sansa Clip+ and that is the hardware device it is tested on. It seems to work reasonably on some other models in the simulator.
At last, a more complete tempomap file:
This plugin provides the ability to generate one-time passwords (OTPs) for authentication purposes. It implements an HMAC-based One-Time Password Algorithm (RFC 4226), and on targets which support it, a Time-based One-Time Password Algorithm (RFC 6238).
The plugin supports two methods of adding accounts: URI import, and manual entry.
It is important to note that for TOTP (time-based) accounts to work properly, the clock on your device MUST be accurate to no less than 30 seconds from the time on the authentication server, and the correct time zone must be configured in the plugin. See section 11 for more information.
This method of adding an account reads a list of URIs from a file. It expects each URI to be on a line by itself in the following format:
An example is shown below, provisioning a TOTP key for an account called “bob”:
Any other URI options are not supported and will be ignored.
Most services will provide a scannable QR code that encodes a OTP URI. In order to use those, first scan the QR code separately and save the URI to a file on your device. If necessary, rewrite the URI so it is in the format shown above. For example, GitHub’s URI has a slash after the provider. In order for this URI to be properly parsed, you must rewrite the account name so that it does not contain a slash.
If direct URI import is not possible, the plugin supports the manual entry of data associated with an account. After you select the “Manual Entry” option, it will prompt you for an account name. You may type anything you wish, but it should be memorable. It will then prompt you for the Base32-encoded secret. Most services will provide this to you directly, but some may only provide you with a QR code. In these cases, you must scan the QR code separately, and then enter the string following the “secret=” parameter on your Rockbox device manually.
On devices with a real-time clock, like yours, the plugin will ask whether the account is a time-based account (TOTP). If you answer “yes” to this question, it will ask for further information regarding the account. Usually it is safe to accept the defaults here. However, if your device lacks a real-time clock, the plugin’s functionality will be restricted to HMAC-based (HOTP) accounts only. If this is the case, the plugin will prompt you for information regarding the HOTP setup.
In order for TOTP accounts to work properly, the plugin must be able to determine the current UTC time. This means that, first, your device’s clock must be synchronized with UTC time, and second, that the plugin knows what time zone the clock is using. The plugin will prompt you on its first run for this piece of information. However, should this setting need changing at a later time, possibly due to Daylight Saving Time adjustment, it is located under the “Advanced” submenu. NOTE: in the UI simulator, use the “UTC” setting no matter what the clock may read.
The periodic table plugin allows easy browsing and viewing of details of elements, giving a detailed output for each selection. Navigate the table using the directional keys, pressing back or exit exits the plugin.
Key | Action |
Play, Submenu, Left, Right | Move cursor |
Power | Quit |
|
With the Pitch Detector, you can play a note on a musical instrument, and the plugin will tell you what note it is (e.g. A, A#, B, etc.) The frequency will also be displayed. This may be a great assistance when tuning a musical instrument.
Key | Action |
Power | Open menu |
Long Power | Exit |
|
This plugin is used to configure the folders which will be considered when the Auto-Change Directory feature is set to Random.
Key | Action |
Select or Right | Delete selected folder |
Long Select | Bring up the context menu which allows you to remove the selected folder or its entire folder tree |
Left | Exit |
|
The resistor calculator is a plugin that works in 3 modes:
In Colour to Resistance mode, use the menus to select the colours of the bands of a resistor which you would like to know the resistance of.
In Resistance to Colour mode, use the menus to select the unit that you would like to use (choose from Ohms, Kiloohms, Megaohms), and use the on-screen keyboard to input the value of the resistor that you would like to know the colour code of. The colour codes are presented textually.
LED resistance calculator is used to determine the resistor necessary to light an LED safely at a given voltage. First, select the voltage that the LED will use (the first option is the most common and a safe bet), and the current that it will draw (likewise with the first option). Then, use the onscreen keyboard to type in the supply voltage and, if selected, the custom forward current. This function produces safe estimates, but use your own judgement when using these output values. Power rating and displayed resistance are rounded up to the nearest common value.
The stats plugin counts the directories and files (the total number as well as the number of audio, playlist, image and video files) on your player. Press Power or Long Power to abort counting and exit the plugin. Press it again to quit after counting has finished.
A simple stopwatch program with support for saving times.
Key | Action |
Power | Quit Plugin |
Right | Start / stop |
Left | Reset timer (only when timer is stopped) |
Select | Take lap time |
Play / Submenu | Scroll through lap times |
|
This plugin allows you to view and edit simple text documents on your DAP. You can view files by using Open with from the Context Menu (see section 4.1.2).
If you start the Text Editor from the plugin browser you will be greeted with a blank screen. When started from the Open with menu item your file should be shown on the screen. You can now edit the file. The Text Editor is line based. This means you can edit one line at a time using the Virtual Keyboard (see section 4.1.3).
Note: When you have not changed the file the Text Editor will quit immediately.
Key | Action |
Select or Right | Edit Line / Select Character |
Left | Exit / Abort Editing |
Home | Show Item Menu |
Long Select | Delete Line |
|