Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Home

Jump to bottom
Exeboii edited this page Mar 12, 2025 · 2 revisions

🚀 Boters GitHub Wiki Documentation

This wiki provides complete documentation for setting up and using Boters, a Cloudflare-style CAPTCHA Shield for GitHub Pages.

📌 Introduction

Boters is an advanced anti-bot security system designed to protect GitHub Pages websites from automated spam, bots, and fake traffic. It works similarly to Cloudflare’s "Checking Your Browser" page and verifies real users before allowing them access.

🌟 Features

✅ Pre-Website CAPTCHA Verification – Ensures only real users can enter.
✅ Mouse Movement Detection – Blocks bots that do not move the mouse.
✅ Hidden Honeypot Trap – Invisible fields that bots automatically fill, leading to instant failure.
✅ Loading Animation & Smooth Redirect – Cloudflare-like verification experience.
✅ Email Alert for Bots – Sends an alert to the developer if a bot is detected.
✅ Completely Free & Open Source – Works without any paid services.

📥 Installation

Step 1: Clone or Fork the Repository

git clone https://github.com/YOUR-USERNAME/YOUR-REPO.git

or

  • Fork the repository on GitHub.
  • Upload the files manually if needed.

Step 2: Enable GitHub Pages

  1. Go to your repository → Settings → Pages
  2. Set the Source to main branch and Save
  3. Your site will be live at: 
    https://yourusername.github.io/yourrepo/

🔗 Integration with GitHub Pages

Option 1: Meta Redirect (Simple)

Edit your index.html file and add this inside <head>:

<meta http-equiv="refresh" content="0;url=captcha.html">

✅ Now, when someone visits your website, they will first see the Boters verification page before being redirected to the main site.

Option 2: JavaScript Redirect (Advanced)

If you want users to see CAPTCHA only once per session, use this method:

1️⃣ Add This to index.html

<script>
    if (!sessionStorage.getItem("captchaVerified")) {
        window.location.href = "captcha.html";
    }
</script>

2️⃣ Modify captcha.html

Once the user passes verification, set a session variable before redirecting:

sessionStorage.setItem("captchaVerified", "true");
window.location.href = "index.html";

✅ Now, users won’t see CAPTCHA again if they refresh the page!

🎨 Customization

Changing CAPTCHA Appearance

Modify the styles in captcha.html inside <style> to change colors, fonts, or sizes. Example:

body { background: #000000; color: #ffffff; } /* Dark theme */
.captcha-box { font-size: 24px; color: #ffcc00; } /* Yellow CAPTCHA text */

Redirect to a Different Page

In captcha.html, change:

window.location.href = "index.html";

Replace "index.html" with your main website’s URL.

Modify CAPTCHA Length

In captcha.html, change this line:

for (let i = 0; i < 6; i++) {  // 6-character CAPTCHA

Change 6 to any number for a longer or shorter CAPTCHA.

🛡️ Bot Detection System

  1. Mouse Movement Tracking – If no mouse movement is detected, the user is flagged as a bot.
  2. Hidden Input Honeypot – Bots auto-fill this field and get blocked.
  3. Click Delay Check – Ensures checkbox is not clicked instantly.
  4. Email Alert for Bots – Sends an email to the developer if bot behavior is detected.

Configuring Email Alerts

Edit this part in captcha.html and replace "[email protected]":

function sendEmailAlert() {
    let developerEmail = "[email protected]";
    let emailBody = encodeURIComponent("🚨 Bot detected on your site! Take action immediately.");
    window.location.href = `mailto:${developerEmail}?subject=Bot Alert&body=${emailBody}`;
}

✅ Now, if a bot is detected, an email alert will be sent!

📜 License

This project is licensed under the MIT License.

MIT License  

Permission is granted, free of charge, to use, copy, modify, and distribute this software,  
as long as this copyright notice remains in all copies.  

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.

✅ Full license details are in the LICENSE file.

🤝 Contributing

We welcome contributions! If you want to improve Boters, follow these steps:

  1. Fork this repository
  2. Make changes and test
  3. Submit a Pull Request (PR)

❓ FAQ

1. Will this work with GitHub Pages?

✅ Yes! Boters is designed specifically for GitHub Pages and works without any backend.

2. How can I modify the CAPTCHA style?

Edit the CSS styles in captcha.html.

3. Can I use this on non-GitHub Pages websites?

✅ Yes! You can host it on any static site hosting service like Netlify, Vercel, or your own server.

4. How do I stop CAPTCHA from appearing repeatedly?

Use the sessionStorage method mentioned in the Integration section above.

5. How can I get help?

If you face any issues:

  • Check the Issues section on GitHub
  • Contact the project owner via email or commit.

🚀 Ready to Use Boters?

Just fork this repository, follow the setup guide, and enjoy a bot-free website!

🔗 Project Repository: GitHub - NOTGENZ/Boters

🔥 Enjoy safe and secure browsing with Boters! 🚀

📌 How to Add This Wiki to GitHub

1️⃣ Go to your GitHub repo → Wiki → Create a new page
2️⃣ Copy & paste this Markdown content
3️⃣ Save the page and publish it!

✅ Now your project has a professional, fully documented GitHub Wiki! 🚀🔥

Bhai, yeh full GitHub Wiki ready hai! 💯
Agar koi aur feature ya improvement chahiye, bata de! 😎

Clone this wiki locally