Enable JavaScript to show search field.

11  Plugins

The manual for MPIO HD200 is incomplete. Keymap definitions for plugins are missing.

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.

11.1 Games
11.1.1 2048
11.1.2 Blackjack
11.1.3 Boomshine
11.1.4 BrickMania
11.1.5 Bubbles
11.1.6 Chessbox
11.1.7 Chopper
11.1.8 Dice
11.1.9 Doom
11.1.10 Flipit
11.1.11 Goban
11.1.12 Jackpot
11.1.13 Jewels

11.1  Games

See also the Chip-8 emulator in section ??, Frotz in section ??, and ZXBox in section ??.

11.1.1  2048


PIC

Figure 11.1: 2048

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

Remote Key

Action




Rewind, Forward, Volume Down, Volume Up

FIXME, FIXME, FIXME, FIXME

Slide tiles

Rec

FIXME

Go to menu

11.1.2  Blackjack


PIC

Figure 11.2: Blackjack

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

Remote Key

Action




Enter betting amount

Hit (Draw new card) / Select

Stay (End hand)

Double down

Pause game and go to menu / Cancel

11.1.3  Boomshine

This is a game coded in Lua that’s a clone of http://www.yvoschaap.com/chainrxn/. It is a rather basic game, but probably a good way to show off some of Lua’s features in Rockbox.

11.1.4  BrickMania


PIC

Figure 11.3: BrickMania

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.

Special items


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

Remote Key

Action




Moves the paddle

Release the ball / Fire

Open menu / Quit

11.1.5  Bubbles


PIC

Figure 11.4: Bubbles

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

Remote Key

Action




Rewind

FIXME

Pause game

Volume Down / Volume Up

FIXME / FIXME

Aim the bubble

Function

FIXME

Fire bubble

Rec or Rec + Play

FIXME

Exit to menu

11.1.6  Chessbox


PIC

Figure 11.5: Chessbox

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.

Keys

Key

Remote Key

Action




Direction keys

Move the cursor

Pick up / Drop piece

Change level

Force play

Show the menu

11.1.7  Chopper


PIC

Figure 11.6: Chopper

Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper?

Key

Remote Key

Action




Make chopper fly

Enter menu

11.1.8  Dice

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

Remote Key

Action




Function

FIXME

Roll dice again

Rec

FIXME

Quit

11.1.9  Doom


PIC

Figure 11.7: Doom

This is the famous Doom game.

Getting started

For the game to run you need .wad game files located in /.rockbox/doom/ on your player. Create the directory and save the following files there:

rockdoom.wad.
The Rockbox .wad, based on prboom.wad from prboom-2.2.6
Your wad files.
Copy all Doom wads you wish to play into that directory.

The needed files can be found at PluginDoom

To play addon wads create the addons directory within the doom directory. Place wad files in this directory. Currently doom only supports a maximum number of 10 addons.

