Update README to show basic information of this initialized repo

2026-03-24 14:51:00 -05:00
parent 98f8817e37
commit 73d56f5957
1 changed files with 84 additions and 1 deletions
@@ -1,3 +1,86 @@
+| [![V-dlplogo.png](helpers/V-dlpwide.png)](helpers/V-dlpwide.png) |
+| :---: |
+
 # V-dlp

-A program to aid in queuing downloads from V
+A program to aid in queuing downloads from Vimm.net
+
+## Prerequisites
+
+### Shared
+
+- [Google Chrome](https://www.google.com/chrome/)
+- [Chromedriver](https://googlechromelabs.github.io/chrome-for-testing/)
+
+### Source
+
+- Python 3.11 (others might work)
+- Selenium `pip install selenium`
+
+## Programs
+
+### V-dlp UG (URL Generator)
+
+V-dlp UG can be used to generate a list of URL's to download given a few inputs.
+
+#### Switches/arguments
+
+| Arg | Descr. | Options | Default |
+| :--- | :------ | :------- | :--- |
+| -l | Choose logging option | ["syslog","file","all","none"] | syslog |
+| -lf | If log is file/all need to specify file to log to | NA | none |
+| -p | Specify already running Chrome Driver port | int | 54321 |
+| --platform | Platform to generate list from (required, case sensitive) | string: PS1, Atari2600, etc. | none |
+| --letter | The letter to search for matched roms (required) | string: A-Z, all | none |
+| -f | File with links inside (where to save URLs found) | str: platform_letter.txt | urls.txt |
+| -minr | Minimum rating to match (non-inclusive) | float | 8.6 |
+| -maxr | Maximum rating to match (non-inclusive) | float | 10.1 |
+| -uh | Use headless Chrome (If you do not want to use, do not pass in the flag) | boolean | False |
+| -v | Display version information | NA | none |
+
+### V-dlp (downloader)
+
+V-dlp will parse a file and attempt to download each one at a time.
+
+#### Switches/arguments
+
+| Arg | Descr. | Options | Default |
+| :--- | :------ | :------- | :--- |
+| -l | Choose logging option | ["syslog","file","all","none"] | syslog |
+| -lf | If log is file/all need to specify file to log to | NA | none |
+| -p | Specify already running Chrome Driver port | int | 54321 |
+| -u | File with links inside | str | urls.txt |
+| -d | Download directory to use | str | %HOME%\Downloads |
+| -r | How often to refresh statistics on screen | float | 2 |
+| -tw | Number of seconds to pause between downloads | float | 4 |
+| -nm | Do not monitor download statistics (set flag to True for small downloads <32MB) | boolean | False |
+| -uh | Use headless Chrome (If you do not want to use, do not pass in the flag) | boolean | False |
+| -v | Display version information | NA | none |
+
+## Features
+
+- [X] Download files
+- [X] Show download statistics (speed, ETA)
+- [X] Show number of URLs
+- [X] Show download name/size
+- [X] Add headless option
+- [X] No more waiting for each download to finish
+
+
+## Upcoming features
+
+- [ ] Proper error handling
+- [ ] Show failed downloads
+- [ ] Download cover art
+- [ ] Download manuals
+- [ ] Remove duplicate URLs
+- [ ] Email upon completion
+- [ ] More download statistics
+- [ ] Handle multi-disc downloads
+- [ ] Remove dependency on external start of Chrome Driver
+- [ ] Click on ads
+- [ ] OS agnostic (heavily Windows based as they need the most hand holding)
+
+## Bonus
+
+Powershell script to extract zips, delete zips, convert .cue, .gdi, .iso to .chd. `chd.ps1`