/ README.md
README.md
1 # JEplayer - MP3 Player for Adafruit PyGamer with CircuitPython 2 3 Make sure you are using CircuitPython 5.0.0.beta6 or newer for JEplayer. 4 (If beta6 is not out yet, that means use the latest build from the master 5 branch) 6 7 Once that's dealt with, all you'll need to do is unzip the JEplayer distribution 8 to your PyGamer's CIRCUITPY drive, copy MP3 files to your MicroSD card using a USB adapter, 9 and pop that in the PyGamer's slot. 10 11 ## Device Orientation 12 13 Hold your PyGamer "vertically" with the stick at the bottom. 14 15 ## Choosing MP3s 16 17 JEplayer works best with 128kBit/s MP3 files with a sample rate of 44.1kHz. 18 19 ## Folders as playlists 20 21 JEplayer will show a list of all the top-level folders on the SD card. Pick 22 one by moving the stick up and down, then press any button to start playing. 23 The files in it will be played in "naive sort" order. If your files are named 24 like "01 - Track Name.mp3", this means the album will play in order. 25 26 To let JEplayer choose a folder at random, choose the top option. 27 28 ## Album and Track Art 29 30 You can show artwork on the PyGamer's screen during playback. If your playlist 31 is in the folder "They Might Be Giants - Flood", then in the root folder add a 32 128x128 or smaller uncompressed ".bmp"-format image called "They Might Be 33 Giants - Flood.bmp". To make a special image for just one track, put it in the 34 album folder and name it the same as the track, such as "02 - Birdhouse In Your 35 Soul.bmp" 36 37 ## Controls during playback 38 39 During playback, control JEplayer via the icon bar at the bottom of the screen. 40 Press left and right on the stick select an icon -- the current one is outlined 41 with a red square -- and then press any button to invoke the desired icon. 42 43 Some buttons can be "active", in which case the background is blue. 44 45 From left to right: 46 * Play: Play or pause the current track. Active to show the track is currently playing. 47 * Pause: Play or pause the current track. Active to show the track is currently paused. 48 * Stop: Return to the folder listing 49 * Previous Track: Go to the previous track (or a random track, if shuffle is on) 50 * Next Track: Go to the next track (or a random track, if shuffle is on) 51 * Repeat: Switch repeat mode on or off. When active, after the last track in the folder, play continues with the first track. Mutually exclusive with Shuffle and All Folders 52 * Shuffle: Switch shuffle mode on or off. When active, after each track, select a different random track from the folder. Mutually exclusive with Repeat and All Folders 53 * All Folders: Switch all folders on or off. When active, after the last track in the folder, play continues with the next folder. Mutually exclusive with Shuffle and Repeat 54 55 ## VU Meter 56 57 The LEDs will pulse in time to the music. 58 59 ## Headphones and Speakers 60 61 If headphones are plugged in to the jack on the PyGamer, the audio will come 62 out there. Otherwise, you need a speaker plugged into the small connector on 63 the back labeled "Speaker". Headphones with an in-line volume control are 64 best, because JEplayer can't control the playback volume itself.