Skip to content

Commit

Permalink
Shaded docs
Browse files Browse the repository at this point in the history
  • Loading branch information
David-Orangemoon committed Jul 10, 2024
1 parent 18e80b0 commit e9577b9
Show file tree
Hide file tree
Showing 15 changed files with 290 additions and 6 deletions.
1 change: 1 addition & 0 deletions generalImages/ShadedIcon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions generalImages/logoSE.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions main/addonDev/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<page-title>Pen+</page-title>

<h1 class="centered">Pen+ Addon Dev</h1>

<p>
If you want to develop a Pen+ addon you can get the Pen+ addon api <a href="https://github.com/Pen-Group/extensions/blob/main/apis/penPlusAddon.js">here</a>!<br>
All you have to do is put this in with your extension and then you have a new variable called penPlus! This will let you grab info from the extension.
</p>
6 changes: 2 additions & 4 deletions main/extensions/penPlus/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
<h1 class="centered">Pen+</h1>
<p>
Welcome to the official documentation page for the Pen+ extension! This page covers everything in the extension itself.<br>
If you would like something covering the <a href="">shader editor</a> check it's page,
or if you are looking for info about Pen+ addons and it's integration in other extensions please check <a href="">addons</a> section.

NOTE: THAT THIS IS STILL UNDER CONSTRUCTION
If you would like something covering the <a href="?page=shaderEditor%2Fmain">shader editor</a> check it's page,
or if you are looking for info about developing Pen+ addons please check <a href="?page=addonDev%2Fmain">addon development</a>.
</p>
<br>
<br>
Expand Down
45 changes: 45 additions & 0 deletions main/extensions/shaded/blocks/extension/scaleMultiplier.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions main/extensions/shaded/blocks/extension/useOnMyself.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions main/extensions/shaded/blocks/extension/useOnScreen.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions main/extensions/shaded/blocks/extension/useOnSpecific.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions main/extensions/shaded/blocks/shaderEditor/applyColor.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions main/extensions/shaded/blocks/shaderEditor/applyUV.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions main/extensions/shaded/extension.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<page-title>Color Blocks</page-title>

<h1 class="centered">Color Blocks</h1>
<info-box color="#00FF95">This could very well be a stub. Probably isn't though since there are only 2 blocks Unless you want to explain color theory.</info-box>
<p>
This is a really short section. Only Covers two blocks that have to do color based operations.
</p>

<h2>
"use [shader] on the screen"
</h2>
<img src="main/extensions/shaded/blocks/extension/useOnScreen.svg" alt=""></img>
<p>
Applies a shader on the whole stage, unless "No Shader!" is selected.
</p>
<br>

<h2>
"use [shader] on myself"
</h2>
<img src="main/extensions/shaded/blocks/extension/useOnMyself.svg" alt=""></img>
<p>
Applies a shader on the current sprite, unless "No Shader!" is selected.
</p>
<br>

<h2>
"use [shader] on the [layer]"
</h2>
<img src="main/extensions/shaded/blocks/extension/useOnSpecific.svg" alt=""></img>
<p>
Applies a shader on the desired layer, unless "No Shader!" is selected.
</p>
<br>

<h2>
"scale multiplier of the [direction]"
</h2>
<img src="main/extensions/shaded/blocks/extension/scaleMultiplier.svg" alt=""></img>
<p>
returns how much bigger one dimension is then the stage size.
</p>
<br>
20 changes: 20 additions & 0 deletions main/extensions/shaded/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<page-title>Shaded</page-title>

<h1 class="centered">Shaded</h1>
<p>
Welcome to the official documentation page for the Shaded Pen+ Addon! This page covers everything in the extension itself.<br>
If you would like something covering the <a href="?page=shaderEditor%2Fmain">shader editor</a> check it's page.
</p>
<br>
<br>
<p>
Shaded is a Pen+ addon made by <a href="https://www.youtube.com/@obviousalexc">ObviousAlexC</a>/<a href="https://scratch.mit.edu/users/pinksheep2917/">pinksheep2917</a><br>
Shaded allows you to apply custom shaders to the whole stage, or even individual sprites!
</p>
<h2>
Blocks
</h2>
<ul>
<li><a href="?page=extensions%2Fshaded%2Fextension">Extension</a></li>
<li><a href="?page=extensions%2Fshaded%2FshaderEditor">Shader Editor</a></li>
</ul>
25 changes: 25 additions & 0 deletions main/extensions/shaded/shaderEditor.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<page-title>Color Blocks</page-title>

<h1 class="centered">Color Blocks</h1>
<info-box color="#00FF95">This could very well be a stub. Probably isn't though since there are only 2 blocks Unless you want to explain color theory.</info-box>
<p>
This is a really short section. Only Covers two blocks that have to do color based operations.
</p>

<h2>
"Apply Scratch Color Effects"
</h2>
<img src="main/extensions/shaded/blocks/shaderEditor/applyColor.svg" alt=""></img>
<p>
When used under the pixel hat this block applies all scratch color effects.
</p>
<br>

<h2>
"Apply Scratch UV Effects"
</h2>
<img src="main/extensions/shaded/blocks/shaderEditor/applyUV.svg" alt=""></img>
<p>
When used this block applies the scratch effects to the UV coordinates of the shader.
</p>
<br>
6 changes: 5 additions & 1 deletion main/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ <h2>Main Pages</h2>
Pen+
</button>
<button style="width: 100%;" class="left-align" onclick="window.gotoPath('shaderEditor/main')";>
<img src="generalImages/logo.svg" style="width: 32px; height: 32px;" alt="">
<img src="generalImages/logoSE.svg" style="width: 32px; height: 32px;" alt="">
Shader Editor
</button>
<button style="width: 100%;" class="left-align" onclick="window.gotoPath('extensions/shaded/main')";>
<img src="generalImages/ShadedIcon.svg" style="width: 32px; height: 32px;" alt="">
Shaded
</button>
</div>
4 changes: 3 additions & 1 deletion main/shaderEditor/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
<h1 class="centered">Pen+</h1>
<p>
Welcome to the official documentation page for the Pen+ Shader Editor! This page covers everything in the shader editor.<br>
If you would like something covering the <a href="?page=extensions%2FpenPlus%2FpenProperties">extension</a> check it's page.
If you would like something covering the <a href="?page=extensions%2FpenPlus%2Fmain">extension</a> check it's page.
<br><br>
UNDER CONSTRUCTION
</p>
<br>
<br>
Expand Down

0 comments on commit e9577b9

Please sign in to comment.