From 2bd89f5bfc5ec6d75f9b7c405d5fce8a8c7cde34 Mon Sep 17 00:00:00 2001 From: Lewis Menelaws Date: Thu, 22 May 2025 23:56:49 -0400 Subject: [PATCH] Update README.md --- README.md | 127 +++++++++++++++++++----------------------------------- 1 file changed, 44 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index d39a114ca..b01db45cb 100644 --- a/README.md +++ b/README.md @@ -1,108 +1,69 @@ -# Reddit Video Maker Bot 🎥 +# Reddit Video Maker Bot ✨ -All done WITHOUT video editing or asset compiling. Just pure ✨programming magic✨. +An automated solution for creating Reddit story videos for social media platforms like TikTok, YouTube, and Instagram. -Created by Lewis Menelaws & [TMRRW](https://tmrrwinc.ca) - - - - - - - - - - -## Video Explainer - -[![lewisthumbnail](https://user-images.githubusercontent.com/6053155/173631669-1d1b14ad-c478-4010-b57d-d79592a789f2.png) -](https://www.youtube.com/watch?v=3gjcY_00U1w) - -## Motivation 🤔 - -These videos on TikTok, YouTube and Instagram get MILLIONS of views across all platforms and require very little effort. -The only original thing being done is the editing and gathering of all materials... +https://user-images.githubusercontent.com/66544866/173453972-6526e4e6-c6ef-41c5-ab40-5d275e724e7c.mp4 -... but what if we can automate that process? 🤔 +The bot takes a Reddit thread, converts the comments to speech, adds a background video, and compiles everything into a ready-to-upload video for platforms like TikTok, YouTube, and Instagram. -## Disclaimers 🚨 +## Overview -- **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. +This bot automatically creates videos from Reddit posts and comments without requiring video editing skills. It handles text-to-speech conversion, background selection, and video compilation. ## Requirements -- Python 3.10 -- Playwright (this should install automatically in installation) +- Python 3.10+ +- Playwright (installed during setup) -## Installation 👩‍💻 +## Installation 1. Clone this repository -2. Run `pip install -r requirements.txt` -3. Run `python -m playwright install` and `python -m playwright install-deps` - -**EXPERIMENTAL!!!!** - -On macOS and Linux (debian, arch, fedora and centos, and based on those), you can run an install script that will automatically install steps 1 to 3. (requires bash) - -`bash <(curl -sL https://raw.githubusercontent.com/elebumm/RedditVideoMakerBot/master/install.sh)` - -This can also be used to update the installation - -4. Run `python main.py` -5. Visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps), and set up an app that is a "script". Paste any URL in redirect URL. Ex:`https://jasoncameron.dev` -6. The bot will ask you to fill in your details to connect to the Reddit API, and configure the bot to your liking -7. Enjoy 😎 -8. If you need to reconfigure the bot, simply open the `config.toml` file and delete the lines that need to be changed. On the next run of the bot, it will help you reconfigure those options. - -(Note if you got an error installing or running the bot try first rerunning the command with a three after the name e.g. python3 or pip3) - -If you want to read more detailed guide about the bot, please refer to the [documentation](https://reddit-video-maker-bot.netlify.app/) - -## Video - -https://user-images.githubusercontent.com/66544866/173453972-6526e4e6-c6ef-41c5-ab40-5d275e724e7c.mp4 - -## Contributing & Ways to improve 📈 - -In its current state, this bot does exactly what it needs to do. However, improvements can always 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! - -- [ ] Creating better documentation and adding a command line interface. -- [x] Allowing the user to choose background music for their videos. -- [x] Allowing users to choose a reddit thread instead of being randomized. -- [x] Allowing users to choose a background that is picked instead of the Minecraft one. -- [x] Allowing users to choose between any subreddit. -- [x] Allowing users to change voice. -- [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. + ``` + git clone https://github.com/elebumm/RedditVideoMakerBot.git + cd RedditVideoMakerBot + ``` -### For any questions or support join the [Discord](https://discord.gg/qfQSx45xCV) server +2. Install dependencies + ``` + pip install -r requirements.txt + python -m playwright install + python -m playwright install-deps + ``` -## Developers and maintainers. +3. Run the bot + ``` + python main.py + ``` -Elebumm (Lewis#6305) - https://github.com/elebumm (Founder) +4. Set up Reddit API access + - Visit [Reddit Apps page](https://www.reddit.com/prefs/apps) + - Create a new app (select "script" type) + - Enter any URL for the redirect URL + - Follow the bot's prompts to enter your API credentials -Jason Cameron - https://github.com/JasonLovesDoggo (Maintainer) +## Configuration -Simon (OpenSourceSimon) - https://github.com/OpenSourceSimon +- The bot will guide you through configuration on first run +- To reconfigure, edit or delete lines in `config.toml` +- For detailed instructions, see the [documentation](https://reddit-video-maker-bot.netlify.app/) -CallumIO (c.#6837) - https://github.com/CallumIO +## Features -Verq (Verq#2338) - https://github.com/CordlessCoder +- Text-to-speech narration with multiple voice options +- Customizable background videos +- Support for any subreddit +- Light and dark mode themes +- NSFW content filtering +- Manual or random Reddit thread selection -LukaHietala (Pix.#0001) - https://github.com/LukaHietala +## Contributing -Freebiell (Freebie#3263) - https://github.com/FreebieII +Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) for more information. -Aman Raza (electro199#8130) - https://github.com/electro199 +## Support -Cyteon (cyteon) - https://github.com/cyteon +For questions or support, join our [Discord server](https://discord.gg/qfQSx45xCV). +## License -## LICENSE [Roboto Fonts](https://fonts.google.com/specimen/Roboto/about) are licensed under [Apache License V2](https://www.apache.org/licenses/LICENSE-2.0)