path: root/manual
AgeCommit message (Collapse)AuthorFilesLines
2018-12-14FS11473: Add bookmarking option: one per track.Solomon Peachy2-3/+8
Modified version from ticket, taken from Igor Poretsky's tree, and further modified to incorporate feedback. Change-Id: I9284497d53a0247a51739d29fdc1db5fbbebfadc
2018-08-05manual: nitpicking on '-' character and other minor detailsSebastian Leonhardt12-59/+59
Change-Id: Id204276387d55ba2276530ed1cb6ee827e28062a
2018-07-28Revert "As3525 v1/v2 Add power savings menu"William Wilgus1-24/+0
This reverts commit 6f0320a9535bc1aa81d83fa879ac14d5ee603658. Change-Id: I7425d422a4a0af7a49e9194cfe0bb55d431bc401
2018-07-27As3525 v1/v2 Add power savings menuWilliam Wilgus1-0/+24
Allow user to select cpu undervolt There have been quite a few issues across the SANSA AMS line related to CPU undervolting while most players show greatly increased runtime some crash. Rather than constanly upping the voltage we now have a setting with a safe value for all players and the option for lower voltages I plan to add a few other options here later such as disk timings and maybe some other clocks/experimental settings Added: Disk Low speed option for AS3525v2 devices cuts frequency to 12 MHz from 24 MHz Added: Disk Low speed option for AS3525v1 devices cuts frequency to 15.5 MHz from 31 MHz Added: I2c Low Speed AS3525 devices, should be bigger improvement for v1 devices Fixed: Debug menu for AS3525v2 No SDSLOT frequency, Showed IDE freq though it is unused Added: DBOP and SSP underclocking affects display on v1/v2 respectively Fixed: debug menu now has SSP frequency, and SSP_CPSR Update: made settings menu more generic Update: cleaned up code Added: Clip v1 & Fuze v1 didn't have HAVE_ADJUSTABLE_CPU_VOLTAGE. not sure why but, waiting on testing to confirm Added: C200v2 and E200v2 devices and HAVE_ADJUSTABLE_CPU_VOLTAGE. Fixed: v1 devices don't like display timing set lower (dbop) v1 devices don't have a divider set for ssp (causes divide by 0) Fixed: ClipZip display lags with Max SSP divider changed from 0xFE to 0x32 Fixed: v1 devices didn't work properly with highspeed sd cards Added code from Added powersave and IDE interface enable/disable Added: V2 devices now have powersave enabled on sd interface Update: cleaned up code, lang defines, added manual entries Update ssp clock mechanism added calculated ssp divider to clipzip Update turn display clock off when clip+ turns off display Fixed: clipzip wrong register for SSP clock Change-Id: I04137682243be92f0f8d8bf1cfa54fbb1965559b TODO: add other players?
2018-04-03pacbox for small screens, up to 75x96Sebastian Leonhardt3-1/+1
Change-Id: I6e9adf2f6923f4d0078a54e9857fc8eacef259a6
2018-03-18duke3d: add manual entryFranklin Wei1-0/+38
Oops. Apparently I neglected to add this and it's gone unnoticed until now. Change-Id: I938f14c3dfcc4336acca1517988fd096e11ab241
2017-12-24duke3d: restrict manual building to enabled targetsFranklin Wei1-1/+1
Change-Id: I1a66bf5184c9e1f53212f97b097a542f794f2721
2017-12-23Port of Duke Nukem 3DFranklin Wei1-0/+2
This ports Fabien Sanglard's Chocolate Duke to run on a version of SDL for Rockbox. Change-Id: I8f2c4c78af19de10c1633ed7bb7a997b43256dd9
2017-10-30puzzles: add an interaction mode to the "Zoom In" featureFranklin Wei1-0/+32
This makes it possible to play the game while zoomed in. Read the manual entry if you want to know more. Change-Id: Iff8bab12f92ebd2798047c25d1fde7740aa543ce
2017-10-28SVG image of the Sony NWZ-E580 and other formats for the manual.Szymon Dziok3-0/+3428
Change-Id: I30453398ab317f5c263371aa5798463f26ac4dbb
2017-10-02xworld: only build manual for color targetsFranklin Wei1-1/+1
Change-Id: Ia6aeddfcae21afaed13debb487bc8b46d515d031
2017-09-20Rename "Selective Backlight" to "Backlight Exemptions" and add German ↵Johannes Rauh1-1/+1
translation Change-Id: I1ddb78bd267372617370cc36910fce9980b907cd Calling the menu entry "Backlight Exemptions" as this better describes the functionality. Adding the German translation.
2017-08-23FS#11922: Lua game - Pixel PainterSebastian Leonhardt15-0/+26
* Changed keymaps to PLA and added to SOURCES and CATEGORIES file * improved keymaps: implement wrap-around and key repeat * change keymap according to screen orientation * fix font size calculation * use blocking button query in main loop * replace tabs with spaces * added manual entry * added original author to CREDITS Change-Id: Id67ae99cbb7a737c7f4608e278b77a389ac2ffa6
2017-07-27puzzles: update manual entryFranklin Wei3-9/+31
Change-Id: I9c53eaa217ec8cd36ce3de4eaa1237c78bb0c1ea
2017-07-27Update manual copyright information for 2017 (FS#13095)Sebastian Leonhardt1-1/+1
We're still working on this. Change-Id: I9403f6757a81b05e44660e78d37e1bf478d223fa
2017-07-27Manual (iRiver H300): Update list of supported FW versions (FS#13109)Sebastian Leonhardt1-1/+1
Change-Id: Ifce260fa784cb3171f961a59d05a2f40bb49d3fd
2017-04-17manual: typo fixesFranklin Wei6-6/+7
Change-Id: I4a86e031c2dccd2a60b6d0d3fd7cca5df1d88774
2017-03-15Speed-reading pluginFranklin Wei20-0/+9
Partially based on `spread0r', an open-source ebook reader: Similar to Spritz(TM): Change-Id: I6aa54addd1910a83a266aea561406b6268449b67
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 <>