==========
README.txt
==========

Welcome to Soundpal!

=====
INDEX
=====

- 1. Installing
- 2. Controls
- 3. Miscellaneous notes
- 4. Known limitations / Bugs
- 5. F.A.Q.

=============
1. INSTALLING
=============

- Playdate hardware:
	- Put the device in Disk Mode: Go to "Settings" > "System" and select "Reboot in Data Disk Mode"
	- Once the device connects, navigate to the drive (on macOS, this is located at "/Volumes/PLAYDATE")
	- Place the .pdx file into the "Games" subfolder
	- Disconnect Playdate

- Simulator:
	- The simulator is included with the Playdate SDK. You can get the installer here: Playdate SDK
	- Once installed, open the "PlayDateSDK" folder (on macOS, this is located at `~/Developer/PlaydateSDK`)
	- Put the .pdx file into the "Disk/Games"> subfolder
	- Relaunch the simulator.

===========
2. CONTROLS
===========

While in a menu:
	- [B]		 : move up a level, close menu if at top level
	- [A]		 : select item, navigate to submtnu
	- [Left]	 : close menu
	- [Up]/[Down]: navigate/change selection

While in the player:
	- [Up]			: change visualizer
	- [Down]		: cycle repeat / loop modes
	- [Left]/[Right]: change to previous / next song; hold to trigger auto-repeat
	- [A]			: pause / unpause
	- [B]			: open menu

======================
3. Miscellaneous notes
======================

Thanks for trying out Soundpal! This app comes with the ability to customize your experience. Please look
at the options contained in the top level "Settings" menu to tailor things to your liking.

Without a visualizer running, Soundpal takes extra care to minimze the amount of rendering in order to consere 
battery power. If maximizing playtime is critical to your listening needs, disable the visualizer.

===========================
4. Known Limitations / Bugs
===========================

- Only two versions of ID3 are supported: 2.2.0 and 2.3.0.
	- Album artwork is not implemented, yet
- Long songs can take a while to load: the disk is slow, loading is synchronous. The app will look hung.
- Custom playlist support is not implemented
- Menu autoscroll sometimes triggers unexpectedly

========
5. F.A.Q
========

Q. What is Soundpal?

A. Soundpal is a basic MP3 player for the Playdate (see: www.play.date), by Panic (www.panic.com). It comes with 
configuration options to tailor the experience to your needs.

-

Q. How do I listen to my music?

A. In order to listen to your own music from within Soundpal, you'll need to copy non-DRM'ed MP3s to the app's data folder. The steps for doing so differ between running Soundpal in the simulator or on physical Playdate hardware.

First, run Soundpal until you see an appropriate UI indicating you have no music available. Then,

For Playdate hardware:
	- Put the device in Disk Mode 
		- Go to "Settings" > "System" and select "Reboot in Data Disk Mode"
	- Once the device connects, navigate to the drive (on macOS, this is located at "/Volumes/PLAYDATE")
	- Open the subfolder "Disk/Data/com.jaymakesgames.soundpal/musicLibrary" 
	- Put music files in this location. 
		- The app will recursively search folders in this location for MP3s.
	- Relaunch Soundpal

For Simulator:
	- Open the "PlayDateSDK" folder (on macOS, this is located at `~/Developer/PlaydateSDK`)
	- Open the subfolder "Disk/Data/com.jaymakesgames.soundpal/musicLibrary" 
	- Put music files in this location. 
		- The app will recursively search folders in this location for MP3s.
	- Relaunch Soundpal

