avn3s / sap.py

A terminal-based offline music player

Contents

1. Contents
2. Clarification-cum-Warning
3. Requirements
4. Installing python
5. Installing pygame
6. Usage
7. Commands
8. To-do
9. Also Note
10. Credits

Clarification-cum-Warning

This was made simply for a school project by a jobless dude for the sake of marks. So do not use this unless you have nothing else to do. I am an amateur coder and thus this program is probably EXTREMELY unoptimised and buggy. There are much better alternatives out there. So if you still plan on using this literal piece of garbage, do so at your own risk. Any support from my side will be hugely limited.

Requirements

1. The python language (v3.10 or newer).
2. The pygame module (preferably the latest version) has to be installed beforehand in order to run the program.
3. A Nerd Font with ligatures, preferably Fira Code (this step is recommended, but purely optional).

Installing python

1. Go to the python downloads page.
2. Download the preferred installation file.
3. Install python via the installer.

Installing pygame

1. Download the package (see below).
2. Run requirementinstaller.py
3. Wait till installation completes.
4. Close the app once it says 'Pygame Successfully installed!'.
5. If you are lazy, just wait for 5 seconds. The app should close itself.

Installing a Nerd Font

1. Just google it ig im lazy.
2. Watch solo leveling.

Usage:

1. Click on 'Code' and hit 'download zip' (to use the latest dev build).
2. Alternatively, download the latest release from the 'releases' section (to use the latest stable build).
3. Unzip the archive.
4. Run requirementinstaller.py
5. Open soundapp.py
6. Type 'H' and hit enter when the prompt comes up.
7. Enjoy.

Commands:

Command	Function/Usage
H	Shows Help
L	Shows the list of available songs
P	Plays a song or adds it to the queue
PP	Pauses the currently playing song
R	Resumes playback, if paused
CQ	Stops playback and clears the queue
CS	Clears the screen (buggy)
N	Proceeds to play the next song in the queue
PV	Plays the previous song in the queue (without altering the queue)
Q	Shows the songs in the queue
D	Deletes a song from the songs list/folder
E	Exits the program

To-do

Feature	Progress
Play/Pause/Resume/Stop	✅
Volume	✅
Queue	✅
Playlist	❌
Song list	✅
Gui	Will not be added
Online data fetching	WIll not be added

Also Note:

This program can play .mp3, .wav, .ogg files ONLY as of now.
Support for other formats may be there, but it has not been tested.
Also, this program can only play pre-downloaded songs. It CAN NOT download them from the internet.
To add your own songs, please download the audio files and drop them into the 'songs' folder.
To delete songs, simply use the 'D' command after launching the app.

Credits

A huge shoutout to pygame for the library.