This repository has been archived on 2026-01-04. You can view files and clone it, but cannot push or open issues or pull requests.
polyplus/README.md
2024-05-27 22:02:41 +00:00

80 lines
3 KiB
Markdown

> [!CAUTION]
> Poly+ is in no way affiliated with the Polytoria team. This is a project I started for the community - and I hope some community members are willing to help with development so the extension is better for everyone ❤️.
> [!IMPORTANT]
> This extension is currently in BETA. If you find any bugs, please report them in this repository's issues section as it'd be a great help towards development of the extension.
> [!TIP]
> Want to learn what's in store for Poly+? Check out the roadmap [here](https://github.com/users/indexxing/projects/2)!
# Poly+
Poly+ is an upcoming quality-of-life browser extension for the Polytoria website! The extension provides tons of improvements to improve your experience on Polytoria! Visit the website [here](https://polyplus.vercel.app/)!
![image](https://img.shields.io/badge/Google_chrome-4285F4?style=for-the-badge&logo=Google-chrome&logoColor=white)
![image](https://img.shields.io/badge/Microsoft_Edge-0078D7?style=for-the-badge&logo=Microsoft-edge&logoColor=white)
![image](https://img.shields.io/badge/Opera-FF1B2D?style=for-the-badge&logo=Opera&logoColor=white)
![image](https://img.shields.io/badge/Brave-FF1B2D?style=for-the-badge&logo=Brave&logoColor=white)
![image](https://img.shields.io/badge/Vivaldi-EF3939?style=for-the-badge&logo=Vivaldi&logoColor=white)
^ shields.io for the badges ❤️
# Features
- Pinned Games
- Forum Mentions
- Best Friends
- Improved Friend Lists
- IRL Price with Brick Count
- Hide Sidebar Notification Badges
- Theme Creator
- Store `owned` Tags
- More Search Filters
- Modify Navbar
- Free Membership Themes
- Multi-Cancel Outbound Trades
- Item Wishlist
- Outfit Cost
And there is more to come!
# Supported Browsers
As of right now, Poly+ only works on Chromium-based browsers. Currently, there are no plans to bring it to other browsers in the future.
> TL;DR Chromium-based browsers
## Examples of Browsers that are Chromium-based
- Google Chrome
- Chromium
- Edge
- Opera (& it's variations)
- Brave
- Arc
# Downloading
## How to Download - Stable Build?
1. Go to the releases section of this GitHub repository
2. Go to the latest release and download the .ZIP file for that release
3. Extract the .ZIP
4. Enable developer mode on your browser (developer mode allows you to load unpacked extensions)
5. Click the "Load Unpacked" button
6. When the file selector comes up, open the unzipped folder from this GitHub repository
7. Go to Polytoria and you should see some changes!
## How to Download - Pre-Release Build?
> Pre-Release builds may have work in progress features or bugs!
1. Go to the top of this GitHub repository
2. Click on the "Code" button
3. Click on the "Download ZIP" button in the dropdown menu
4. Extract the .ZIP
5. Enable developer mode on your browser (developer mode allows you to load unpacked extensions)
6. Go to your browsers extensions page (usually `browserName://extensions`)
7. Click the "Load Unpacked" button
8. When the file selector comes up, open the unzipped folder of this repository's source code
9. Go to Polytoria and you should see some changes!