Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hteumeuleu/playorama
A cranky video player for the Playdate
https://github.com/hteumeuleu/playorama
playdate playdate-console
Last synced: 17 days ago
JSON representation
A cranky video player for the Playdate
- Host: GitHub
- URL: https://github.com/hteumeuleu/playorama
- Owner: hteumeuleu
- License: mit
- Created: 2022-03-23T21:01:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T11:22:06.000Z (3 months ago)
- Last Synced: 2024-10-12T19:30:02.453Z (about 1 month ago)
- Topics: playdate, playdate-console
- Language: Lua
- Homepage:
- Size: 3.21 MB
- Stars: 45
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: Support/NOTES.md
Awesome Lists containing this project
README
# A cranky video player for the Playdate
Playorama is a _cranky_ video player for the Playdate. You can use the crank to fast forward and backward or move frame by frame through a video.
## 1. How to use
*Warning*: The process to get your own videos on the Playdate is a bit clunky. There’s a demo video included in the application if you’re not at ease with encoding video and audio.
### 1.1. Download and install
1. Download the latest release at https://github.com/hteumeuleu/playorama/releases .
2. Get the `Playorama.pdx` file.
3. Sideload it to your Playdate device. (You can refer to the official [Sideloading Playdate games](https://help.play.date/games/sideloading/) documentation.)
### 1.2. Controls
While a video is playing, you can use the following controls.
* `A`: pause
* `B`: menu
* `Up`: toggle track bar
* `Left` and `Right`: toggle through different playback speed
* `Crank`: change playback speed up to 4x
If the video is paused, using `Left` and `Right` or the `Crank` will move frame by frame.
### 1.3. Options
Playorama has two options available in the Playdate System Menu:
* VCR effect: adds a VCR pause effect to the video when going fast forward, backward or frame by frame.
* Log: show errors that occured while opening your own video and audio files.
## 2. Add videos
1. Connect your Playdate to your computer in [Data Disk mode](https://help.play.date/games/sideloading/#data-disk-mode).
2. In the main `Data` folder, locate or create the folder the app has access to. The folder shall be named either:
* `com.hteumeuleu.playorama` if you sideloaded the app over a USB connection,
* `user.xxxx.playorama` if you sideloaded the app through the Playdate website **before february 2023** (where `xxxx` should be replaced by your user number used in other folder names),
* `user.xxxx.com.hteumeuleu.playorama` if you sideloaded the app through the Playdate website **after february 2023** and Playdate OS update 1.12.
3. Add your video and audio files inside. Both files should have the same base name (for example: `sample.pdv` and `sample.pda`).
### 2.1. Sample videos
You can download the following videos to try it out.
_(Coming soon!)_
Download an archive and extract it in the application data folder (See `2.` above.).
### 2.2. Encode your own videos
#### Using the online Playdate Video Encoder
1. Go to [pdv.hteumeuleu.com](https://pdv.hteumeuleu.com/).
2. Use the web app to encode your video. You will only get a `.pdv` file for the video.
3. Use another software like _ffmpeg_ to export the audio as an `.mp3`.
#### Using 1bitvideo on macOS
1. Download `1bitvideo.app` the video encoder made by Panic’s Dave Hayden: [https://devforum.play.date/t/video-encoder-work-in-progress-mac-only/1390/23](https://devforum.play.date/t/video-encoder-work-in-progress-mac-only/1390/23).
2. Use the app to encode your video. When done, you will get both a `.pdv` and a `.m4a` file. The Playdate can not read an `.m4a` from a data folder, so we need to encode the audio into `.pda`.
3. Encode the audio into MP3. The Playdate SDK documentation provides indication into how to do this using either _Audacity_ or _ffmpeg_: [https://sdk.play.date/1.11.1/Inside%20Playdate.html#f-sound.getSampleRate](https://sdk.play.date/1.11.1/Inside%20Playdate.html#f-sound.getSampleRate).
#### Using ffmpeg and a custom script
[Crank Player](https://github.com/saagarjha/CrankPlayer) has a bash script that relies on ffmpeg and a custom Python script to convert a video into a `.pdv`.
## 3. Source Code
You can compile the code with the following command:
```sh
pdc ./Source/ Playorama.pdx
```