MinecraftUpdates/QUICKSTART.md

Quick Start Guide

1️⃣ Installation

cd d:\Git Repos\MinecraftUpdates
pip install -r requirements.txt

2️⃣ Reddit Setup

1. Go to https://www.reddit.com/prefs/apps
2. Click "Create an app" (type: Script)
3. Get your credentials: Client ID, Client Secret

3️⃣ Configure

Edit config.py:

REDDIT_CLIENT_ID = "your_client_id"
REDDIT_CLIENT_SECRET = "your_client_secret"
REDDIT_USERNAME = "your_username"
REDDIT_PASSWORD = "your_password"
SUBREDDIT = "your_subreddit"

4️⃣ Test

python test_setup.py

Should show:

• ✓ Configuration checked
• ✓ Minecraft API working
• ✓ Reddit connection working

5️⃣ Run

python main.py

See posts appear in your subreddit automatically!

---

Optional Config Changes

Check for Snapshots Too

RELEASE_TYPES = ["release", "snapshot"]

Check More Frequently (testing)

CHECK_INTERVAL = 600  # 10 minutes instead of 1 hour

Customize Post Format

Edit the POST_TEMPLATE in config.py - it uses {version} and {release_date} placeholders.

---

Files Overview

• main.py - The bot itself
• config.py - Settings (edit this!)
• minecraft_checker.py - Fetches Minecraft version data
• test_setup.py - Tests your configuration
• DB/ - Stores tracking of posted versions (auto-created)