Polsu's Overlay

A Hypixel Bedwars Overlay in Python, 100% free and open source!

📖 Table of Contents

• 📝 About
• 📥 Installation
• 📄 Usage
  • 🔍 Features
  • 🆕 Next Features
  • 🐛 Known Bugs
• 💻 Development
  • ⚒️ Requirements
  • 📥 Configuration
  • 🏗️ Build
• 📃 Credits
  • 💻 Developers
  • 📚 Libraries
  • 🎨 Assets
• 📜 License

📝 About

This is the second version of Polsu's Overlay, a powerful Hypixel Bedwars Overlay made in Python.

📥 Installation

Download the latest version of Polsu's Overlay as an executable file (.exe) here.

You can also download the source code and run it with Python (see Development).

Or even download the source code and compile it yourself with PyInstaller (see Development).

📄 Usage

Launch the Overlay and it will automatically ask you to enter your Polsu API Key (you can find it here).

Then you just need to head over to the settings (click the Polsu logo) and choose your Minecraft client (or custom path).

🔍 Features

• Automatically shows stats of players who joined your lobby after you
• Shows party stats
• Shows if players are nicked
• Automatically claim your daily reward
• View your opponent’s quickbuy
• Highly customisable, change the look of the interface. Craft custom themes, you can change:
  • fonts
  • colors
  • icons
  • images
• You can easily know if a player is good or not since the player gets highlighted
• Shows player heads, stars, name, winstreak, fkdr, finals, wlr, wins, bblr, beds and index stats
• You can manually add a plyer to the overlay by doing /msg +<PLAYER> or /w +<PLAYER> in game
• You can manually clear the stats list
• Displays game duration at the top of the window
• Displays player table count
• Tags:
  • Party
  • Nicked
• Ranks (emojis):
  • Overlay User 🎮
  • Premium ✨
  • VIP 🔗
  • Staff 🔨
  • Developer 💻
  • Owner 👑
• Requested players stats are temporarily saved
• Automatic /who
• Discord Rich Presence
• Customizable window opacity, size & opacity
• Custom logs path
• Blacklist System
  • Local blacklists (unlimited)
  • Polsu blacklist

🆕 Next Features

• Shows stats of the player who mentioned you in the lobby
• Keybinds

🐛 Known Bugs

None for the moment.

💻 Development

⚒️ Requirements

• Python: To unlock all the power of Python (v3.11)

📥 Configuration

Create a virtual environment

python3.11 -m venv venv

Activate the virtual environment

# Windows
venv\Scripts\activate.bat

# Linux
source venv/bin/activate

Install the dependencies

pip install -r requirements.txt

Run the program

python main.py

🏗️ Build

Install PyInstaller

pip install pyinstaller

Build the executable file

pyinstaller --noconfirm build.spec

The executable file will be in the dist folder.
You can now run it!

💎 Support us

Hosting our services is not free, so if you like our work, please consider supporting us by buying a premium subscription on our website here.
By becoming a premium user, you not only gain our gratitude, but you also get access to exclusive features, limited only to donators on our Discord bot, Polsu!

We hope we can continue to provide you with the best free services possible, and we thank you for your support!

📃 Credits

💻 Developers

This overlay was entirely made & designed by Polsulpicien.

Special thanks to:

• Zickles
• phiwijo
  for adding a linux support to the overlay.
• Dueel
  for adding support for custom fonts.

📚 Libraries

• PyQt5: Python bindings for the Qt cross-platform application and UI framework (v5.15.2)
• requests: Python HTTP for Humans (v2.26.0)
• asyncio: Asynchronous I/O, event loop, coroutines and tasks (v3.11.0)
• aiohttp: HTTP client/server for asyncio (v3.7.4.post0)
• pypresence: Discord RPC client library for Python (v4.2.0)
• keyboard: Hook and simulate keyboard events on Windows and Linux (v0.13.5)
• DateTime: A Python DateTime library (v4.3)
• pystray: A cross-platform API for writing system tray applications in Python (v0.17.0)
• Pillow: Python Imaging Library (v8.4.0)
• notify-py: A cross-platform Python package to display desktop notifications (v0.4.2)
• pyqt_frameless_window: A PyQt5 widget that can be used to create frameless windows (v1.0.0)
• packaging: Core utilities for Python packages (v21.3)
• pywinctl: A Python library for controlling Windows (v0.1.0)
• PyInstaller: A program that freezes (packages) Python programs into stand-alone executables (v4.5.1)

🎨 Assets

• Copyright 2023 Fonticons, Inc. • Overlay Icons (https://fontawesome.com/)
• Copyright 2017 Jacob Debono • Minecraft Font
• Copyright 2023 Polsu Development • Polsu's Overlay Logo (https://polsu.xyz)

📝 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃                                                        ┃
# ┃                         Polsu                          ┃
# ┃                                                        ┃
# ┃          A Hypixel Bedwars Overlay in Python,          ┃
# ┃               100% free and open source!               ┃
# ┃                                                        ┃
# ┃ • https://polsu.xyz                                    ┃
# ┃ • https://invite.polsu.xyz                             ┃
# ┃ • https://api.polsu.xyz                                ┃
# ┃ • https://discord.polsu.xyz                            ┃
# ┃ • https://premium.polsu.xyz                            ┃
# ┃ • https://overlay.polsu.xyz                            ┃
# ┃                                                        ┃
# ┃                                                        ┃
# ┃ © 2023 - 2024, Polsu Development - All rights reserved ┃
# ┃                                                        ┃
# ┃ Redistribution and use in source and binary forms,     ┃
# ┃ with or without modification, are permitted provided   ┃ 
# ┃ that thfollowing conditions are met:                   ┃
# ┃                                                        ┃
# ┃ 1. Redistributions of source code must retain the      ┃
# ┃    above copyright notice, this list of                ┃
# ┃    conditions and the following disclaimer.            ┃
# ┃                                                        ┃
# ┃ 2. Redistributions in binary form must reproduce the   ┃
# ┃    above copyright notice, this list                   ┃
# ┃    of conditions and the following disclaimer in the   ┃
# ┃    documentation and/or other materials provided       ┃
# ┃    with the distribution.                              ┃
# ┃                                                        ┃
# ┃ 3. Neither the name of Polsu Overlay nor the           ┃
# ┃    names of its contributors may be used to endorse    ┃
# ┃    or promote products derived from this software      ┃
# ┃    without specific prior written permission.          ┃
# ┃                                                        ┃
# ┃ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS     ┃
# ┃ AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED    ┃
# ┃ WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED ┃
# ┃ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A        ┃
# ┃ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL   ┃
# ┃ THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR     ┃
# ┃ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,  ┃
# ┃ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED   ┃
# ┃ TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS  ┃
# ┃ OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)    ┃
# ┃ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER ┃
# ┃ IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      ┃
# ┃ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE ┃
# ┃ USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           ┃
# ┃ POSSIBILITY OF SUCH DAMAGE.                            ┃
# ┃                                                        ┃
# ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