Rockbox Documentation Index

---

---

Rockbox Manuals

• Rockbox Manuals for all usable target device, updated daily. This page has PDF and HTML versions of the Rockbox Manual for every supported platform. It should be the first place to look for usage documentation and installation instructions.

---

General Information

Welcome

• WhyRockbox - What is Rockbox and why should you use it?
• ScreenShots - Screenshots of Rockbox in action
• The GNU General Public License - The terms under which Rockbox may be distributed
• TargetStatus - The current status of Rockbox development on various players
• ProjectGlossary - Catch up with the Rockbox project lingo
• DeviceChart - Device comparison table
• BuyersGuide - Want to buy a Rockbox compatible device?
• IdentifyPlayer - Not sure what player you have?
• DonatedMoney - Where the millions go
• DonatedHardware - Where your donated players will go
• NoDo - A list of features that we will not implement
• The Noble People Behind Rockbox

More Stuff

• RockboxUtility - A program designed to ease the installation of Rockbox and extras
• RockboxExtras - Extras not included with the regular download
• UsefulTools - A collection of tools for Rockbox as well as general digital music management
• MajorChanges - List of major changes to Rockbox
• ReleaseNotes - An index of the release notes for all official Rockbox versions
• FeatureRequests - How to get a feature into Rockbox
• FlySpray - General information on the FlySpray system
• FlySprayHowto - How to report bugs and submit patches
• RockboxManual - Interested in helping out with the manual?
• ExternalRelatedPages - A list of external related pages
• WebStatistics - A Wiki statistics page that would be cool if it was kept up to date
• DownloadMirrors
• GentlemenMails - Index of "Ladies and Gentlemen, we have sound!" e-mails
• RockboxMuseum - A collection of outdated pages

FAQs

• Frequently Asked Questions About Rockbox
• Frequently Asked Questions for Blind and Visually Impaired Rockbox users
• Frequently Asked Questions about the Archos port
• Frequently Asked Questions about the iriver port
• Frequently Asked Questions about the Sansa port
• Frequently Asked Questions about the iPod port
• Frequently Asked Questions about the Olympus port

Meetups, DevCons, GTs

• DevCon
• RockboxNYC
• TowerOfRockbox

---

For Users

• PluginIndex - Where to find information on all plugins
• ViewerPlugin - Information on viewer plugins
• PluginMpegplayer - Information on the MPEG video player plugin
• PluginJpeg - Information on the JPEG plugin
• PluginRockboy - Information on the Rockboy (Gameboy emulator) plugin
• CustomWPS - How to design your own custom While Playing Screen
• SimpleGuideToWPSMaking - A simple guide to making your own WPS
• AlbumArt - Information on using Album Art
• ThemeGuidelines - Guidelines for submitting themes
• DefaultWPS - Submissions for the Default Theme Contest
• CreateFonts - How to create fonts for use with Rockbox
• FontFormat - The Rockbox font format
• UserConvertedFonts - Gallery of user-converted fonts
• UnicodeGuide - The Unicode info page
• UnicodeFonts - The status of Unicode support with various fonts
• LangFiles - Details on the .lang file type
• IconSets - The Icon Sets gallery
• CustomIcons - How to create custom icons for Rockbox
• DataBase - Details on the Rockbox Database
• FmPresets - FM radio tuner Presets for various regions
• VoiceFiles - Index of pre-built voice files
• VoiceHowto - How to make your player speak
• VoiceBuilding - How to make your own voices
• LoadableKeyboardLayouts - Information on custom keyboard layouts
• CustomConfigFile - Details of the Rockbox configuration file type
• LastFMLog - Info on last.fm logging capabilities
• GaplessPlayback - About Gapless playback
• GaplessHowTo - How to create gapless sound files
• VolumeTriggeredRecording
• RoLo - Information on the Rockbox Loader
• MultibootBootloader - Boot from SD card
• ScreenDump - How to take a bitmap image of your screen
• SoundCodecs - Details on the codecs supported by Rockbox
• ShuffleExplained - Basic description of how shuffle works in Rockbox
• CustomFiletypeColours - Make your File Browser look like Linux!
• QuickScreen - Information on the Quick Screen
• ThemeEditor Information on the Theme Editor

---

For Developers

Getting Started & Compiling

