Skip to content

Commit 918a025

Browse files
committed
Add readme
1 parent 95d7414 commit 918a025

3 files changed

Lines changed: 53 additions & 0 deletions

File tree

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<h1 align="center">Video-Player-for-Numworks</h1>
2+
<p align="center">
3+
<img alt="Version" src="https://img.shields.io/badge/Version-1.1.1-blue?style=for-the-badge&color=blue">
4+
<img alt="Stars" src="https://img.shields.io/github/stars/SaltyMold/Video-Player-for-Numworks?style=for-the-badge&color=magenta">
5+
<img alt="Forks" src="https://img.shields.io/github/forks/SaltyMold/Video-Player-for-Numworks?color=cyan&style=for-the-badge&color=purple">
6+
<img alt="License" src="https://img.shields.io/github/license/SaltyMold/Video-Player-for-Numworks?style=for-the-badge&color=blue">
7+
<br>
8+
<a href="https://github.com/SaltyMold"><img title="Developer" src="https://img.shields.io/badge/Developer-SaltyMold-red?style=flat-square"></a>
9+
<img alt="Maintained" src="https://img.shields.io/badge/Maintained-Yes-blue?style=flat-square">
10+
<img alt="Written In" src="https://img.shields.io/badge/Written%20In-C-yellow?style=flat-square">
11+
</p>
12+
13+
_This is a simple video player app for the Numworks calculator._
14+
15+
| Rickroll | Matrix |
16+
|----------|--------|
17+
| <img src="https://github.com/user-attachments/assets/73ac20ed-aa3b-43c1-b8ff-2c6eefd35902" width="200" alt="Rickroll"> | <img src="https://github.com/user-attachments/assets/1dc0c5ae-7666-4559-8f90-535b9280fde1" width="200" alt="Matrix"> |
18+
19+
## 📕 Install the app
20+
21+
To install this app, you'll need to:
22+
1. Download the **`app.nwa` file**, which you can download from the [Releases](https://github.com/SaltyMold/Video-Player-for-Numworks/releases).
23+
2. Download a compatible video file in `MJPEG` format. You can take them from the [samples folder](https://github.com/SaltyMold/Video-Player-for-Numworks/tree/main/samples). Or convert your own videos using tools like FFmpeg with the instructions below.
24+
3. Connect your **NumWorks calculator** to your computer using a USB cable.
25+
4. Head to **[my.numworks.com/apps](https://my.numworks.com/apps)** to send the **`nwa` file** on your calculator along the **`mjpeg` video**.
26+
27+
28+
### 🎞️ Converting videos to MJPEG format
29+
30+
Keep the resolution at 320×240. Adjust `-q:v` and `-fps` for quality and size.
31+
32+
With cropping:
33+
```sh
34+
ffmpeg -i input.mp4 -vf "scale=320:240:force_original_aspect_ratio=increase,crop=320:240,setsar=1:1,fps=15" -t 00:00:30 -vcodec mjpeg -q:v 24 -an output.mjpeg
35+
```
36+
Without cropping:
37+
```sh
38+
ffmpeg -i input.mp4 -vf "scale=320:240:force_original_aspect_ratio=increase,setsar=1:1,fps=15" -t 00:00:30 -vcodec mjpeg -q:v 24 -an output.mjpeg
39+
```
40+
41+
## 📕 How to use the app
42+
43+
| Key | Action |
44+
|-------|---------------|
45+
| Back | Quit app |
46+
| Shift | Change FPS |
47+
| EXE | Toggle debug |
48+
49+
## 🛠️ Build the app
50+
51+
I made tutorials here :
52+
- [C-App-Guide-for-Numworks](https://github.com/SaltyMold/C-App-Guide-for-Numworks)
53+
- [Numworks-App-Development-Template](https://github.com/SaltyMold/Numworks-App-Development-Template)

assets/Matrix.gif

9.16 MB
Loading

assets/Rickroll.gif

6.41 MB
Loading

0 commit comments

Comments
 (0)