Skip to content

Commit

Permalink
README.md Update
Browse files Browse the repository at this point in the history
Signed-off-by: MagicOfLolis <[email protected]>
  • Loading branch information
magicoflolis committed Sep 10, 2021
1 parent 52617e9 commit c07da2b
Show file tree
Hide file tree
Showing 13 changed files with 267 additions and 107 deletions.
15 changes: 15 additions & 0 deletions README.de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
112 changes: 112 additions & 0 deletions README.gf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Magic Userscript+

> [09/09/21] Greasy Fork version may not work due to userscript library being removed. Use [GitHub](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/dist/magic-userjs.user.js) version for now.
*Fork of [Userscript+ : Show Site All UserJS](https://greasyfork.org/scripts/24508-userscript-show-site-all-userjs). Source code & authors information found [here](https://github.com/jae-jae/Userscript-Plus#userscript).*

> Finds available UserJS for current site.
![Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

***

| Version | Link | Note | Alternative | Build |
|:----------:|:----------:|:----------:|:----------:|:----------:|
Chrome | ~~Install [Chrome Web Store]~~ | **There are no excluded websites, use at your own risk.** *Must be installed [manually](#manual-install).* | [Install [GitHub]](https://github.com/magicoflolis/Userscript-Plus/releases) | [Extension](#build-setup)
Firefox | [Install [Firefox Add-ons]](https://addons.mozilla.org/addon/userscript-plus) | **There are no excluded websites, use at your own risk.** *Can be installed [manually](#manual-install).* | [Install [GitHub]](https://github.com/magicoflolis/Userscript-Plus/releases) | [Add-on](#build-setup)
Userscript | [Install](#install-area) | The userscript **WON'T** work for all websites, [info](#known-bugs). | [Install [GitHub]](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/dist/magic-userjs.user.js) | [Userscript](#build-setup)

***

## Features

**_Optional_** *install [Greasyfork Search with Sleazyfork Results include](https://greasyfork.org/scripts/23840).*

> Currently [Userscript+](https://github.com/jae-jae/Userscript-Plus#userscript) can only find userscripts through __GreasyFork__, I've added support for __SleazyFork__ along with a few additional features and tweaks!
* Tested and compatible with TamperMonkey n ViolentMonkey.
* Trimmed / moved some @resources to this build.
* Added [SleazyFork](https://sleazyfork.org).
* Added Dark Theme.
* Added extra @excludes.
* Added built-in [Greasyfork Search with Sleazyfork Results include](https://greasyfork.org/scripts/23840).

```bash
let sleazyfork_redirect = false; // "true" to enable, "false" to disable
```

## Known bugs

* [ User Script ] *May* conflict with a few running user scripts. (Example: [Twitter External Translator](https://greasyfork.org/scripts/421643))
* [ All ] May leave a opened tab when installing user scripts.
* [ User Script ] Found count may not appear.
* [ User Script ] In some sites below the plug-in interface icon is not displayed

> **Reason**:This is because the security policy of these sites to prevent the plug-in icon font file loading, resulting in the icon does not display properly.
## Manual Install

Chromium

* Download and unzip [latest release](https://github.com/magicoflolis/Userscript-Plus/releases) into desired folder.
* Go to chromium/chrome *Extensions*.
* Click to check *Developer mode*.
* Click *Load unpacked extension...*.
* In the file selector dialog:
* Select the directory `userscript_for_tampermonkey-*` / desired folder.
* Click *Open*.

Firefox

> See: [Temporary installation in Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox)
* Download and unzip [latest release](https://github.com/magicoflolis/Userscript-Plus/releases) into desired folder.
* Copy and paste `about:debugging#/runtime/this-firefox` into your URL.
* Click *Load Temporary Add-on…*.
* In the file selector dialog:
* Select the directory `userscript_for_tampermonkey-*` / desired folder.
* Click *Open*.

## Build Setup

> Developed using [VSCodium](https://vscodium.com).
| Help Links |
|:----------:|
[web-ext documentation](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/) |
[http-server](https://github.com/http-party/http-server) |
[How to edit scripts with your favorite editor?](https://violentmonkey.github.io/posts/how-to-edit-scripts-with-your-favorite-editor/#install-a-local-script) |

```bash
# Install dependencies ( if error use npm i --force )
npm i
# [ Production ] Builds both User Script and Browser Extension
npm run build:all
# [ Development ] User Script
# Recommend bookmarking for faster deployment
# http://localhost:8080/magic-userjs.user.js
npm run dev:user
npm run http-server
# [ Development ] Browser Extension
# For Firefox use web-ext
# Recommended to create additional profile about:profiles
web-ext run -p <profile>
npm run dev:browser
# For Chrome load unpacked, REPLACE manifest.json with chrome-manifest.json
```

## Source Code

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

### License

MIT

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.it.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ let sleazyfork_redirect = false; // "true" to enable, "false" to disable

## Known bugs

* [ All ] May leave a opened tab when installing User Scripts.
* [ User Script ] *May* conflict with a few running user scripts. (Example: [Twitter External Translator](https://greasyfork.org/scripts/421643))
* [ All ] May leave a opened tab when installing user scripts.
* [ User Script ] Found count may not appear.
* [ User Script ] In some sites below the plug-in interface icon is not displayed

Expand Down
15 changes: 15 additions & 0 deletions README.nl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.pl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.pt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
15 changes: 15 additions & 0 deletions README.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Magic Userscript+

![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

## Source Code

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

### Contacts

[GitHub](https://github.com/magicoflolis)

[Twitter](https://twitter.com/for_lollipops)

[Greasy Fork](https://greasyfork.org/users/166061)
109 changes: 3 additions & 106 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,113 +1,10 @@
# Magic Userscript+

> Finds available UserJS for current site.
![Menu Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

*Fork of [Userscript+ : Show Site All UserJS](https://greasyfork.org/scripts/24508-userscript-show-site-all-userjs). Source code & authors information found [here](https://github.com/jae-jae/Userscript-Plus#userscript).*
## Source Code

## Features

*Recommended to install ["Greasyfork Search with Sleazyfork Results include"](https://greasyfork.org/scripts/23840)*

> Currently [Userscript+](https://github.com/jae-jae/Userscript-Plus#userscript) can only find userscripts through [GreasyFork](https://greasyfork.org), I've added support for [SleazyFork](https://sleazyfork.org) along with a few additional features and tweaks!
* Tested and compatible with TamperMonkey n ViolentMonkey.
* Trimmed / moved some @resources to this build.
* Added [SleazyFork](https://sleazyfork.org).
* Added Dark Theme.
* Added extra @excludes.
* Added built-in ["Greasyfork Search with Sleazyfork Results include"](https://greasyfork.org/scripts/23840)

```bash
let sleazyfork_redirect = false; // "true" to enable, "false" to disable
```

![Preview](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/resources/preview.png)

***

**Chrome:**

> **There are no excluded websites, use at your own risk.**
* ~~Chrome Web Store~~
* [GitHub Releases](https://github.com/magicoflolis/Userscript-Plus/releases)

**Firefox:**

> **There are no excluded websites, use at your own risk.**
* [Add-ons web site](https://addons.mozilla.org/firefox/addon/userscript-plus)
* [GitHub Releases](https://github.com/magicoflolis/Userscript-Plus/releases)

**User Script:**

> The userscript **WON'T** work for all websites, [info.](#known-bugs)
* [Greasy Fork](https://greasyfork.org/scripts/421603)
* [GitHub Direct Link](https://github.com/magicoflolis/Userscript-Plus/raw/master/dist/magic-userjs.user.js)

**Manual:**

Chromium

* Download and unzip [latest release](https://github.com/magicoflolis/Userscript-Plus/releases) into desired folder.
* Go to chromium/chrome *Extensions*.
* Click to check *Developer mode*.
* Click *Load unpacked extension...*.
* In the file selector dialog:
* Select the directory `userscript_for_tampermonkey-*` / desired folder.
* Click *Open*.

Firefox

> See: [Temporary installation in Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox)
* Download and unzip [latest release](https://github.com/magicoflolis/Userscript-Plus/releases) into desired folder.
* Copy and paste `about:debugging#/runtime/this-firefox` into your URL.
* Click *Load Temporary Add-on…*.
* In the file selector dialog:
* Select the directory `userscript_for_tampermonkey-*` / desired folder.
* Click *Open*.

***

## Known bugs

* [ All ] May leave a opened tab when installing User Scripts.
* [ User Script ] Found count may not appear.
* [ User Script ] In some sites below the plug-in interface icon is not displayed

> **Reason**:This is because the security policy of these sites to prevent the plug-in icon font file loading, resulting in the icon does not display properly.
## Build Setup

> Additional help
* [web-ext documentation](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/)
* [http-server](https://github.com/http-party/http-server)
* [How to edit scripts with your favorite editor?](https://violentmonkey.github.io/posts/how-to-edit-scripts-with-your-favorite-editor/#install-a-local-script)

```bash
# Install dependencies ( if error use npm i --force )
npm i
# [ Production ] Builds both User Script and Browser Extension
npm run build:all
# [ Development ] User Script
# Recommend bookmarking for faster deployment
# http://localhost:8080/magic-userjs.user.js
npm run dev:user
npm run http-server
# [ Development ] Browser Extension
# For Firefox use web-ext
# Recommended to create additional profile about:profiles
web-ext run -p <profile>
npm run dev:browser
# For Chrome load unpacked, REPLACE manifest.json with chrome-manifest.json
```

## License

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

### Contacts

Expand Down

0 comments on commit c07da2b

Please sign in to comment.