• NewPort - How to start a port to a new player
• PortingHowTo - How to create a new build target
• DevelopmentGuide - First-time guide to Rockbox development
• CrossCompiler - Building the cross compiler (Linux/Cygwin)
• ManualHowto - Detailed instructions on building the rockbox reference Manual doc from source
• WorkingWithPatches - How to work with patches
• HowToWriteCodecs - How to write Rockbox codecs
• HowtoWritePlugins - How to write Rockbox plugins
• HowtoVerifyPlugins - How to verify plugins
• HowToAutomatePluginScreenshots - How to make pretty screenshots for inclusion in the manual
• UsingGit - How to use Git
• ObjdumpGuide - How to use objdump to disassemble firmware.
• LinuxSimpleGuideToCompiling - The simplified guide to compiling for Linux
• InterixDevelopment - How to use Interix (aka Microsoft SFU/SUA) to compile Rockbox on Windows
• CoLinuxDevelopmentPlatform - How to use CoLinux to compile Rockbox
• DevelopmentTools - A collection of various development tools
• BuildClient - How to add your powerful machine to the server build farm
• UiSimulator - What it is and how to build/use it (Unix/Linux/Cygwin/MacOS)
• ArmInstructions - ARM instruction quick guides

About the Code

• RockboxArchitecture - The internal architecture of Rockbox
• SourceLayout - The source code layout of Rockbox
• SourceProfiling - How to profile Rockbox
• WhyNoMalloc - Why does Rockbox have no malloc()?
• AllocatingRAM - How to allocate a buffer
• RockboxMemoryLayout - Memory layout under Rockbox
• PluginMemoryLayout
• UseMemoryGuard - How to use the memory guard ("Catch mem accesses") debugging feature
• ListWidget - How to use the List Widget
• RockboxKernel - Description of the Rockbox Kernel
• RockboxPCMPlayback - Part of an attempt to document the software codec playback code
• RockboxUsbHandling - USB handling in Rockbox
• UsingTheMenuAPI - How to use the Menu API
• GraphicsAPI - Graphics API documentation
• GreylibCalibration - Steps needed to calibrate greylib on new target
• WpsTokenizerDEPRECATED - Details on the WPS tokenizer
• DynamicCPUFrequency - Dynamic CPU Frequency in Rockbox
• TargetTree - The Target Tree structure
• LangFiles - Details on the .lang file type
• TagcacheDBFormat - Details on the structure of the database
• SdlPluginPort - Details on the SDL plugin port

Benchmarks and Test Results

• BatteryRuntime - Rockbox battery runtime testing
• CodecPerformanceComparison - Sound codec performance compared side-by-side
• UsbPerformance - Details on the performance of the Rockbox USB Stack
• LcdFrameRate - LCD frame rates for various players
• DiskSpeed - Rockbox disk driver speed measurements

Hardware Information

• HardwareSchematics - Hardware schematics for various players
• PortPinAssignments - Port pin assignments for various players
• DataSheets
• DatasheetErrata
• ColdFire
• TelechipsInfo
• MotorolaDSP56k
• TexasInstrumentsTMS320
• SigmaTelSTMP3xxx
• PortalPlayer
• GoForce - nVidia bought PortalPlayer and continues the line under this name
• IngenicJz47xx
• IngenicX1000
• PhilipsSAA7750
• PhilipsPNX0101 - Info on the Philips PNX010X series of chips
• SamsungSA58 - Info on the Samsung series of chips
• RockChip
• AustriaMicrosystemsAS3514
• SanyoLV24000 - One chip FM/AM tuner IC for portable equipment

People

• RockboxSteeringBoard - For when decisions aren't easily made
• KnowledgeMap - The Who-Knows-What List
• WhoDoesWhat - The Who-Does-What List
• RockboxTesting - Find people with specific players to help you test

Projects & Discussions

