-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
237 additions
and
37 deletions.
There are no files selected for viewing
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| # BIT-SCRIPTS<br/>Musique | ||
|
|
||
| A modest music player written in Python. | ||
|
|
||
| Pour la version en français de cette page de documentation aller [ici](./README.md). | ||
|
|
||
| ## Table of Contents | ||
| - [Application Screenshots](#application-screenshots) | ||
| - [Features](#features) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Discord RPC Integration](#discord-rpc-intégration) | ||
| - [Customization](#customization) | ||
| - [Contribution](#contribution) | ||
| - [FAQ and Troubleshooting](#faq-and-troubleshooting) | ||
| - [License](#license) | ||
| - [Contacts](#contacts) | ||
|
|
||
| ## Application Screenshots | ||
| ### Player Design: | ||
|  | ||
| ### Adding Music: | ||
|  | ||
| ### In Action: | ||
|
|
||
| <video width="640" height="360" poster="BSMusic.png" controls> | ||
| <source src="BSMusic.mp4" type="video/mp4"> | ||
| </video> | ||
|
|
||
| ### Discord RPC: | ||
|  | ||
|
|
||
| ## Features | ||
| - Plays audio files in MP3, WAVE, OGG, and FLAC formats. | ||
| - Simple controls with buttons to play/pause, skip to the next song, or go back to the previous one. | ||
| - Displays the waveform of the current song. | ||
| - Progress bar indicating the elapsed song time. | ||
| - Adjustable volume functionality. | ||
| - Customized user interface with window control buttons (minimize, maximize, close). | ||
| ## Prerequisites | ||
| To run this music player, ensure you have installed the following: | ||
|
|
||
| ### For all systems: | ||
| - [Python 3.x](https://www.python.org/downloads/) (not required if you use the binary) | ||
| - [PyQt5](https://pypi.org/project/PyQt5/) (not required if you use the binary) | ||
| - [Pygame](https://pypi.org/project/pygame/) (not required if you use the binary) | ||
| - [PyDub](https://pypi.org/project/pydub/) (not required if you use the binary) | ||
| - [Mutagen](https://pypi.org/project/mutagen/) (not required if you use the binary) | ||
| - [Pyqtgraph](https://pypi.org/project/pyqtgraph/) (not required if you use the binary) | ||
| - [FFmpeg](https://ffmpeg.org/download.html) **(essential for all systems)** | ||
|
|
||
| ### For Windows: | ||
| - FFmpeg : | ||
| - Install FFmpeg using one of the following command-line package managers: | ||
| - Chocolatey ([How to install Chocolatey](https://chocolatey.org/install)): | ||
| ``` | ||
| choco install ffmpeg | ||
| ``` | ||
| - Winget ([How to install Winget](https://aymeric-cucherousset.fr/installer-winget-sur-windows/)): | ||
| ``` | ||
| winget install ffmpeg | ||
| ``` | ||
| - Scoop ([How to install Scoop](https://www.useweb.fr/blog/developpement/post/scoop-package-manager/)): | ||
| ``` | ||
| scoop install ffmpeg | ||
| ``` | ||
| - Alternatively, you can manually download FFmpeg from [the official website](https://ffmpeg.org/download.html), extract it, and add the `bin` folder to your system's `Path` environment variable. | ||
| - Verify the installation with `ffmpeg -version`. | ||
| ### For Linux: | ||
| Installation instructions for dependencies are provided for Ubuntu/Debian and Arch Linux/Manjaro. If you are using a different distribution, such as Fedora or RHEL, please consult your distribution's documentation for specific installation instructions for FFmpeg and other required dependencies. | ||
| - FFmpeg : | ||
| - Install FFmpeg using your distribution's package manager. | ||
| For example, on Ubuntu/Debian, use: | ||
| ```bash | ||
| sudo apt-get install ffmpeg | ||
| ``` | ||
| Or on Arch Linux/Manjaro, use: | ||
| ```bash | ||
| sudo pacman -S ffmpeg | ||
| ``` | ||
| - Verify the installation with `ffmpeg -version`. | ||
| - Other dependencies: | ||
| - Install other dependencies using your distribution's package manager. | ||
| For example, on Ubuntu/Debian, use: | ||
| ```bash | ||
| sudo apt-get install python3-pyqt5.qtsvg python3-opengl libgirepository1.0-dev | ||
| ``` | ||
| Or on Arch Linux/Manjaro, use: | ||
| ```bash | ||
| sudo pacman -S python-pyqt5 python-opengl gobject-introspection qt5-wayland qt5-x11extras sdl2 sdl2_image sdl2_mixer sdl2_ttf | ||
| ``` | ||
| ## Installation | ||
| 1. For a quick installation, download the latest binary versions of the application [here](https://github.com/Bit-Scripts/musique/releases/latest). If you use the binary, you don't need to install Python or other dependencies, except for FFmpeg. | ||
| 2. For manual installation, clone this repository or download it as a ZIP archive, then install the necessary dependencies by running pip install -r requirements.txt. | ||
| 3. Launch the player by executing `python main.py` from the project directory. | ||
| ## Usage | ||
| Start the application. You can load music files from a folder of your choice and control playback with the user interface buttons. | ||
| ## Discord RPC Integration | ||
| To enhance the user experience, I implemented displaying the currently playing music in Discord through the Discord RPC feature. | ||
| Here is a preview of the [Discord RPC integration](#discord-rpc). | ||
| ## Customization | ||
| You can customize the appearance of the application by modifying the integrated CSS style files. | ||
| ## Contribution | ||
| We warmly welcome contributions to this project! | ||
| If you have ideas for improvement, bug fixes, or wish to add new features, feel free to create a pull request or an [issue](https://github.com/Bit-Scripts/musique/issues). | ||
| Even if you're new to open source, we'll be delighted to guide you through the process. | ||
| To get started, you can: | ||
| - Fork the project and test the code on your machine. | ||
| - Submit pull requests with your changes or additions. | ||
| - Create [issues](https://github.com/Bit-Scripts/musique/issues) to discuss bugs, improvement suggestions, or new features. | ||
| We commit to reading and responding to your requests. | ||
| ## FAQ and Troubleshooting | ||
| ### In all cases | ||
| - **Music Formats** | ||
| Q: What audio formats can my music player play? | ||
| A: The player supports MP3, WAVE, OGG, and FLAC formats. If you encounter problems with these formats, make sure you have the latest complete version of FFmpeg installed. | ||
| - **Where are my music files** | ||
| Q: The application can't find my music files. | ||
| A: Ensure the files are in a supported format (flac, mp3, ogg, or wav) and the path is correct. | ||
| - **Album Covers** | ||
| Q: The integration of album covers doesn't seem to work. | ||
| A: Album covers should be in jpg, jpeg, or png format and located in the same folder as the music files. | ||
| - **Supported Operating Systems for the Audio Player** | ||
| Q: On which operating systems can I use Bit-Scripts Music? | ||
| A: Currently, Bit-Scripts Music is available for Microsoft Windows and most Linux distributions. | ||
| - **Resource Issues** | ||
| Q: Why does the music player sometimes slow down or freeze? | ||
| A: This can be due to insufficient system resources, large audio files, or compatibility issues. Try closing other running applications and reducing the size of your music library. If the problem persists, please contact us via an issue, [here](https://github.com/Bit-Scripts/musique/issues). | ||
| - **Issues with FFmpeg** | ||
| Q: How do I configure FFmpeg to work with the music player? | ||
| A: After installing the full version of FFmpeg, add its path to your system's Path environment variable. Consult the FFmpeg documentation for more details or create an issue [here](https://github.com/Bit-Scripts/musique/issues) for assistance. | ||
| ### Installation from Binaries | ||
| - **Updating** | ||
| Q: How can I update my music player from the binary? | ||
| A: Visit the [releases page](https://github.com/Bit-Scripts/musique/releases/latest) to download the latest version. If you are using the binary, simply replace the old executable file with the new one. | ||
| ### Installation via Python Files | ||
| - **Installation Issues** | ||
| Q: How do I resolve the "X" error during installation? | ||
| A: Ensure that you have properly installed all dependencies. If the problem persists, don't hesitate to create an [issue on our GitHub page](https://github.com/Bit-Scripts/musique/issues). | ||
| - **Updating** | ||
| Q: How can I update my music player from a copy of the Python files? | ||
| A: Perform a `git pull` in the application folder. | ||
| - **Graphical Interface Issues** | ||
| Q: What should I do if the graphical interface doesn't display correctly when launching the application with Python? | ||
| A: Ensure that all dependencies, especially PyQt5 and Pyqtgraph, are properly installed. If the problem persists, try restarting the application or your system. | ||
| In case of problems, open an [issue on GitHub](https://github.com/Bit-Scripts/musique/issues), and we commit to resolving your issue as soon as possible (please allow us at least two weeks, but the problem will be fixed). | ||
| ## License | ||
| This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details. | ||
| ## Legal Notices and Acknowledgments | ||
| ### Icons | ||
| The icons used in this application are from [Iconduck](https://iconduck.com/sets/iconpark-icon-set/categories/music) and have been slightly modified to fit the design of the application. We would like to thank Iconduck for their remarkable work and contribution to the open-source community. | ||
| ### Contributions | ||
| [Red Moon](https://github.com/Quentin-D31): A big thank you to Red Moon for testing the application on Arch Linux and for his valuable feedback which helped to improve the user experience on different platforms. | ||
| [Paul/Paullux](https://github.com/Paullux): For the initial development and ongoing maintenance of the project. If you would like to contribute to the project, please feel free to create a pull request or an issue on our [GitHub page](https://github.com/Bit-Scripts). | ||
| We would like to thank everyone who contributes to the success of this project, whether through testing, suggestions, code contributions, or simply by sharing the project with others. | ||
| ## Contacts | ||
| We are continuously working to improve the project. Do not hesitate to contact us to share your feedback or ideas for improvement. | ||
| - To interact with us, feel free to visit our [Discord server](https://discord.gg/6J5EX5hCeW) where you can ask questions or seek help. | ||
| - You can contact me by email if needed; I suggest getting my email address either through [Discord](https://discord.gg/6J5EX5hCeW) or my [personal GitHub profile](https://github.com/Paullux). | ||
| - If you like this project: | ||
| Visit our website, [bit-scripts.github.io](https://bit-scripts.github.io/index.html), to find our other creations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| # BIT-SCRIPTS<br/>Musique | ||
|
|
||
| Petit lecteur de musique écrit en Python et sans prétention. | ||
| Petit lecteur de musique écrit en Python et sans prétention. | ||
|
|
||
| For the English version of this documentation page, click [here](./README-en.md). | ||
|
|
||
| ## Table des Matières | ||
| - [Capture d'écran de l'application](#capture-décran-de-lapplication) | ||
|
|
@@ -11,17 +13,23 @@ Petit lecteur de musique écrit en Python et sans prétention. | |
| - [Intégration de Discord RPC](#intégration-de-discord-rpc) | ||
| - [Personnalisation](#personnalisation) | ||
| - [Contribution](#contribution) | ||
| - [FAQ ou Dépannage](#faq-ou-dépannage) | ||
| - [Questions Fréquentes et Dépannage](#questions-fréquentes-et-dépannage) | ||
| - [Licence](#licence) | ||
| - [Contacts](#contacts) | ||
|
|
||
| ## Capture d'écran de l'application | ||
| ### Design du lecteur : | ||
|  | ||
| ### Ajout de musique : | ||
|  | ||
| ### Discord RPC : | ||
|  | ||
| ### Design du lecteur : | ||
|  | ||
| ### Ajout de musique : | ||
|  | ||
| ### En action : | ||
|
|
||
| <video width="640" height="360" poster="BSMusic.png" controls> | ||
| <source src="BSMusic.mp4" type="video/mp4"> | ||
| </video> | ||
|
|
||
| ### Discord RPC : | ||
|  | ||
|
|
||
| ## Fonctionnalités | ||
| - Lecture de fichiers audio au format MP3, WAVE, OGG ou encore FLAC. | ||
|
|
@@ -34,41 +42,29 @@ Petit lecteur de musique écrit en Python et sans prétention. | |
| Pour exécuter ce lecteur de musique, assurez-vous d'avoir installé les éléments suivants : | ||
|
|
||
| ### Pour tous les systèmes : | ||
| - Python 3.x (non nécessaire si vous utilisez le binaire) | ||
| - PyQt5 | ||
| - Pygame | ||
| - PyDub | ||
| - Mutagen | ||
| - Pyqtgraph | ||
| - FFmpeg (essentiel pour tous les systèmes) | ||
| - [Python 3.x](https://www.python.org/downloads/) (non nécessaire si vous utilisez le binaire) | ||
| - [PyQt5](https://pypi.org/project/PyQt5/) (non nécessaire si vous utilisez le binaire) | ||
| - [Pygame](https://pypi.org/project/pygame/) (non nécessaire si vous utilisez le binaire) | ||
| - [PyDub](https://pypi.org/project/pydub/) (non nécessaire si vous utilisez le binaire) | ||
| - [Mutagen](https://pypi.org/project/mutagen/) (non nécessaire si vous utilisez le binaire) | ||
| - [Pyqtgraph](https://pypi.org/project/pyqtgraph/) (non nécessaire si vous utilisez le binaire) | ||
| - [FFmpeg](https://ffmpeg.org/download.html) **(essentiel pour tous les systèmes)** | ||
|
|
||
| ### Pour Windows : | ||
| - FFmpeg : | ||
| - Vous pouvez installer FFmpeg via l'un des gestionnaires de paquets en ligne de commande suivants : | ||
| - Chocolatey : | ||
| - Chocolatey ([Comment installer Chocolatey](https://chocolatey.org/install)) : | ||
| ``` | ||
| choco install ffmpeg | ||
| ``` | ||
| - Winget (Essentials Build) : | ||
| ``` | ||
| winget install "FFmpeg (Essentials Build)" | ||
| ``` | ||
| - Winget (Full Build) : | ||
| - Winget ([Comment installer Winget](https://aymeric-cucherousset.fr/installer-winget-sur-windows/)) : | ||
| ``` | ||
| winget install ffmpeg | ||
| ``` | ||
| - Scoop (Full Build) : | ||
| - Scoop ([Comment installer Scoop](https://www.useweb.fr/blog/developpement/post/scoop-package-manager/)) : | ||
| ``` | ||
| scoop install ffmpeg | ||
| ``` | ||
| - Scoop (Shared Build) : | ||
| ``` | ||
| scoop install ffmpeg-shared | ||
| ``` | ||
| - Pour les builds de développement (Git Master) : | ||
| ``` | ||
| scoop install ffmpeg-gyan-nightly | ||
| ``` | ||
| - Alternativement, vous pouvez télécharger FFmpeg manuellement depuis [le site officiel](https://ffmpeg.org/download.html), l'extraire et ajouter le dossier `bin` à la variable d'environnement `Path`. | ||
| - Vérifiez l'installation avec `ffmpeg -version`. | ||
|
|
@@ -102,7 +98,7 @@ Les instructions d'installation des dépendances sont fournies pour Ubuntu/Debia | |
| 3. Lancez le lecteur en exécutant `python main.py` depuis le répertoire du projet. | ||
| ## Utilisation | ||
| Lancez l'application. Vous pourrez charger des fichiers MP3 depuis un dossier de votre choix et contrôler la lecture avec les boutons de l'interface utilisateur. | ||
| Lancez l'application. Vous pourrez charger des fichiers musicaux depuis un dossier de votre choix et contrôler la lecture avec les boutons de l'interface utilisateur. | ||
| ## Intégration de Discord RPC | ||
| Pour enrichir l'expérience utilisateur, j'ai implémenté l'affichage de la musique en cours de lecture dans Discord grâce à la fonctionnalité Discord RPC. | ||
|
|
@@ -121,7 +117,7 @@ Même si vous êtes nouveau dans le domaine de l'open source, nous serons ravis | |
| Pour commencer, vous pouvez : | ||
| - Forker le projet et tester le code sur votre machine. | ||
| - Soumettre des pull requests avec vos modifications ou ajouts. | ||
| - Créer des [issue](https://github.com/Bit-Scripts/musique/issues) pour discuter de bugs, de suggestions d'améliorations ou de nouvelles fonctionnalités. | ||
| - Créer des [issues](https://github.com/Bit-Scripts/musique/issues) pour discuter de bugs, de suggestions d'améliorations ou de nouvelles fonctionnalités. | ||
| Nous nous engageons à lire et répondre à vos demandes. | ||
|
|
@@ -136,10 +132,14 @@ R: Le lecteur supporte les formats MP3, WAVE, OGG et FLAC. Si vous rencontrez de | |
| Q: L'application ne trouve pas mes fichiers musicaux. | ||
| R: Vérifiez que les fichiers sont dans un format pris en charge (flac, mp3, ogg ou wav) et que le chemin d'accès est correct. | ||
| - **Pochette d'album** | ||
| - **Pochettes d'album** | ||
| Q: L'intégration des pochettes d'album semble ne pas fonctionner. | ||
| R: Les pochettes d'album doivent être au format jpg, jpeg ou png et situées dans le même dossier que les fichiers musicaux. | ||
| - **Système d'exploitation supporter par le lecteur audio** | ||
| Q: Sur quel système d'exploitation, je peux utiliser Bit-Scripts Musique ? | ||
| R: À l'heure actuelle, *Bit-Scripts Musique* est disponible pour Microsoft Windows et la majorité des distributions Linux. | ||
| - **Problème de ressources** | ||
| Q: Pourquoi le lecteur de musique ralentit ou gèle parfois ? | ||
| R: Cela peut être dû à des ressources système insuffisantes, à des fichiers audio de grande taille ou à des problèmes de compatibilité. Essayez de fermer d'autres applications en cours d'exécution et de réduire la taille de votre bibliothèque musicale. Si le problème persiste, veuillez nous contacter via une isseu, [ici](https://github.com/Bit-Scripts/musique/issues). | ||
|
|
@@ -171,10 +171,20 @@ En cas de problème, ouvrez une [issue sur GitHub](https://github.com/Bit-Script | |
| ## Licence | ||
| Ce projet est sous licence MIT. Voir le fichier [LICENSE](./LICENSE) pour plus de détails. | ||
| ## Contacts | ||
| - Pour échanger avec nous n'hésitez pas à vous rendre sur notre [serveur Discord](https://discord.gg/6J5EX5hCeW) ainsi vous pourriez y poser des questions ou demander de l'aide sur le serveur Discord. | ||
| - Vous pouvez me contacter par Email en cas de besoin, [lien vers mon Email](mailto:[email protected]) | ||
| ## Mentions légales et Remerciements | ||
| ### Icônes | ||
| Les icônes utilisées dans cette application proviennent de [Iconduck](https://iconduck.com/sets/iconpark-icon-set/categories/music) et ont été légèrement modifiées pour s'adapter au design de l'application. Nous tenons à remercier Iconduck pour leur travail remarquable et leur contribution à la communauté open-source. | ||
| ### Contributions | ||
| [Red Moon](https://github.com/Quentin-D31) : Un grand merci à Red Moon pour avoir testé l'application sur Arch Linux et pour ses retours précieux qui ont aidé à améliorer l'expérience utilisateur sur différentes plateformes. | ||
| [Paul/Paullux](https://github.com/Paullux) : Pour le développement initial et la maintenance continue du projet. Si vous souhaitez contribuer au projet, n'hésitez pas à créer un pull request ou une issue sur notre [page GitHub](https://github.com/Bit-Scripts). | ||
| Nous tenons à remercier tous ceux qui contribuent au succès de ce projet, que ce soit par des tests, des suggestions, des contributions de code ou simplement en partageant le projet avec d'autres. | ||
| ## Contacts | ||
| Dans un but d'amélioration constante du projet, n'hésitez à nous contacter pour nous remonter vos retour(s) ou idée(s) d'amélioration(s). | ||
| - Pour échanger avec nous n'hésitez pas à vous rendre sur notre [serveur Discord](https://discord.gg/6J5EX5hCeW) ainsi vous pourriez y poser des questions ou demander de l'aide sur le serveur Discord. | ||
| - Vous pouvez me contacter par Email en cas de besoin, pour cela je vous suggère de passer soit par [Discord](https://discord.gg/6J5EX5hCeW) soit par mon [profil personnel sur github](https://github.com/Paullux) pour obtenir mon adresse Email. | ||
| - Vous aimez ce projet : | ||
| Rendez-vous sur notre site, [bit-scripts.github.io](https://bit-scripts.github.io/index.html), pour y trouver nos autres réalisations. | ||