diff --git a/README.md b/README.md index 79596f2..c430ddf 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# Note to anybody who needs support, I am currently on a crap ton of pain killers and my finger is cut in half. I cannot help you or fix any bugs for at least the next week. - - # Reddit Video Maker Bot 🎥 All done WITHOUT video editing or asset compiling. Just pure ✨programming magic✨. -Created by Lewis Menelaws & Heavily modified by [Jason Cameron](https://github.com/JasonLovesDoggo) +Created by Lewis Menelaws & [TMRRW](https://tmrrwinc.ca) + + + + img + ## Motivation 🤔 @@ -16,26 +18,33 @@ The only original thing being done is the editing and gathering of all materials ## Disclaimers 🚨 -- This is purely for fun purposes. - **At the moment**, this repository won't attempt to upload this content through this bot. It will give you a file that you will then have to upload manually. This is for the sake of avoiding any sort of community guideline issues. ## Requirements -- Python 3.6+ (3.10 is recommended tho ) +- Python 3.6+ - Playwright (this should install automatically in installation) +- Sox ## Installation 👩‍💻 1. Clone this repository -2. Rename `.env.template` to `.env` and replace all values with the appropriate fields. To get Reddit keys (** +2. + 2a **Automatic Install**: Run `python3 main.py` and type 'yes' to activate the setup assistant. + + 2b **Manual Install**: Rename `.env.template` to `.env` and replace all values with the appropriate fields. To get Reddit keys (**required**), visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps) TL;DR set up an app that is a "script". Copy your keys into the `.env` file, along with whether your account uses two-factor authentication. + +3. install [SoX](https://sourceforge.net/projects/sox/files/sox/) +4. +5. Run `pip3 install -r requirements.txt` + +6. Run `playwright install` and `playwright install-deps`. + +7. Run `python3 main.py` (unless you chose automatic install, then the installer will automatically run main.py) required**), visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps) TL;DR set up an app that is a "script". Copy your keys into the `.env` file, along with whether your account uses two-factor authentication. -3. Run `pip3 install -r requirements.txt` -4. install [SoX](https://sourceforge.net/projects/sox/files/sox/) -5. Run `playwright install` and `playwright install-deps`. -6. Run `python3 main.py` -7. Enjoy 😎 +8. Enjoy 😎 ## Video https://user-images.githubusercontent.com/19284904/172727335-7e11c816-3484-4033-a535-4b061751fa3b.mp4 @@ -45,8 +54,7 @@ https://user-images.githubusercontent.com/19284904/172727335-7e11c816-3484-4033- In its current state, this bot does exactly what it needs to do. However, lots of improvements can be made. -I have tried to simplify the code so anyone can read it and start contributing at any skill level. Don't be shy :) -contribute! +I have tried to simplify the code so anyone can read it and start contributing at any skill level. Don't be shy :) contribute! - [ ] Creating better documentation and adding a command line interface. - [x] Allowing users to choose a reddit thread instead of being randomized. @@ -56,3 +64,19 @@ contribute! - [x] Checks if a video has already been created - [x] Light and Dark modes - [x] Nsfw post filter + +Please read our [contributing guidelines](CONTRIBUTING.md) for more detailed information. + +## Developers and maintainers. + +Elebumm (Lewis#6305) - https://github.com/elebumm (Founder) + +Jason (JasonLovesDoggo#1904) - https://github.com/JasonLovesDoggo + +CallumIO - https://github.com/CallumIO + +HarryDaDev (hrvyy#9677) - https://github.com/ImmaHarry + +LukaHietala (Pix.#0001) - https://github.com/LukaHietala + +Freebiell - https://github.com/FreebieII