Skip to content

Commit 757ccd4

Browse files
committed
Updated README.md
Signed-off-by: Magic <magicoflolis@tuta.io>
1 parent 6cf9d91 commit 757ccd4

10 files changed

Lines changed: 124 additions & 29 deletions

File tree

README.md

Lines changed: 49 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,42 +7,53 @@
77
>
88
> [https://developer.mozilla.org/docs/Web/HTTP/CSP](https://developer.mozilla.org/docs/Web/HTTP/CSP)
99
10-
![GitHub License](https://img.shields.io/github/license/magicoflolis/Userscript-Plus)
11-
[![GitHub Release](https://img.shields.io/github/release/magicoflolis/Userscript-Plus)](https://github.com/magicoflolis/Userscript-Plus/releases/latest)
12-
[![Greasy Fork Downloads](https://img.shields.io/greasyfork/dt/421603)](https://greasyfork.org/scripts/421603)
13-
![jsDelivr hits (GitHub)](https://img.shields.io/jsdelivr/gh/hm/magicoflolis/Userscript-Plus)
14-
[![GitHub Stars](https://img.shields.io/github/stars/magicoflolis/Userscript-Plus)](https://github.com/magicoflolis/Userscript-Plus/stargazers)
10+
![GitHub License](https://img.shields.io/github/license/magicoflolis/Userscript-Plus?style=flat-square)
11+
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/magicoflolis/Userscript-Plus?style=flat-square)
12+
[![GitHub Release](https://img.shields.io/github/release/magicoflolis/Userscript-Plus?style=flat-square)](https://github.com/magicoflolis/Userscript-Plus/releases/latest)
13+
[![Greasy Fork Downloads](https://img.shields.io/greasyfork/dt/421603?style=flat-square)](https://greasyfork.org/scripts/421603)
14+
[![GitHub Stars](https://img.shields.io/github/stars/magicoflolis/Userscript-Plus?style=flat-square)](https://github.com/magicoflolis/Userscript-Plus/stargazers)
1515

16-
*Fork of [Userscript+ : Show Site All UserJS](https://github.com/jae-jae/Userscript-Plus#userscript) - authors & source code found [here](https://github.com/jae-jae/Userscript-Plus)*
16+
*A complete rewrite of [Userscript+ : Show Site All UserJS](https://github.com/jae-jae/Userscript-Plus#userscript) - authors & source code found [here](https://github.com/jae-jae/Userscript-Plus)*
1717

18-
Finds available UserJS for the current webpage, the power of [Greasy Fork](https://greasyfork.org) on the go!
18+
Finds available Userscripts for the current webpage, the power of [Greasy Fork](https://greasyfork.org) on the go!
19+
20+
[Changelog](https://github.com/magicoflolis/Userscript-Plus/releases)
21+
22+
[List of known issues by Web Browser](https://github.com/magicoflolis/Userscript-Plus/blob/master/browser-issues.md)
23+
24+
## **Download**
25+
26+
**Userscript:**
27+
28+
[![Userscript](https://img.shields.io/badge/Userscript-Download-brightgreen.svg?style=flat-square&label=Greasy+Fork&logo=javascript&logoColor=white)](https://github.com/magicoflolis/Magic-PH/blob/master/dist/UserJS/magicph.user.js?raw=1)
29+
[![Userscript](https://img.shields.io/badge/Userscript-Download-brightgreen.svg?style=flat-square&label=GitHub+Repo&logo=javascript&logoColor=white)](https://github.com/magicoflolis/Magic-PH/blob/master/dist/UserJS/magicph.user.js?raw=1)
30+
31+
**Web Extension:**
1932

2033
| Version | Install | Alternative | Notes |
2134
|:----------:|:----------:|:----------:|:----------:|
22-
| Userscript | [Greasy Fork](https://greasyfork.org/scripts/421603) | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | *N/A* |
2335
| Chrome/Edge/Opera | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | *N/A* | Work in progress |
2436
| Firefox | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | [Add-on Store](https://addons.mozilla.org/firefox/addon/userscript-plus/) | Work in progress |
2537

26-
**(Optional) Bookmarklet:**
38+
**(Not Recommended) Bookmarklet:**
2739

28-
> Save this URL as a bookmark, clicking it will cause the userscript version to inject itself into the current webpage.
40+
Save this URL as a bookmark, clicking it will cause the userscript version to inject itself into the current webpage.
2941

3042
```JS
3143
javascript:(function(){['https://cdn.jsdelivr.net/gh/magicoflolis/Userscript-Plus@master/userscript/dist/magic-userjs.user.js'].map(s=>document.body.appendChild(document.createElement('script')).src=s)})();
3244
```
3345

3446
---
3547

36-
| Previews |
48+
| Demos |
3749
|:----------:|
38-
|![Demo 1](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/demo4.gif)|
50+
|![Installing Userscript](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/install-userscript.gif)|
51+
|![Using Tabs](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/using-tabs)|
3952

4053
---
4154

4255
## Features
4356

44-
> [Changelog (GitHub)](https://github.com/magicoflolis/Userscript-Plus/releases)
45-
4657
* Designed for mobile and desktop devices
4758
* Support multiple languages - date formats will match your current language
4859
* Ability to customize theme
@@ -60,7 +71,7 @@ javascript:(function(){['https://cdn.jsdelivr.net/gh/magicoflolis/Userscript-Plu
6071

6172
**Userscript Features:**
6273

63-
> Tested and compatible with [TamperMonkey](https://www.tampermonkey.net/) and [ViolentMonkey](https://violentmonkey.github.io/)
74+
> Tested and compatible with [TamperMonkey](https://www.tampermonkey.net/) or [ViolentMonkey](https://violentmonkey.github.io/)
6475
6576
* Ability to maximize, minimize, or exit the userscript list
6677
* Ability to change the position of floating counter
@@ -78,25 +89,31 @@ javascript:(function(){['https://cdn.jsdelivr.net/gh/magicoflolis/Userscript-Plu
7889

7990
## FAQ / Troubleshooting
8091

81-
Nothing appears bottom right:
92+
**How do I open the menu?:**
93+
94+
* Click or touch the bottom right of a webpage
95+
96+
**Nothing appears bottom right:**
8297

83-
* Try again on another webpage [[Test Page](https://google.com)]
98+
> [List of known issues by Web Browser](https://github.com/magicoflolis/Userscript-Plus/blob/master/browser-issues.md)
99+
100+
* Try again on another webpage [[Test Page](https://youtube.com)]
84101
* Default timeout is 10000ms before the count disappears
85-
* If issue persists, see [Viewing UserJS Logs](#viewing-userjs-logs)
102+
* If issue persists, see [Viewing UserJS Logs](#viewing-userjs-logs) or submit a [New Issue](https://github.com/magicoflolis/Magic-PH/issues/new/choose)
86103

87-
Error occurred while injecting Container:
104+
**Error occurred while injecting Container:**
88105

89-
* Try again on another webpage [[Test Page](https://google.com)]
106+
* Try again on another webpage [[Test Page](https://youtube.com)]
90107
* This error is caused by the current webpage not supporting [attachShadow](https://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow)
91108

92-
Error occurred while loading UserJS for this webpage:
109+
**Error occurred while loading UserJS for this webpage:**
93110

94-
* Reload the webpage or try again on a different webpage [[Test Page](https://google.com)]
111+
* Reload the webpage or try again on a different webpage [[Test Page](https://youtube.com)]
95112
* This error *may* be caused by
96113
* An error occurred in an enabled search engine while fetching content
97114
* Script is unable to fetch content on current or all webpages
98115

99-
No available UserJS for this webpage:
116+
**No available UserJS for this webpage:**
100117

101118
* This error *can* be caused when no UserJS could be found in enabled search engines
102119
* If there are known UserJS to exist in enabled search engines, enable `Filter out other languages`
@@ -105,15 +122,14 @@ No available UserJS for this webpage:
105122

106123
* Open your web browsers Inspect Element and navigate to it's Console
107124
* Locate the following **[UserJS] < message >** ( you can filter your Console by entering **UserJS** or **[** )
108-
* Feel free to screenshot any error messages to the [GitHub](https://github.com/magicoflolis/Userscript-Plus/issues) for addition help
109-
* If nothing appears, this means the script is not executing at all
125+
* **If nothing appears, this means the script is not executing at all!**
126+
* For any additional help, submit a [New Issue](https://github.com/magicoflolis/Magic-PH/issues/new/choose)
110127

111-
## Development
128+
## Build
112129

113-
> Code editor used - [VSCodium](https://vscodium.com)
130+
> Developed in [VSCodium](https://vscodium.com)
114131
115-
Install [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/).
116-
The version of Node.js should match `"node"` key in `package.json`.
132+
Install [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/). The version of Node.js should match `"node"` key in `package.json`.
117133

118134
``` sh
119135
# Install dependencies
@@ -152,6 +168,10 @@ $ pnpm run webpack:FF
152168
# Recommended to create an additional profile "about:profiles" for Firefox.
153169
```
154170

171+
### Roadmap
172+
173+
* Finish webextension version
174+
155175
### Source Code
156176

157177
* [https://github.com/magicoflolis/Userscript-Plus](https://github.com/magicoflolis/Userscript-Plus)

assets/demo1.png

-183 KB
Binary file not shown.

assets/demo2.gif

-16.5 MB
Binary file not shown.

assets/demo3.gif

-2.51 MB
Binary file not shown.

assets/install-userscript.gif

4.76 MB
Loading

assets/step-1.png

398 KB
Loading

assets/step-2.png

396 KB
Loading

assets/step-3.png

598 KB
Loading
File renamed without changes.

browser-issues.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Currently known issues by Web Browser
2+
3+
> Last updated: 4/20/2024
4+
5+
[Submit a New Issue](https://github.com/magicoflolis/Magic-PH/issues/new/choose)
6+
7+
- [Currently known issues by Web Browser](#currently-known-issues-by-web-browser)
8+
- [Google Chrome](#google-chrome)
9+
- [Cromite](#cromite)
10+
- [Kiwi Browser](#kiwi-browser)
11+
- [Microsoft Edge](#microsoft-edge)
12+
- [Mozilla Firefox](#mozilla-firefox)
13+
- [Opera](#opera)
14+
15+
## Google Chrome
16+
17+
**TamperMonkey:**
18+
19+
- N/A
20+
21+
**ViolentMonkey:**
22+
23+
- N/A
24+
25+
## Cromite
26+
27+
**TamperMonkey:**
28+
29+
- N/A
30+
31+
**ViolentMonkey:**
32+
33+
- N/A
34+
35+
## Kiwi Browser
36+
37+
**Installed using (from .zip/.crx/.user.js):**
38+
39+
- Userscript version does not have access to Privileged APIs (`GM_*` or `GM.*`)
40+
- Recommended to install using a userscript manager!
41+
42+
## Microsoft Edge
43+
44+
**TamperMonkey:**
45+
46+
- N/A
47+
48+
**ViolentMonkey:**
49+
50+
- N/A
51+
52+
## Mozilla Firefox
53+
54+
**TamperMonkey:**
55+
56+
- N/A
57+
58+
**ViolentMonkey:**
59+
60+
- N/A
61+
62+
## Opera
63+
64+
**General:**
65+
66+
- Cannot load on search engine sites (common example: [google.com](https://www.google.com))
67+
- As stated using ViolentMonkey: _Violentmonkey cannot run userscripts in this page (common examples: browser UI, an extension, blocked via policies, a search engine site in Opera)_
68+
69+
**TamperMonkey:**
70+
71+
- N/A
72+
73+
**ViolentMonkey:**
74+
75+
- N/A

0 commit comments

Comments
 (0)