This repository has been archived by the owner on May 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
about.html
72 lines (68 loc) · 4.77 KB
/
about.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<title>Scratch Addons | About</title>
<link rel="stylesheet" href="style.css">
<script src="https://kit.fontawesome.com/a076d05399.js">
</script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script src="https://code.iconify.design/1/1.0.7/iconify.min.js"></script>
</head>
<body>
<nav>
<div class="logo">
<img src="logo.png" href="https://github.com/Scratch Addons" style="width: 8%; height: auto; border-radius: 50%; float: left; margin-right: 20px;">
Scratch Addons
</div>
<input type="checkbox" id="click">
<label for="click" class="menu-btn">
<i class="fas fa-bars"></i>
</label>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="about.html">About</a></li>
<li><a href="contribute.html">Contribute</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="contributors.html">Contributors</a></li>
</ul>
</nav>
</body>
<br><br><br><br><br><br>
<span id="download" class="iconify" data-icon="flat-color-icons:about" data-inline="false"></span><br><br>
<h1 style="text-align: center;" id="effect">About Scratch Addons</h1>
<p>Scratch Addons is a WebExtension (supports both Chrome and Firefox). Scratch Addons’ mission is to combine all existing Scratch extensions, userscripts and userstyles into a single easy-to-access place, while still letting users choose which ones to enable.<br><br></p>
<h3 style="text-align: center;">What actually is an "addon"?</h3>
<p>An addon is similar to an extension or a userscript, but they use special APIs provided by the Scratch Addons extension. These APIs allow addons to run scripts on a Scratch page (userscripts), run scripts on the background (persistent scripts), or apply styles to the Scratch website (userstyles).
Userscripts and persistent scripts can use the addon.* JavaScript APIs, which allow them to obtain Scratch-related information (for example, get the current logged in user) and also use extension APIs (like sending notifications).
Converting an already existing extension/userscript into an addon, or writing your own, is very easy. <a href="https://github.com/Scratch Addons/Scratch Addons/wiki/Creating-an-addon">Check out the guide</a>.<br><br></p>
<h3 style="text-align: center;">If everything is an addon that what does Scratch Addons do?</h3>
<p>Scratch Addons by itself is just an addon loader. Its main tasks are:</p>
<ul id="readable_list">
<li>Allow users to enable, disable and configure addons.</li>
<li>Run addons and provide APIs to them.</li>
<li>Provide global state to addons (for example, the addon.auth API).</li>
<li>Pollute prototypes for use by addon userscripts.</li>
<li>Provide ways to access and modify Redux state.</li>
<li>Avoid addons from interfering with each other.</li>
<li>Avoid duplicate work from different addons.</li>
</ul><br><br>
<h3 style="text-align: center;">Installation</h3>
<p>No build is required. After cloning the repository to your computer, just load the extension by following these steps. <br><br>
<h4 style="padding: 20px; text-decoration: underline; text-align: center">Chrome</h4>
<ol style="list-style-type: lower-roman;">
<li>Open <a href="chrome://extensions">chrome://extensions</a> to open the Extension Management page by typing it into your address bar.</li>
<li>Enable Developer Mode by clicking the toggle switch next to Developer mode.</li>
<li>Click the LOAD UNPACKED button on the top and select the extension directory which has the manifest.json file in it.</li>
</ol>
<h4 style="padding: 20px; text-decoration: underline; text-align: center">Firefox</h4>
<ol style="list-style-type: lower-roman;">
<li>Open <a href="about:debugging">about:debugging</a> to open the add-ons page by typing it into your address bar.</li>
<li>Click This Firefox on the right-hand menu.</li>
<li>Click Load Temporary Add-on... and select the manifest.json file.</li>
</ol>
<br><br>
<h3 style="text-align: center;">Contribute</h3>
<p>If you found a bug, or want to suggest new features, please use the <a href="https://github.com/Scratch Addons/Scratch Addons/issues">issues tab</a>. If you want to help with the code or add a new addon, fork this repository, and then create a <a href="https://github.com/Scratch Addons/Scratch Addons/pulls">pull request</a>. Also, please read our <a href="https://github.com/Scratch Addons/Scratch Addons/blob/master/CONTRIBUTING.md">contributing guidelines</a>.</p>
<h3 style="text-align: center;">License</h3>
<p>Scratch Addons is licensed under the terms of the <a href="https://github.com/Scratch Addons/Scratch Addons/blob/master/LICENSE">GNU General Public License v3.0</a>.</p>