path: root/manual
AgeCommit message (Collapse)AuthorFilesLines
2017-03-15SVG image of the Benjie T6/AGPTek Rocker and other formats for the manual.Szymon Dziok3-0/+839
Change-Id: I31f24d3880bad63f5b7b1fe492011b1454e0a096
2017-03-15Better graphic for the Creative Zen Xfi Style.Szymon Dziok3-379/+6310
More realistic pattern on the body, the old version is underneath, on the "Old" layer. Change-Id: Ie732bde672deaabfa2aef31f72be92ddb37ffb15
2017-01-17Selective Backlight/Advanced Softlock - Selective actions based on contextWilliam Wilgus3-146/+234
Selective backlight allows the user to choose actions that will not enable the backlight when pressed. Advanced softlock allows user to choose actions that will not be blocked by screenlock on devices without a hold button. Both only occur in FM and WPS Contexts. Update: Back from the dead -Cleaned up code, removed unnecessary calls, re-arranged last filter action timeout conditional to work in case last_filtered_action_tick was never set -Added entries to the manual -Fixed back button on some menus not activating backlight -Made menus more intuitive, no actions selected now changes menu item to off. -Added talk fuctionality. -Added option to disable selective backlight while on external power. -Rewrote backlight and softlock handling code to fix issue with scrollwheels -Menu changed to have toggle(yes/no) and settings -Optimized selective actions lookup -Added option to disable notification of 'buttons locked' while softlocked -Removed uneeded code, consolidated action lookup to single function -Fixed incorrect name on selective softlock menu -Added option to disable touch on touchscreen devices -Fixed backlight on original screenlock without selective screenlock active -Added text selection in mask_select for when show_icons is off -Fixed voice in mask_select to speak if voice is defined instead of spelling -Added more lang defines (play skip seek) -Added option to disable unknown keys turning on backlight -Fixed Conditional argument In wrong place causing players without backlight to fail to build -Fixed Disable Unknown blocking detection of context change -Fixed canceling menu didn't update new settings -Added Autolock on backlight off -Removed backlight_on_force from backlight.c, Now sets ignore next to false and uses backlight_on -Cleaned up autolock code added strings to lang file -Fixed issue where rapid presses would bypass softlock -Removed old softlock code, Cleaned selective actions code -Changed menu to match existing RB menus -Fixed Backlight_on_Hold blocked by backlight_ignore_next -Fixed ignore_next for ipod -Fixed bug allowing context with softlock to bypass selective backlight -Changed mask_select to no longer prompt for changes to be saved -Changed menu names -Added ignore timeout to allow ipod scroll wheel to work properly and other players to still work properly, removed some previous code including ignore_event -Increased ignore timeout to prevent sd card accesses from interrupting action code and turning on backlight -Changed Unknown action to unmapped action in menu, changed handling code -Removed unneeded logic and variables for handling unfiltered actions -Reverted unmapped action code to previous functionality -Added manual entries (thanks JohnB) -Removed elusive unhandled unicode character from manual, changed formatting slightly Actions: Volume,Play,Seek,Skip Extras: Disable unmapped actions Disable selective backlight on external power Disable touch during softlock on touchscreen devices Disable softlock notifications (power button still notifies) Autolock on backlight off Method: Adds a function to ignore backlight on next call If selected action occurs backlight is forced on, Filter_first_keypress stays intact. Selective softlock allows selected actions through, bypasses the normal softlock routine. ToDo: DONE previous commit (#1) has attribution for folder_select.c which mask_select is based from. Change-Id: I08132ddcfd64c81751ef23b720f3ec6d68695fe4
2016-12-18Port of Simon Tatham's Puzzle CollectionFranklin Wei28-0/+9
Original revision: 5123b1bf68777ffa86e651f178046b26a87cf2d9 MIT Licensed. Some games still crash and others are unplayable due to issues with controls. Still need a "real" polygon filling algorithm. Currently builds one plugin per puzzle (about 40 in total, around 100K each on ARM), but can easily be made to build a single monolithic overlay (800K or so on ARM). The following games are at least partially broken for various reasons, and have been disabled on this commit: Cube: failed assertion with "Icosahedron" setting Keen: input issues Mines: weird stuff happens on target Palisade: input issues Solo: input issues, occasional crash on target Towers: input issues Undead: input issues Unequal: input and drawing issues (concave polys) Untangle: input issues Features left to do: - In-game help system - Figure out the weird bugs Change-Id: I7c69b6860ab115f973c8d76799502e9bb3d52368
2016-12-12manual: document 3D enhancementAmaury Pouly4-0/+17
3D "enhancement" is available on all imx233 platform, and also on platforms with the WM8978 codec (gigabeats) and WM8750 codec (MPIO HD 200/300). I used different texts for different codecs because (in theory) they do different "things". Change-Id: I62ecb075f7594427491b6be83cfa80f763566aba
2016-11-06SVG image of the Creative Zen Vision, plus other formats for the manual.Szymon Dziok3-0/+4979
Change-Id: Ib6fa4a71014f718dd05cb754b80156c2e74ca1ea
2016-08-22Fuze+: fix manual (alarm keymap)Sebastian Leonhardt1-3/+3
Change-Id: I5d685b7e102bbde8af0b33143feea07a8513f788
2016-08-16manual: fix/remove broken linksSebastian Leonhardt6-10/+7
Change-Id: Ic6a53490b91c891e53feba3804957b0dffcfc074
2016-06-14Remove chapter magic in table of contents for scrreprt tex4ht.Frank Gevaerts1-12/+0
This fixes html builds. Don't ask. Change-Id: Icb034a5c3ca74af887e31063007f41f9ef8be404
2016-06-14Update old \tt and \sc macrosFrank Gevaerts1-7/+7
Change-Id: I016d946e48590039bcedd7dd5ec41322b0ef17ea
2016-06-06manual: add screenshots for 2048Franklin Wei21-1/+1
* These were automatically generated by Amaury Pouly * For details read Change-Id: I4584b07023f5e37b13a7483e60f9d30d3c7c9d69
2016-06-05One-Time Password client (HOTP and TOTP)Franklin Wei3-0/+76
* Implements RFC 4226 (HOTP) and RFC 6238 (TOTP) * Adds sha1.c to apps/plugins/lib (orignally tools/hmac-sha1.c) * See manual entry for more information Change-Id: Ia4a4031b29f97361b541e71438aa7f3ea82212f2
2016-04-15Manual: Add missing pluginsSebastian Leonhardt11-7/+184
The text is usually only a short description taken from the wiki and don't contain screenshots or keymaps, but should be better than nothing. :) Added manual entries: - Boomshine - Dict - FFT - main_menu_config - Matrix - Maze (including keymap) - PDbox - Superdom Additional changes/fixes: - fix "Clix" alphabetical order - add Frotz & ZXBox to games preamble Change-Id: I169870420cbac8123695747ccfcbaaf3478c11cc
2016-01-11Plugin 2048: optimize small tilesSebastian Leonhardt1-0/+4
Change 12x12 and 22x22 sized tiles to hand-optimized ones with better readibility :) Tile values >= 1024 are abbreviated to "1k", "2k" etc. Change-Id: I15f4649b20442b71027a3b1564bc51c7e72105ce
2015-12-27Samsung YH820/92x keymap bugfixesSebastian Leonhardt10-36/+48
This patch fixes some (mostly small) plugin issues with the "big" YH-keymap patch (a507b). Only one fix affects the main keymaps (virtual keyboard "DONE" now exits after long key /release/ instead of long button /press/). Change-Id: Id34f925ebfa97ae4974cd9405fbe1fee4f597833
2015-11-15YH8xx,YH9xx: Keymap improvementSebastian Leonhardt45-181/+262
The main "innovation" in this patch are two "virtual buttons" for the record switch on YH92x targets. When the switch state changes, a single BUTTON_REC_SW_ON or .._OFF button event will be generated. Thus keymap code can react on switching, but not on the actual state of the switch. Wherever sensible, the following user scheme is applied: - use PLAY as confirm button - use REW button or Long REW to exit - use REC (YH820) or FFWD (YH92X) as modifier key for button combos Change-Id: Ic8d1db9cc6869daed8dda98990dfdf7f6fd5d5a1
2015-09-28Snake2: add 128x96x16 bitmapsSebastian Leonhardt1-0/+0
These fit by pure chance exactly the YH820 screen :) Change-Id: I0f7a7f5d14aa0497da5ddf63cf1f95a2c4989460
2015-09-24Shopper: slightly improve plugin and manualSebastian Leonhardt1-1/+47
* improve manual (hopefully fixes fs#11988). Parts of the description are taken from fs#10820. * move ACTION_STD_CONTEXT from alternate select to alternate menu action, as not all targets have ACTION_STD_MENU * add menu entries for "Quit" and "Quit without saving" Change-Id: Iec86a1608756a899f9f9d7ec7d479838dfd1d95f
2015-04-21Fix html manual for the Packard Bell Vibe 500.Szymon Dziok1-1/+1
Change-Id: I1f39cb93081738e757101cdf6aeb5e3a1ca0e42c
2015-04-21Fix snake plugin manualSebastian Leonhardt1-9/+10
I copied the direction button description from snake2 manual, as both snakes seem to have the same controls. No guarantee however :) Change-Id: I8ca1ccf75f0737d5a922aae207c7c7efef5ec026
2015-03-20SVG image of the Sandisk Sansa m200 and other formats for the manual.Szymon Dziok3-0/+1203
Change-Id: Ifed332a063d7b0daf81c4422f93c1fcae46f45aa
2015-03-06Mini 2440: make the SVG brighter.Szymon Dziok1-27/+27
Change-Id: I7f65e5459280fd95371c606f86385672eb9aa1dc
2015-03-05SVG image for the Mini 2440.Szymon Dziok1-0/+1466
Done mainly for use on the simulators page. Change-Id: I1c2e758f5ec02eb783f3d2e9b31c65b8770bd860
2015-02-22Lamp plugin: Allow toggling the button light using "select".Frank Gevaerts1-0/+8
Change-Id: I0f276a74010ef463ebdb0eb0cc00fc50123966f0
2015-02-03Enhancement of the metronome plugin:Thomas Orgis1-1/+174
- square sine tick and tock sounds (more annoying, more useful;-) - optical indication of tics on display - unification of mode of operation for SWCODEC and HWCODEC (tested on simulator) Both playback and display drawing happen in main loop, always. - operating in two modes now: -- 1. classic dumb metronome --- active when openened as application without file to open --- the usual functionality with tapping and bpm change --- controls indicated on display -- 2. track mode with programmable series of parts --- active when started as viewer for a .tempo file --- differing meters (4/4, 3/4, 6/8, etc.) --- patterns (tick/tock/silence on each beat) --- smooth tempo changes in those tracks This version had lots of testing regarding metronome accuracy, resulting in the realization that PLL A and PLL B differ on the Clip+, causing drift. There is still drift when the timer intervall is too small, so I settled on 2 ms as compromise. This is the final version, after adding documentation and extensive help from Sebastian Leonhardt testing it on slower hardware (YH820), where it works up to 650 actual bpm with display indication. Latest change: Documentation nitpicks. Change-Id: I764c8252526db188352385c5462f9453d882beb9
2015-01-22Fix some language in the sound settings manual.Michael Giacomelli1-13/+16
Change-Id: Ia487a903a221dda6cb81cf409cd18d1fb6522123
2015-01-20Fix typo in zxbox.tex that broke the manual builds for some targetsFrank Gevaerts1-1/+1
Change-Id: I38e5ba2a99c807e6d24f39e9e75ad3df39cc0bf1
2015-01-19three new DSPsChiwen Chang1-0/+27
perceptual bass enhancement - a bbe-ish group delay corrction with Biophonic EQ boost. - precut auditory fatigue reduction -reduce signal in frequency that may trigger temporary threshold shift haas surround -frequency between f(x1) and f(x2) is always bypassed. -can apply to side only. Change-Id: Icb6355ce9b1c99bf2c58c9385c3c411c0ae209d3
2015-01-12SVG image of the Samsung YP-R1 and other formats for the manual.Szymon Dziok3-0/+5296
Change-Id: I95cdba5f8db0f4789e7c954f49c1ee9c79cba29f
2015-01-12Set latex input to /dev/null to avoid blocking on errorsFrank Gevaerts2-3/+3
Change-Id: If8878efb5d4244f5d25b9bfd4751a262080af53f
2015-01-08Include scrreprt.4ht from ↵Frank Gevaerts1-0/+403 This is needed because the version in scrreprt.4ht in debian isn't compatible with other current bits of the TeX installation. Change-Id: Ibf31f387ecc9fdb8a6ad7b7362d5b650e657bb5b
2014-12-28XWorld: cleanupFranklin Wei1-6/+8
- Comment keymaps.h - Tie XWORLD_DEBUG into ROCKBOX_HAS_LOGF to ease debugging - Fix up the manual a little bit Change-Id: I12cfb58001199036cd67dbaa27f164e6790a199d Reviewed-on: Reviewed-by: Michael Giacomelli <>
2014-12-23Xworld - Another World interpreter for RockboxFranklin Wei2-0/+83
Co-conspirators: Franklin Wei, Benjamin Brown -------------------------------------------------------------------- This work is based on: - Fabien Sanglard's "Fabother World" based on - Piotr Padkowski's newRaw interpreter which was based on - Gregory Montoir's reverse engineering of - Eric Chahi's assembly code -------------------------------------------------------------------- Progress: * The plugin runs pretty nicely (with sound!) on most color targets * Keymaps for color LCD targets are complete * The manual entry is finished * Grayscale/monochrome support is NOT PLANNED - the game looks horrible in grayscale! :p -------------------------------------------------------------------- Notes: * The original game strings were built-in to the executable, and were copyrighted and could not be used. * This port ships with an alternate set of strings by default, but can load the "official" strings from a file at runtime. -------------------------------------------------------------------- To be done (in descending order of importance): * vertical stride compatibility <30% done> * optimization <10% done> Change-Id: I3155b0d97c2ac470cb8a2040f40d4139ddcebfa5 Reviewed-on: Reviewed-by: Michael Giacomelli <>
2014-10-22Manual: add missing actions in Sokoban for the Packard Bell Vibe 500.Szymon Dziok1-5/+7
Change-Id: I73d7bffaf5a31cab7ab5fcb07ff68d273b9665e0
2014-10-22Manual for the Samsung YH820.Szymon Dziok54-301/+515
Change-Id: I1c760b4846963f39b9df60413ffbb9f95dc0e0fb
2014-10-22Manual for the Samsung YH920/YH925.Szymon Dziok58-229/+593
Change-Id: I2db0023cae585e9c9517da9ed2e9de6195081ce2
2014-10-03Manual: add missing calendar image for M:Robe 100.Szymon Dziok1-0/+0
Change-Id: Ia07adc0f2e534ff88f378a456c973cc8adaa5627
2014-10-02Manual: add default battery capacity for M:Robe 100.Szymon Dziok1-0/+1
Change-Id: Ia4786d018962ae3a260275df018767e74a3e1bcc
2014-10-02Manual: add M:Robe 100 to the appendices.Szymon Dziok2-4/+4
Change-Id: Ic79156d71bbcfc3b4be763ecd7e961991b920371
2014-10-02Manual: add M:Robe 100 to "Using ROLO" subsection.Szymon Dziok1-1/+1
Change-Id: Idab44f91ff5beb59cc7c7d858066e3db35fe2413
2014-10-02Manual: Unify and simplify manual uninstallation for couple targets.Szymon Dziok5-22/+10
Change-Id: Ib90aaf3652be4ea4cfc5f873aa5ab1f4ef4dd004
2014-09-18Introducing Targets iBasso DX50 & iBasso DX90Simon Rothen3-0/+1966
The port to for this two targets has been entirely developped by Ilia Sergachev (alias Il or xzcc). His source can be found at . The few necesary modifications for the DX90 port was done by headwhacker form Unfortunately i could not try out the final state of the DX90 port. The port is hosted on android (without java) as standalone app. The official Firmware is required to run this port. Ilia did modify the source files for the "android" target in the rockbox source to make the DX port work. The work I did was to separate the code for DX50 (&DX90) from the android target. On this Target Ilia used source from tinyalsa from AOSP. I did not touch that part of the code because I do not understand it. What else I changed from Ilias sources besides the separation from the target "android": * removed a dirty hack to keep backlight off * changed value battery meter to voltage battery meter * made all plugins compile (named target as "standalone") and added keymaps * i added the graphics for the manual but did not do anything else for the manual yet * minor optimizations known bugs: * timers are slowed donw when playback is active (tinyalsa related?) * some minor bugs Things to do: * The main prolem will be how to install the app correctly. A guy called DOC2008 added a CWM (by to the official firmware and Ilia made a CWM installation script and a dualboot selector (rbutils/ibassoboot, build with ndk-build). We will have to find a way to install rockbox in a proper way without breaking any copyrights. Maybe ADB is an option but it is not enable with OF by default. Patching the OF is probably the way to go. * All the wiki and manual to build: needed: android ndk installed, android sdk installed with additional build-tools 19.1.0 installed ./tools/configure select iBasso DX50 or iBasso DX90 make -j apk the content of needs to be copied to /system/rockbox/app_rockbox/rockbox/ (rockbox app not needed) the content of libs/armeabi to /system/rockbox/lib/ (rockbox app needed) The boot selector is needed as /system/bin/MangoPlayer and the iBasso app as /system/bin/MangoPlayer_original. There is also the "vold" file. The one from OF does not work with DX50 rockbox (DX90 works!?), the one from Ilia is necessary. Until we have found a proper way to install it, it can only be installed following the instructions of Ilia on his bitbucket page, using the CWM-OF and his installation script package. Change-Id: Ic4faaf84824c162aabcc08e492cee6e0068719d0 Reviewed-on: Tested: Chiwen Chang <> Reviewed-by: Michael Giacomelli <>
2014-09-16Remove long-obsolete note about different 32MB/64MB ipod video builds.Frank Gevaerts1-3/+0
Thanks to Arthur Ferral for reporting (FS#12999) Change-Id: Ia399fa7f02d3a5d5304f28a0b3d5a4ea637841ae
2014-09-15FS#9583 - periodic tableFranklin Wei2-0/+15
- original rockbox port: Yifu Huang - original work: Jonathan Bettencourt - modifications made: - PLA-fied - Add element 117 (ununseptium) - Implemented up/down - Fixed actinide/lanthanide navigation so that they are between scandium and titanium - Added manual entry - Fixed FG/BG colors Change-Id: Ibabfb0d28f794689ffcd8b9c360fb969d118de08 Reviewed-on: Reviewed-by: Michael Giacomelli <>
2014-09-11Rockbox Manual - Gigabeat FX and Fuze+ Touchpad Config AppendixBenjamin Brown1-0/+10
Added to config_file_options.tex, sections for gigbeat and fuze+ sensitivity settings, also fuze+ touchpad deadzone setting. Change-Id: I9bba52ca0ca5525e6a6fb337f6940d11571ee06a Reviewed-on: Tested: Benjamin Brown <> Reviewed-by: Frank Gevaerts <>
2014-09-09Manual: add images for 128x96x16 resolution (YH-820).Szymon Dziok71-0/+0
Change-Id: If9a9c5eb733f61eddfe94a193db6d195c099d599
2014-09-08Fix typo in fuze+ deadzone manual entryBenjamin Brown1-1/+1
Change-Id: I789a839941fa765e27fc91abcd5b395ab2df1316 Reviewed-on: Reviewed-by: Amaury Pouly <>
2014-09-08Manual: Delete another three duplicated and unused files. Fix one filename.Szymon Dziok4-0/+0
Change-Id: Ice3ecc9db6202e3eb6dca23a156b7d9344b6973d
2014-09-08Manual: delete unnecessary image.Szymon Dziok1-0/+0
The same file is under group of images called "ss-mandelbrot". Change-Id: I00fd11417c64e7778a5873986c5df5e9c813bbeb
2014-09-08Correct some file permissions.Szymon Dziok3-0/+0
Change-Id: I4a092a19d6a9c66dfeb2777c9655aa4b19d11e16