VaporwaveGenerator/README.md

68 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# vaporwave generator 旺育栄
A music (+art, +video soon, I promise) generator bodged together using code from various sources. Runs on Python3
```
usage: main.py [-h] [-M] [-V] [-i INPUT]
This program takes YouTube URL or title of a song and converts it into
vaporwave
optional arguments:
-h, --help show this help message and exit
-M, --music generate v a p o r w a v e music
-V, --version show program version
-i INPUT, --input INPUT
input url
```
## Installation
This was tested on macOS Catalina ( so should work on almost all macOS versions).
Windows is unsupported at this time ( I need to find a way to use aubio's python module)
### Dependencies
#### Linux
```
sudo apt install ffmpeg libavl1 sox
pip install -r requirements.txt
```
#### macOS
Make sure you have brew installed
```
brew install noah # I would have had to re-compile the executeable :(
brew install sox
pip install -r requirements.txt
```
## Usage
### YouTube URL
```
python3 main.py -M -i <YOUTUBE_URL>
```
### Song Title
```
python3 main.py -M -i Song Title
```
## Bugs
This project is a result of bodging and therefore has tons of bugs which need to be ironed out
## To-Do
[ ] Move away from using os.system calls, and use Python modules instead ( Looking at you, Sox and aubio)
[ ] Clean the Code
[ ] Add Artwork Generator
[ ] Add Video Generator
## Credits
@WJLiddy His repo `Macintech` forms the base code for the music generator
@felipecustodio Using his repo `virtualdreamsbot` YouTube DL code ( Hopefully I will be able to integrate this project as a Telegram Bot)