• MrSomeonesTodoList - New to Rockbox and unsure where to begin? Help Someone complete his tasks!
• SummerOfCode - Description and page index
• ReleasePlanning - Page for release planning discussion
• ReleaseTodo - Page for things to do before a proper release can be done
• ReleaseChecklist
• BootloaderRelease - Short guide how to release official bootloader
• PortalPlayerUsb - Details on the current status of the Rockbox USB Stack for PortalPlayer
• SoftwareCodecPlayback - Plan to rework playback
• ViewPorts - Plan to change how the WPS screen displays information
• ViewPortsDesign - ... and the design.
• AustriaMicrosystems - Regarding the communication with people at the company
• ViewDrawing - New theme design proposal piggy-backing on ViewPorts
• CompiledSkinProposal - A proposal to have compiled skins for Rockbox
• MenuLayoutDiscussion - Discussion about the menu layout and possible improvements to it
• TouchscreenInterface
• UsbOnTheGoSupport
• TextToSpeech
• FontSystemProposal
• MultiFontSupport - A discussion on how multi-font support can be implemented
• NonLatinLanguages - Supporting Rockbox over non-latin languages
• GitVersionControl - Git Version Control system, and how it might be useful for Rockbox
• RockboxArchitectureImprovements
• VKeyboardDesignProposal
• MultiScreenVKeyboard
• AudioAPIEnhancement
• AudioHardwareAPIProposal
• RockboxUtility - The Qt version of Rockbox Utility
• RockboxUtilityDevelopment - Development information for RBUtil
• DeviceDetection - Info on RBUtil device detection
• DeviceEnableRegistersPP502x - Information regarding the Device Enable registers on PP502X targets
• RockboxOrgEmail - Want a fancy @rockbox.org email address?
• SoundCodecs - Details on the codecs supported by Rockbox
• CodecPerformanceComparison - Sound codec performance compared side-by-side
• ConsoleEmulators - List of console emulators that might help porting to Rockbox
• ThemeRepository - Discussing the adoption of themes.rockbox.org
• UseDisplayName - "Using display names allows you to browse files using the id3 tags embedded into most mp3 files"
• MasLimitations - MAS MPEG audio decoders seems to not correctly decode all valid MPEG version/layer/bitrate combinations.
• AllKeysConfigurable - People want to be able to personalize everything but it would be a nightmare to support. Discuss.
• CustomMenus - People want to be able to personalize everything but it would be a nightmare to support. Discuss.
• BrowseByAlphabet - A proposal for browsing by the first letter of the filename
• DocumentViewer - The beginning of a plugin for viewing Wikipedia articles or converting HTML, PDF files for Rockbox
• ButtonAssignments - A work page to assist in making the keymaps, and hence the code, more generic.
• LocalizablePlugins - A proposal to implement localizable plugins.
• KeyMaps - A listing of Rockbox keymaps.

---

Hardware Projects

General Hardware Projects

• LyreProject - Project to design and build a Free/Open hardware audio player for use with Rockbox
• GigabeatCustomdock - The custom dock for the Gigabeat F and X
• RockIR - A plan to develop something using Infared... Honestly I can't say I understand.
• CarPowerSupply - How to build up very easily a simple power supply to get your beloved Archos Player or Archos Recorder v1 charged in your car
• MicPreamp - Microphone Preamplifier
• Steve Russell's PIC-based remote control for the Archos
• Chris Halsall's Archos Multimedia Jukebox 20 page with disassembly instructions useful for FM and V2 owners
• Archos Atmel remote control by Matthias Klumpp
• VWCDPIC Adapter - Remote control Archos from Volkswagen radio
• Eric Woudenberg's excellent description on how to repair the DC socket on the V1 Recorder.
• Rockbox as a Sony Unilink Car CD Changer emulator
• UseOldiPodsWithBadFirewirePort - I think the title of this one says it all
• SansaRepair - Solder your broken Sansa E200 headphone jack
• ArchosInfraredRemote - IR receiver for Archos Recorder/Studio/FMR

Disassembly

• DisassemblePlayer - How to disassemble the Archos Jukebox
• iPod dissection pictures
• iriver h3x0 Dissassembly Video

Hard Drive Replacement

• HardDriveReplacement - Information on hard drive sizes and replacement possibilities
• BigDisk - Information regarding replacement hard drives over 137 gigabytes for the Archos
• Hard drive update for the Archos
• GigabeatX60HardDriveUpgrade - Information on hard drive upgrades for the Gigabeat X
• CFModGuide - Guide to replacing HDDs with Compact Flash cards
• MiniCF - Guide to replacing iPod Mini Microdrives with Compact Flash cards
• ZIFToATAAdapter - How to install drives using ZIF to ATA adapters
• UDMAonUSB - Guide to speed up UDMA hard drive / CF transfers to or from a computer on certain DAPs
• Harddisk compatibility for iPods
• DIY: ZIF to IDE adapter (pdf)
• Good view of 50pin 1.8" drive
• Good view of ZIF 40 connector on Hitachi 1.8" Drive

Hardware Modification

• James Stewart's Jukebox 6000 Bass and Volume improvement
• RTCModH1x0 - RTC Mod for H1x0 series
• Uwe Freese's 8MB RAM mod for Recorders
• Uwe Freese's RTC alarm mod for v1 recorders
• CaseModding - Some interesting stuff people have done to modify their players.
• UartBoot - UART Boot Mod
• OndioBacklight - Ondio Backlight Mod

Buy and Sell

• WorkingPlayerForSale - Have a working player to sell ?
• SpareParts - Have hardware components to offer or pieces you need?

---

CategoryFrontpage: Documentation index - Looking for something? [Documentation]