EcoCrates and Pages

Auxilor · Mar 19, 2024 · 92dd864 · 92dd864
1 parent 1cff1cd
commit 92dd864
Show file tree

Hide file tree

Showing 6 changed files with 246 additions and 252 deletions.
diff --git a/docs/all-plugins/pages.md b/docs/all-plugins/pages.md
@@ -0,0 +1,38 @@
+---
+title: GUI Pages
+sidebar_position: 1
+---
+
+## Custom Pages
+Custom pages are used in most of the plugins, and understanding how to correctly configure a GUI page is important to creating your menus.
+
+## How to make a page
+
+Pages consist of three key components, a mask, a pattern, and sometimes a page number. A pattern is the layout of the background or filler items. Think of the pattern section as the GUI, with 9 columns and up to 6 rows. 
+
+Patterns use a simple format:
+`0` is an empty slot.
+`1-9` are the first nine different filler items
+`a-z` is the remaining 26 items.
+In total you could display 35 different items as "filler" items in your GUI.
+
+A mask is the items to be shown in the pattern layout, these work from the top down. You can use the [Item Lookup System](https://plugins.auxilor.io/all-plugins/the-item-lookup-system) here to add custom items, apply names or any other of the options.
+The first item in the list will represent `1` in the pattern, the second item in the list is `2`, etc..
+
+## Example Page Config
+
+```yaml
+    - page: 1
+      mask:
+        items: # The order of items to display
+          - gray_stained_glass_pane # The 1st Item
+          - black_stained_glass_pane # The 2nd Item
+        pattern: 
+          - "222222222"
+          - "211111112"
+          - "222222222"
+```
+
+This example has a surrounding layer of `gray_stained_glass_pane` and a center strip of `black_stained_glass_pane`.
+
+[![Page](https://i.imgur.com/tQLXe3F.png)
diff --git a/docs/ecocrates/animationsandrolls.md b/docs/ecocrates/animationsandrolls.md
@@ -5,46 +5,16 @@ sidebar_position: 4
 
 ## What are rolls?
 
-Whenever you open a crate, it creates a roll and runs it - a roll is essentially an animation, for example CS:GO crates or the Encircle roll.
-
-## List of Rolls
-
-### CSGO
-
-ID: `csgo`
-
-[csgo](https://youtu.be/IGwYEmMBGk8)
-
-### Encircle
-
-ID: `encircle`
-
-[encircle](https://youtu.be/EhLiTVnQ6zs)
-
-### Flash
-
-ID: `flash`
-
-[flash](https://youtu.be/J9S5HKUBFwA)
-
-### Quick
-
-ID: `quick`
-
-[quick](https://youtu.be/_gaMLZ_QM6E)
-
-### Instant
-
-ID: `instant`
-
-[instant](https://youtu.be/U3TNbZMrju4)
-
-### Semi-Instant
-
-ID: `semi_instant`
-
-[semi_instant](https://youtu.be/ecsIdOLwSnU)
-
+Rolls happen whenever you open a crate. It's essentially an animation the player sees before a reward is won.
+
+| Roll ID        | Video                                 |
+| -------------- | ------------------------------------- |
+| `csgo`         | [Video](https://youtu.be/IGwYEmMBGk8) |
+| `encircle`     | [Video](https://youtu.be/EhLiTVnQ6zs) |
+| `flash`        | [Video](https://youtu.be/J9S5HKUBFwA) |
+| `quick`        | [Video](https://youtu.be/_gaMLZ_QM6E) |
+| `instant`      | [Video](https://youtu.be/U3TNbZMrju4) |
+| `semi_instant` | [Video](https://youtu.be/ecsIdOLwSnU) |
 ## Rerolls
 
 Rerolls are a chance to get another reward - you can toggle this in crate config. The GUI is also completely customizable to your liking.