Rockbox General > Rockbox General Discussion

I had a go at rewriting the "first contact" section of the manual

(1/1)

cc:

I'm pretty new to Rockbox, so I thought I would have a go at rewriting the "First Contact" section of "Quick Start" section of the manual (to say what I wish it had said when I first started  - while I still remember).

I grabbed the source, but it I couldn't figure out how to build just the manual.

Anyway, here is what I have so far, I'd be interested in hearing what people think!

-----------

If you have not already copied some music to your \dap{} now is the
time to do it.  You will have to boot the manufacturer's firmware as
described in \reference{ref:Dualboot} (as Rockbox does not currently
have a usb driver).  Rockbox handles many formats including mp3, aac
and ogg (REF??).  You can put the files anywhere you like.  For example
you could make a top level directory called "Tunes" and inside that
have a directory for each artist, the inside that a directory for each
album which contains all the files for that album.  Finally unplug
your player and switch it off and on again to get back to Rockbox.

\opt{h10,h10_5gb}{\note{
If your \dap{} is a MTP model, the Music folder where all your music is stored
may be hidden in the \setting{File Browser}. This may be fixed by either
either changing it's properties (on a computer) to not hidden, or by changing
the \setting{Show Files} setting to all.
}}

TODO: Sansa note: Music folder gets changed after boot into original firmware.

First screen you will see is the \setting{Main Menu}. To move through
the items on the menu use \ActionStdNext{} and \ActionStdPrev{}. Then
use \ActionStdOk{} to select an item. The simplest way to play a file
is to use the \setting{File Browser} by seleting "Files" in the
\setting{Main Menu}, then use \ActionStdOk{} to enter a folder
(\ActionTreeParentDirectory{} goes back to the previous folder). When
you have found the file you want to play, use \ActionStdOk{} to play it.

Once a file has been selected for playing the view switches to the
``While playing screen'' (``WPS'') showing information about the file
and your \dap{}.  Use \ActionWpsVolUp{} / \ActionWpsVolDown to adjust
the volume and \ActionWpsPlay to toggle pause.  To go back to the
\setting{File Browser} use \ActionWpsBrowse{} (\ActionWpsStop{} does
the same but also stops playback).  Return to the WPS using
\ActionTreeWps or by selecting \setting{Now Playing} from the
\setting{Main Menu}.

Rockbox's default WPS is not very pretty but can be changed easily.
Use \ActionStdMenu{} to get back to the \setting{Main Menu}
and then select \setting{Settings} then \setting{Browse Themes}.
Choose a theme and then use \ActionTreeWps to return to the
WPS. There are many more themes on the Internet. \note{Some of the
themes shipped with Rockbox need additional fonts from the fonts
package, so make sure you installed them.}

After the file you selected has finished playing, Rockbox will start
playing the next file in the directory. This happens because when you
select a file to play Rockbox creates a Playlist containing all the
files in the directory (called a dynamic playlist). To see the current
playlist go to the \setting{Main Menu} and then select
\setting{Playlists} then \setting{View Current Playlist}.  The
playlist can be editted from here. For instance, to remove a song
move down to it and then use \ActionStdContext{} to access the
\setting{Context Menu} and then select \setting{Remove}.

\note{
A context menu is a menu containing actions that relate to
the highlighted item. So, for an item in a playlist the \setting{Context Menu}
has Remove, Move etc., whereas for a file the \setting{Context Menu} has
Rename, Cut, Paste, Delete etc.

The WPS also has a context menu which contains shortcuts to frequently
used functions, such as \setting{Sound Settings} (Bass, Treble, EQ etc.)
and \setting{Playlist} functions.
}

You can add songs to the Current Playlist in many ways. For instance
to add all the files in a folder you can highlight the folder in the
\setting{File Browser}, use \ActionStdContext{} to access the
\setting{Context Menu} then \setting{Playlist} and \setting{Insert
last}. If you do this while the the \dap{} is playing this will add
the files onto the end of the dynamic playlist. However, if the \dap{}
is stopped doing this will replace the dynamic playlist.

The current playlist can also be saved and loaded again later see REF.

Although it is possible to select music using only the \setting{File Browser},
Rockbox also supports browsing by categories such as Artist,
Album and Title. To browse in this way select \setting{Database} from
the \setting{Main Menu}.  The first time you do this Rockbox
will scan your disk for audio files which can take some time. After
the scan is finished you may be prompted to restart your \dap{} before
you can use the database.

Rockbox has many other features, here are a few of them:

- Playlists can be played shuffled. The quickest way to turn shuffling
on is to access the \setting{Quick Menu} using \ActionStdQuickScreen from
the WPS.

- There are many games and a few applications. These are called
``Plugins'' in Rockbox. They can be accessed by selecting
\setting{Plugins} from the \setting{Main Menu}.  

- There is a Sleep timer, from the \setting{Main Menu} select
\setting{System} then \setting{Sleep Timer}.

- Settings can be saved and restored, highlight \setting{Settings}
in the \setting{Main Menu} and use \ActionStdContext{} to access the
\setting{Context Menu}. The settings files are simple text files
and can be editted to include only the particular settings you
need. For instance you could have a config file for night use
called night.cfg containing just:

 volume: -45
 invert: on
 brightness: 1

GodEater:
Patches (even to the manual), go in Flyspray not in the forums.

LinusN:
What GodEater tried to say is: "Thank you very much for you effort, but please submit your changes to the patch tracker".

http://www.rockbox.org/tracker/index.php?type=4

;)

GodEater:
Yes - that's what I meant - was in a tearing hurry this morning and my manners slipped a bit.

Many apologies  :-\

Navigation

[0] Message Index