Metadata-Version: 2.4
Name: BnuuyPlayer
Version: 1.0.0
Summary: BnuuyPlayer is a terminal audio player, remaining to have a wide range of features while remaining light:3
Maintainer-email: whenth01 <whenth01@proton.me>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/whenth01/BnuuyPlayer
Project-URL: Repository, https://github.com/whenth01/BnuuyPlayer.git
Project-URL: Issues, https://github.com/whenth01/BnuuyPlayer/issues
Project-URL: Documentation, https://github.com/whenth01/BnuuyPlayer/blob/beta/README.md
Project-URL: Changelog, https://github.com/whenth01/BnuuyPlayer/blob/beta/CHANGELOG.md
Keywords: bnuuy,bun,bnuy,bnuuyplayer
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: yt-dlp
Requires-Dist: mutagen
Dynamic: license-file

bnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuybnuuy
# BnuuyPlayer guide

**No AI generated code was used**

**Wanna contribute? View [BnuuyPlayer's documentation](README-Docs.md)**

**Wanna view features? View [BnuuyPlayer's featureset](README-Features.md)**

**Wanna see the current roadmap? View [BnuuyPlayer's roadmap](README-RoadMap.md)**

**Want to view the changelog? View [BnuuyPlayer's changelog](README-ChangeLog.md)**

**Need help? view [help](#help), [the cheatsheet](#cheatsheet), or [general advice](#general-advice) :3**

**New to BnuuyPlayer? View below, this will aid you in installation and act as a guide.**

## Installation 

***NOTE: If you don't want to install MPV and use bnuuyplayer as a library manager/video downloader, then exclude MPV from the install command, it is the final package at the end of the command***

Linux (Debian, Ubuntu)
```bash
sudo apt update
sudo apt install python3 python3-pip mpv
``` 

Linux(Fedora)
```bash
sudo dnf update
sudo dnf install -y python3 python3-pip mpv
```

Linux (centOS)
```bash
# Exclude this if you don't want MPV 
sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(rpm -E %rhel).noarch.rpm

# Exclude this if you don't want MPV
sudo dnf install -y https://download1.rpmfusion.org/free/el/rpmfusion-free-release-$(rpm -E %rhel).noarch.rpm

sudo dnf install -y python3 python3-pip mpv
```

Linux (Arch)
```bash
sudo pacman -Syu
sudo pacman -S python python-pip mpv
```

Windows
```bash
winget install Python.Python.3.13 shinchiro.mpv
```
MacOS
```bash
brew install python3 mpv
```
Android(termux)
```bash
pkg upgrade
pkg install python mpv
```

Python verification
```bash
python3 --version
```
(If this fails, lookup a guide on your specific OS)

Installing bnuuyplayer itself;
```
pip install bnuuyplayer
```
Installed dependencies:
YT-DLP
Requests
Mutagen (optional, you can delete that one, although i recommend it since its only 400kb)

Now; go to a directory 
***(Do not use the home directory.)***
***(BnuuyPlayer will lagspike if you attempt to search for something if you do use the home directory.)***

Linux, Android(termux), MacOS
```bash
cd path/to/your/directory
```
Windows
```bash
cd path\to\your\directory
```

Finally, run)
```bash
git clone https://github.com/whenth01/BnuuyPlayer.git
```
and
```
python3 bnuuyplayerindev.py
```
***NOTE: This manual clone will be deprecated once BnuuyPlayer is moved into a PyPi package, after V1.1 you can safely delete git, and run BnuuyPlayer by running bnuy***


## Cheatsheet, General advice and help.

### Cheatsheet

#### Create a new playlist/folder or add into a playlist.
  1. Return to Main Menu(if you arent already there)
  2. Settings
  3. Playlist sub settings

### Help

#### BnuuyFolders not hiding playlists
  This is currently intentional; BnuuyFolders are an extra layer of organization for the user.
  True containment will come in V2.
    
#### Advanced Search tagging
  Valid advanced searched tags
  title
  album
  artist

  To conduct an advanced search, all you must do is
  <the tag, e.g album> <your search query>
  And BnuuyPlayer returns you every song in the specified album.
  For example,
  album kick back
  That will show you every song from the album kick back by SPARKLEWOLF, and offer you a choice to
  1. Build a new BnuuyFolder with these songs
  2. Delete the songs.
  3. Append the tag into the filename
  4. Locate these songs
And more. (viewable in [[README-Features]]' mutagen section.)
    
#### URL Not working
  BnuuyPlayer only supports direct URLs, a mirror or shortlink will not work. 
  If it is a direct link, create a feature request with the site you want added.

#### Streamed playlists cant be browsed song by song
  This is currently a known limitation and may be fixed in V2.


### General advice

#### BnuuyFolders
  BnuuyFolders are not file system folders. They are collections of playlists, and do not affect filesystem nor interact with it.

#### 'Let BnuuyPlayer create a folder' 
  This only creates it within bnuuyplayer's directory.
    
#### 'Search for folder'
  This only searches within bnuuyplayer's directory, and not the whole device (To prevent a massive lagspike)

#### Deleting a sys folder
  If you choose to delete manually it will not affect BnuuyPlayer, as bnuuyplayer checks if the folder exists before interaction.
    

