manual/plugins/goban.tex

   1 \subsection{Goban}
   2 \screenshot{plugins/images/ss-goban}{Goban}{The Rockbox Goban plugin}
   3 Goban is a a plugin for playing, viewing and recording games of Go (also known
   4 as Weiqi, Baduk, Igo and Goe).  It uses standard Smart Game Format (SGF) files
   5 for saving and loading games.  You can find a short introduction to Go at
   6 \url{http://senseis.xmp.net/?WhatIsGo} and more information about SGF files
   7 can be read at \url{http://senseis.xmp.net/?SmartGameFormat} or the SGF
   8 specification at \url{http://www.red-bean.com/sgf/}.\\
   9
  10 This plugin can load all modern SGF files (file format 3 or 4) with few problems.
  11 It attempts to preserve SGF properties which it doesn't understand, and most common
  12 SGF properties are handled fully.  It is possible to view (and edit if you like)
  13 Kogo's Joseki Dictionary (\url{http://waterfire.us/joseki.htm}) with this plugin,
  14 although the load and save times can be on the order of a minute or two on
  15 particularly slow devices.  Large SGF files may stop audio playback for the duration
  16 of the plugin's run in order to free up more memory and some very large SGF files will
  17 not even load on devices with little available memory.\\
  18
  19 \note{The plugin does \emph{NOT} support SGF files with multiple games in
  20 one file.  These are rare, but if you have one don't even try it (the file will most
  21 likely be corrupted if you save over it).  You have been warned.\\}
  22
  23 The file \fname {"/sgf/gbn\_def.sgf"} is used by the plugin to store any unsaved
  24 changes in the most recently loaded game.  This means that if you forget to save your
  25 changes, you should load \fname {"/sgf/gbn\_def.sgf"} immediately to offload the changes
  26 to another file.  If you load another file first then your changes will be lost
  27 permanently.  The \fname {"/sgf/gbn\_def.sgf"} file is also the file loaded if another
  28 is not selected.\\
  29
  30 The information panel which displays the current move number may also contain
  31 these markers: \\
  32
  33 \begin{table}
  34     \begin{rbtabular}{\textwidth}{lX}%
  35       {\textbf{Mark} & \textbf{Meaning}}{}{}
  36       \emph{+ } & There are nodes after the current node in the SGF tree. \\
  37       \emph{* } & There are sibling variations which can be navigated to using the %
  38       \emph{Next Variation} menu option of the \emph{Context Menu}%
  39       \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,%
  40          RECORDER_PAD,MROBE100_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H100_PAD,%
  41          IRIVER_H300_PAD}{ or the %
  42          \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonRec}%
  43          \opt{SANSA_FUZE_PAD,SANSA_CLIP_PAD}{\ButtonHome}%
  44          \opt{RECORDER_PAD}{\ButtonOn}%
  45          \opt{MROBE100_PAD}{\ButtonPower}%
  46          \opt{GIGABEAT_PAD}{\ButtonA}%
  47          \opt{GIGABEAT_S_PAD}{\ButtonPlay}%
  48          \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec} button}. \\
  49       \emph{C } & There is a comment at the current node.  It can be viewed/edited using
  50                 the \emph{Add/Edit Comment} menu option of the \emph{Context Menu}. \\
  51     \end{rbtabular}
  52 \end{table}
  53
  54 \subsubsection{Controls}
  55 \begin{table}
  56     \begin{btnmap}{}{}
  57     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD,SANSA_C200_PAD,%
  58          GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,MROBE100_PAD,%
  59          IAUDIO_X5_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonUp}%
  60         \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}%
  61         \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
  62        \opt{HAVEREMOTEKEYMAP}{& }
  63     & Move cursor up \\
  64     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD,SANSA_C200_PAD,%
  65          GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,MROBE100_PAD,%
  66          IAUDIO_X5_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonDown}%
  67         \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonPlay}%
  68         \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
  69        \opt{HAVEREMOTEKEYMAP}{& }
  70     & Move cursor down \\
  71     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD,IPOD_1G2G_PAD,%
  72          IPOD_3G_PAD,IPOD_4G_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H10_PAD,%
  73          IRIVER_H100_PAD,IRIVER_H300_PAD,MROBE100_PAD,IAUDIO_X5_PAD,RECORDER_PAD,%
  74          ONDIO_PAD}{\ButtonLeft}
  75        \opt{HAVEREMOTEKEYMAP}{& }
  76     & Move cursor left %
  77             \opt{ONDIO_PAD}{if in \emph{board} navigation mode, or %
  78                             retreat one node in the game tree if in %
  79                             \emph{tree} navigation mode} \\
  80     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD,IPOD_1G2G_PAD,%
  81          IPOD_3G_PAD,IPOD_4G_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H10_PAD,%
  82          IRIVER_H100_PAD,IRIVER_H300_PAD,MROBE100_PAD,IAUDIO_X5_PAD,RECORDER_PAD,%
  83          ONDIO_PAD}{\ButtonRight}
  84        \opt{HAVEREMOTEKEYMAP}{& }
  85     & Move cursor right
  86             \opt{ONDIO_PAD}{if in \emph{board} navigation mode, or advance one node in
  87                             the game tree if in \emph{tree} navigation mode} \\
  88     \opt{ONDIO_PAD}{\ButtonOff & Toggle between \emph{board} and \emph{tree}
  89                                    navigation modes \\}
  90     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD,%
  91          SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,%
  92          MROBE100_PAD,IAUDIO_X5_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD}{\ButtonSelect}%
  93         \opt{IRIVER_H10_PAD,RECORDER_PAD}{\ButtonPlay}%
  94         \opt{ONDIO_PAD}{\ButtonMenu}
  95        \opt{HAVEREMOTEKEYMAP}{& }
  96     & Play a move (or use a tool if play-mode has been changed). \\
  97     \nopt{ONDIO_PAD}{
  98         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,IPOD_1G2G_PAD,IPOD_3G_PAD,%
  99              IPOD_4G_PAD}{\ButtonScrollBack}%
 100             \opt{SANSA_CLIP_PAD,SANSA_M200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,%
 101                  GIGABEAT_S_PAD}{\ButtonVolDown}%
 102             \opt{IRIVER_H10_PAD}{\ButtonFF}%
 103             \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}%
 104             \opt{MROBE100_PAD}{\ButtonMenu}%
 105             \opt{IAUDIO_X5_PAD}{\ButtonPlay}%
 106             \opt{RECORDER_PAD}{\ButtonFOne}
 107        \opt{HAVEREMOTEKEYMAP}{& }
 108         & Retreat one node in the game tree \\
 109         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD,%
 110              IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonScrollFwd}%
 111             \opt{SANSA_CLIP_PAD,SANSA_M200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,%
 112                  GIGABEAT_S_PAD}{\ButtonVolUp}%
 113             \opt{IRIVER_H10_PAD}{\ButtonRew}%
 114             \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}%
 115             \opt{MROBE100_PAD}{\ButtonPlay}%
 116             \opt{IAUDIO_X5_PAD}{\ButtonRec}%
 117             \opt{RECORDER_PAD}{\ButtonFThree}
 118        \opt{HAVEREMOTEKEYMAP}{& }
 119         & Advance one node in the game tree \\
 120     }
 121     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD,SANSA_C200_PAD,%
 122          IRIVER_H10_PAD,IAUDIO_X5_PAD}{\ButtonPower}%
 123         \opt{MROBE100_PAD}{\ButtonDisplay}%
 124         \opt{IPOD_1G2G_PAD,IPOD_3G_PAD,IPOD_4G_PAD}{Long \ButtonSelect}%
 125         \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}%
 126         \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}%
 127         \opt{RECORDER_PAD}{\ButtonFTwo}%
 128         \opt{ONDIO_PAD}{Long \ButtonMenu}
 129        \opt{HAVEREMOTEKEYMAP}{& }
 130     & Main Menu \\
 131     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,%
 132          IRIVER_H100_PAD,IRIVER_H300_PAD,MROBE100_PAD,IAUDIO_X5_PAD,%
 133          IRIVER_H10_PAD}{%
 134         \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_CLIP_PAD,SANSA_M200_PAD,SANSA_C200_PAD,%
 135              GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,MROBE100_PAD,%
 136              IAUDIO_X5_PAD}{Long \ButtonSelect}%
 137             \opt{IRIVER_H10_PAD}{Long \ButtonPlay}
 138        \opt{HAVEREMOTEKEYMAP}{& }
 139     & Context Menu \\ }
 140     \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_FUZE_PAD,RECORDER_PAD,MROBE100_PAD,%
 141          GIGABEAT_PAD,GIGABEAT_S_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,SANSA_CLIP_PAD}{%
 142         \opt{SANSA_E200_PAD}{\ButtonRec}%
 143         \opt{SANSA_FUZE_PAD,SANSA_CLIP_PAD}{\ButtonHome}%
 144         \opt{SANSA_C200_PAD}{\ButtonRec}%
 145         \opt{RECORDER_PAD}{\ButtonOn}%
 146         \opt{MROBE100_PAD}{\ButtonPower}%
 147         \opt{GIGABEAT_PAD}{\ButtonA}%
 148         \opt{GIGABEAT_S_PAD}{\ButtonPlay}%
 149         \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
 150        \opt{HAVEREMOTEKEYMAP}{& }
 151     & Go to the next variation when at the first node in a branch \\ }
 152     \end{btnmap}
 153 \end{table}
 154
 155 \subsubsection{Menus}
 156 \begin {description}
 157 \item [Main Menu. ]
 158     The main menu for game setup and access to other menus.
 159
 160     \emph {New. } Create a new game with your choice of board size and handicaps. \\
 161     \emph {Save. } Save the current state of the game.  It will be saved to
 162     \fname {"/sgf/gbn\_def.sgf"} unless otherwise set. \\
 163     \emph {Save As. } Save to a specified file. \\
 164     \emph {Game Info. } View and modify the metadata of the current game. \\
 165     \emph {Playback Control. } Control the playback of the current playlist and
 166     modify the volume of your player. \\
 167     \emph {Zoom Level. } Zoom in or out on the board.  If you set the zoom level, it
 168     will be saved and used again the next time you open this plugin. \\
 169     \emph {Options. } Open the Options Menu. \\
 170     \emph {Context Menu. } Open the Context Menu which allows you to set play modes
 171     and other tools. \\
 172     \emph {Quit. } Leave the plugin.  Any unsaved changes are saved to
 173     \fname {"/sgf/gbn\_def.sgf"}. \\
 174
 175 \item [Game Info. ]
 176     The menu for modifying game info (metadata) of the current game.  This
 177     information will be saved to the SGF file and can be viewed in almost all
 178     SGF readers.
 179
 180     \emph {Basic Info. } Shows a quick view of the basic game metadata, if any
 181     has been set (otherwise does nothing).  This option does not allow editing. \\
 182     \emph {Time Limit. } The time limit of the current game. \\
 183     \emph {Overtime. } The overtime settings of the current game. \\
 184     \emph {Result. } The result of the current game.  This text must follow the
 185     format specified at \url{http://www.red-bean.com/sgf/properties.html#RE} to
 186     be read by other SGF readers.  Some examples are \emph {B+R} (Black wins by
 187     resignation), \emph {B+5.5} (Black wins by 5.5 points), \emph {W+T} (White wins
 188     on Time). \\
 189     \emph {Handicap. } The handicap of the current game. \\
 190     \emph {Komi. } The komi of the current game (compensation to the white
 191     player for black having the first move). \\
 192     \emph {Ruleset. } The name of the ruleset in use for this game.  The \emph{NZ}
 193     and \emph{GOE} rulesets include suicide as a legal move (for multi-stone
 194     suicide only); the rest do not. \\
 195     \emph {Black Player. } The name of the black player. \\
 196     \emph {Black Rank. } Black's rank, in dan or kyu. \\
 197     \emph {Black Team. } The name of black's team, if any. \\
 198     \emph {White Player. } The name of the white player. \\
 199     \emph {White Rank. }  White's rank, in dan or kyu. \\
 200     \emph {White Team. } The name of white's team, if any. \\
 201     \emph {Date. } The date that this game took place.  This text must follow the
 202     format specified at \url{http://www.red-bean.com/sgf/properties.html#DT} to
 203     be read by other SGF readers. \\
 204     \emph {Event. } The name of the event which this game was a part of, if any.
 205     \\
 206     \emph {Place. } The place that this game took place. \\
 207     \emph {Round. } If part of a tournament, the round number for this game. \\
 208     \emph {Done. } Return to the previous menu. \\
 209
 210 \item [Options. ]
 211     Customize the behavior of the plugin in certain ways.
 212
 213     \emph {Show Child Variations? } Enable this to mark child variations on the board
 214     if there are more than one.  Note: variations which don't start with a move are
 215     not visible in this way. \\
 216     \emph {Disable Idle Poweroff? } Enable this if you do not want the \dap{} to turn
 217     off after a certain period of inactivity (depends on your global Rockbox
 218     settings). \\
 219     \emph {Idle Autosave Time. } Set the amount of idle time to wait before
 220     automatically saving any unsaved changes.  These autosaves go to the file
 221     \fname {"/sgf/gbn\_def.sgf"} regardless of if you have loaded a game or used
 222     \emph {Save As} to save the game before or not.  Set to \emph {Off} to disable
 223     this functionality completely. \\
 224     \emph {Automatically Show Comments? } If this is enabled and you navigate to a
 225     node containing game comments, they will automatically be displayed. \\
 226
 227 \item [Context Menu. ]
 228     The menu for choosing different play modes and tools, adding or editing
 229     comments, adding pass moves, or switching between sibling variations.
 230
 231     \emph {Play Mode. } Play moves normally on the board.  If there are
 232     child moves from the current node, this mode will let you follow variations
 233     by simply playing the first move in the sequence.  Unless it is following a
 234     variation, this mode will not allow you to play illegal moves.  This is the
 235     default mode before another is set after loading a game or creating a new
 236     one. \\
 237     \emph {Add Black Mode. } Add black stones to the board as desired. These
 238     stones are not moves and do not perform captures or count as ko threats. \\
 239     \emph {Add White Mode. } Add white stones to the board as desired. These
 240     stones are not moves and do not perform captures or count as ko threats. \\
 241     \emph {Erase Stone Mode. } Remove stones from the board as desired.  These
 242     removed stones are not counted as captured, they are simply removed. \\
 243     \emph {Pass. } Play a single pass move.  This does not change the mode of
 244     play. \\
 245     \emph {Next Variation. } If the game is at the first move in a variation,
 246     this will navigate to the next variation after the current one.  This is
 247     the only way to reach variations which start with adding or removing
 248     stones, as you cannot follow them by "playing" the same move. \\
 249     \emph {Force Play Mode. } The same as Play Mode except that this mode will
 250     allow you to play illegal moves such as retaking a ko immediately without a
 251     ko threat, suicide on rulesets which don't allow it (including single stone
 252     suicide), and playing a move where there is already a stone. \\
 253     \emph {Mark Mode. } Add generic marks to the board, or remove them. \\
 254     \emph {Circle Mode. } Add circle marks to the board, or remove them. \\
 255     \emph {Square Mode. } Add square marks to the board, or remove them. \\
 256     \emph {Triangle Mode. } Add triangle marks to the board, or remove them. \\
 257     \emph {Label Mode. } Add one character labels to the board.  Each label
 258     starts at the letter 'a' and each subsequent application of a label will
 259     increment the letter.  To remove a label, click on it until it cycles
 260     through the allowed letters and disappears. \\
 261     \emph {Add/Edit Comment. } Add or edit a comment at the current node. \\
 262     \emph {Done. } Go back to the previous screen. \\
 263 \end{description}
 264