@ -21,31 +20,26 @@ These videos on TikTok, YouTube and Instagram get MILLIONS of views across all p
## Disclaimers 🚨
## Disclaimers 🚨
- This is purely for fun purposes.
- 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.
- **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
## Requirements
- Python 3.6+
- Python 3.6+
- Playwright (this should install automatically during installation)
- Playwright (this should install automatically during installation)
## Installation 👩💻
## Installation 👩💻
1. Clone this repository
1. Clone this repository
2. 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.
2. Run `pip3 install -r requirements.txt`
3. Have your AWS credentials under ~/.aws/credentials with a profile called 'polly' with AWS Polly full permissions
3. Run `playwright install` and `playwright install-deps`.
4. Run `pip3 install -r requirements.txt`
4.
5. Run `playwright install` and `playwright install-deps`.
4a **Automatic Install**: Run `python3 main.py` and type 'yes' to activate the setup assistant.
6. Run `python3 main.py`
4b **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.
5. Run `python3 main.py` (unless you chose automatic install, then the installer will automatically run main.py)
7. Enjoy 😎
7. Enjoy 😎
If you want to see more detailed guide, please refer to the official [documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/).
If you want to see more detailed guide, please refer to the official [documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/).
\*The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
*The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
## Contributing & Ways to improve 📈
## Contributing & Ways to improve 📈
@ -53,10 +47,8 @@ In its current state, this bot does exactly what it needs to do. However, lots o
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!
- [x] Allowing users to choose a reddit thread instead of being randomized.
- [] Allowing users to choose a reddit thread instead of being randomized.
- [ ] Allowing users to choose a background that is picked instead of the Minecraft one.
- [ ] 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 choose between any subreddit.
- [ ] Allowing users to change voice.
- [ ] Allowing users to change voice.
- [ ] Creating better documentation and adding a command line interface.
- [ ] Creating better documentation and adding a command line interface.
Please read our [contributing guidelines](CONTRIBUTING.md) for more detailed information.