Update README.md
This commit is contained in:
parent
5f260a620e
commit
dadaab5a5c
1 changed files with 50 additions and 35 deletions
85
README.md
85
README.md
|
|
@ -1,59 +1,74 @@
|
||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
> We're not related in any way to the official POLYTORIA team. This project is made by the community.
|
> 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]
|
> [!IMPORTANT]
|
||||||
> This extension is in BETA, some features may be missing, and bugs found. If you found any bugs please report [Here](https://github.com/IndexingGitHub/PolyPlus/issues)
|
> 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.
|
||||||
|
|
||||||
# Poly+
|
# 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!
|
|
||||||
---
|
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/)!
|
||||||
|
|
||||||

|

|
||||||

|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
---
|

|
||||||
|
|
||||||
|
^ shields.io for the badges ❤️
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
|
||||||
- Pinned Games
|
- Pinned Games
|
||||||
- Forum Mentions
|
- Forum Mentions
|
||||||
|
- Best Friends
|
||||||
|
- Improved Friend Lists
|
||||||
|
- IRL Price with Brick Count
|
||||||
|
- Hide Sidebar Notification Badges
|
||||||
- Theme Creator
|
- Theme Creator
|
||||||
- Store owned Tags
|
- Store `owned` Tags
|
||||||
|
- More Search Filters
|
||||||
|
- Modify Navbar
|
||||||
|
- Free Membership Themes
|
||||||
|
- Multi-Cancel Outbound Trades
|
||||||
- Item Wishlist
|
- Item Wishlist
|
||||||
And more to come!
|
- Outfit Cost
|
||||||
|
And there is more to come!
|
||||||
|
|
||||||
# Supported Browsers
|
# Supported Browsers
|
||||||
As of right now, Poly+ only works on chromium-based browsers and Firefox (however it has not been tested and is not going to be as maintained). Currently, there are no plans to bring it to other browsers in the future.
|
|
||||||
|
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
|
> TL;DR Chromium-based browsers
|
||||||
### Examples
|
|
||||||
- Opera(GX, One and Normal)
|
## Examples of Browsers that are Chromium-based
|
||||||
- Google Chrome
|
- Google Chrome
|
||||||
- Arc
|
|
||||||
- Chromium
|
- Chromium
|
||||||
- Brave
|
|
||||||
- Edge
|
- Edge
|
||||||
|
- Opera (& it's variations)
|
||||||
|
- Brave
|
||||||
|
- Arc
|
||||||
|
|
||||||
# How to Download?
|
# Downloading
|
||||||
1. First enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
|
||||||
2. Second click the "Load Unpacked" button
|
|
||||||
3. Third when the file selector comes up pick the unzipped folder from this GitHub repository
|
|
||||||
4. Fourth go to Polytoria and you should see the extension's button on the sidebar
|
|
||||||
|
|
||||||
# <span style="color:red">CAUTION!</span> Hmm, i am feeling adventurous!
|
## How to Download - Stable Build?
|
||||||
## Here's how to install the Unstable Version
|
|
||||||
1. Go to the top of the page
|
1. Go to the releases section of this GitHub repository
|
||||||
|
3. Go to the latest release and download the .ZIP file for that release
|
||||||
|
4. Extract the .ZIP
|
||||||
|
5. Enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
||||||
|
6. Click the "Load Unpacked" button
|
||||||
|
7. When the file selector comes up, open the unzipped folder from this GitHub repository
|
||||||
|
8. 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
|
2. Click on the "Code" button
|
||||||
3. Click in Download Zip
|
3. Click on the "Download ZIP" button in the dropdown menu
|
||||||
4. Extract the zip
|
4. Extract the .ZIP
|
||||||
5. Click on extensions -> Manage Extensions
|
5. Enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
||||||
6. Click on Developer Mode
|
6. Go to your browsers extensions page (usually `browserName://extensions`)
|
||||||
7. Load without compressing
|
8. Click the "Load Unpacked" button
|
||||||
8. Find the folder you extracted
|
9. When the file selector comes up, open the unzipped folder of this repository's source code
|
||||||
9. And now you have it!
|
10. Go to Polytoria and you should see some changes!
|
||||||
|
|
||||||
# How to update it?
|
|
||||||
1. Uninstall the extension
|
|
||||||
2. Delete the old folder and .zip file
|
|
||||||
3. Download the new version
|
|
||||||
4. Follow the step 3 and 4 from How to Download's tab.
|
|
||||||
|
|
|
||||||
Reference in a new issue