A free alternative for Doom 2 is FreeDoom (http://freedoom.sourceforge.net). This can be used in place of doom2.wad, or it may be used as an addon in Doom, by placing it in the addons directory.

Menus
Rockdoom Menu.
The Rockdoom menu is shown when Doom is first launched. This is the only time it can be accessed (before starting the game). To re-adjust Rockdoom options, you will need to quit your current game and restart the plugin.
Main Menu.
The Doom plugin has a main menu, which is brought up before a game is started. It has the following entries:

Game. Select which (official) wad to launch
Addon. Select which unofficial addon wad to launch (From /.rockbox/doom/addons directory)
Demos. Select which demo file to play on game start
Options. Configure low-level Doom options
Play Game. Launch the wad/addon/Demo chosen

Options Menu.
This menu has the following options:

Sound. Enable or Disable sound in Doom
Set Keys. Change the game key configuration
Time Demo. Run a timed demo, to test game speed on a player (Only runs on Doom Shareware)
Player Bobbing. Enable or Disable player up/Down movement
Translucency. Enable or Disable sprite translucency (Fireballs, Plasma...)
Fake Contrast. Enable or Disable modified game lighting
Always Run. Make the player always run
Headsup Display. Show the player status when in fullscreen
Statusbar Always Red. Disable colour response statusbar

InGame Main Menu.
This menu can only be accessed from within a running game, and is displayed by

New Game. Start a new game
Options. In game options
Load Game. Load a saved game
Save Game. Save the current game
Quit. Quit the game

InGame Options Menu.
This menu has the following options:

End Game. Ends the current game
Messages. Enable or Disable in game messages
Screen Size. Shrink or Enlarge the displayed portion of the game
Gamma. Change the brightness (Gamma) of the game
Sound Volume. Change the sound, music and system volume

Note: In game music is not currently supported

Keys

Key

Remote Key

Action




Move Forward

Down

Turn Left

Turn Right

Shoot

Open

InGame Menu

Enter

Change Weapon

Playing the game

After installation of the wad files is complete you can start the game. more description is needed

11.1.10  Flipit


PIC

Figure 11.8: Flipit

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

Remote Key

Action




Move the cursor

Flip

Shuffle

Solve

Solve step by step

Quit the game

11.1.11  Goban


PIC

Figure 11.9: Goban

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 Long Function 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.


Controls

Key

Remote Key

Action




Rewind

Move cursor up

Forward

Move cursor down

Volume Down

Move cursor left

Volume Up

Move cursor right

Function

Play a move (or use a tool if play-mode has been changed).

Rec+ Rewind

Retreat one node in the game tree

Rec+ Forward

Advance one node in the game tree

Long Play

Main Menu

Long Function

Context Menu

Rec

Go to the next variation when at the first node in a branch

Menus
Main Menu.
The main menu for game setup and access to other menus.
New.
Create a new game with your choice of board size and handicaps.
Save.
Save the current state of the game. It will be saved to /sgf/gbn_def.sgf unless otherwise set.
Save As.
Save to a specified file.
Game Info.
View and modify the metadata of the current game.
Playback Control.
Control the playback of the current playlist and modify the volume of your player.
Zoom Level.
Zoom in or out on the board. If you set the zoom level, it will be saved and used again the next time you open this plugin.
Options.
Open the Options Menu.
Context Menu.
Open the Context Menu which allows you to set play modes and other tools.
Quit.
Leave the plugin. Any unsaved changes are saved to /sgf/gbn_def.sgf.
Game Info.
The menu for modifying game info (metadata) of the current game. This information will be saved to the SGF file and can be viewed in almost all SGF readers.
Basic Info.
Shows a quick view of the basic game metadata, if any has been set (otherwise does nothing). This option does not allow editing.
Time Limit.
The time limit of the current game.
Overtime.
The overtime settings of the current game.
Result.
The result of the current game. This text must follow the format specified at http://www.red-_bean.com/sgf/properties.html#RE to be read by other SGF readers. Some examples are B+R (Black wins by resignation), B+5.5 (Black wins by 5.5 points), W+T (White wins on Time).
Handicap.
The handicap of the current game.
Komi.
The komi of the current game (compensation to the white player for black having the first move).
Ruleset.
The name of the ruleset in use for this game. The NZ and GOE rulesets include suicide as a legal move (for multi-stone suicide only); the rest do not.
Black Player.
The name of the black player.
Black Rank.
Black’s rank, in dan or kyu.
Black Team.
The name of black’s team, if any.
White Player.
The name of the white player.
White Rank.
White’s rank, in dan or kyu.
White Team.
The name of white’s team, if any.
Date.
The date that this game took place. This text must follow the format specified at http://www.red-_bean.com/sgf/properties.html#DT to be read by other SGF readers.
Event.
The name of the event which this game was a part of, if any.
Place.
The place that this game took place.
Round.
If part of a tournament, the round number for this game.
Done.
Return to the previous menu.
Options.
Customize the behavior of the plugin in certain ways.
Show Child Variations?
Enable this to mark child variations on he board if there are more than one. Note: variations which don’t start with a move are not visible in this way.
Disable Idle Poweroff?
Enable this if you do not want the player to turn off after a certain period of inactivity (depends on your global Rockbox settings).
Idle Autosave Time.
Set the amount of idle time to wait before automatically saving any unsaved changes. These autosaves go to the file /sgf/gbn_def.sgf regardless of if you have loaded a game or used Save As to save the game before or not. Set to Off to disable this functionality completely.
Automatically Show Comments?
If this is enabled and you navigate to a node containing game comments, they will automatically be displayed.
Context Menu.
The menu for choosing different play modes and tools, adding or editing comments, adding pass moves, or switching between sibling variations.
Play Mode.
Play moves normally on the board. If there are child moves from the current node, this mode will let you follow variations by simply playing the first move in the sequence. Unless it is following a variation, this mode will not allow you to play illegal moves. This is the default mode before another is set after loading a game or creating a new one.
Add Black Mode.
Add black stones to the board as desired. These stones are not moves and do not perform captures or count as ko threats.
Add White Mode.
Add white stones to the board as desired. These stones are not moves and do not perform captures or count as ko threats.
Erase Stone Mode.
Remove stones from the board as desired. These removed stones are not counted as captured, they are simply removed.
Pass.
Play a single pass move. This does not change the mode of play.
Next Variation.
If the game is at the first move in a variation, this will navigate to the next variation after the current one. This is the only way to reach variations which start with adding or removing stones, as you cannot follow them by “playing” the same move.
Force Play Mode.
The same as Play Mode except that this mode will allow you to play illegal moves such as retaking a ko immediately without a ko threat, suicide on rulesets which don’t allow it (including single stone suicide), and playing a move where there is already a stone.
Mark Mode.
Add generic marks to the board, or remove them.
Circle Mode.
Add circle marks to the board, or remove them.
Square Mode.
Add square marks to the board, or remove them.
Triangle Mode.
Add triangle marks to the board, or remove them.
Label Mode.
Add one character labels to the board. Each label starts at the letter ‘a’ and each subsequent application of a label will increment the letter. To remove a label, click on it until it cycles through the allowed letters and disappears.
Add/Edit Comment.
Add or edit a comment at the current node.
Done.
Go back to the previous screen.

11.1.12  Jackpot


PIC

Figure 11.10: Jackpot

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

Remote Key

Action




Function

FIXME

Play

Rec

FIXME

Exit the game

11.1.13  Jewels


PIC

Figure 11.11: Jewels