Skip to content

Commit

Permalink
Update images
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanLua committed Dec 22, 2023
1 parent 6fea145 commit 481b045
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Installation of Satchel is easy and painless. Satchel is a drag-and-drop module
### Install from Creator Marketplace

1. Get the Satchel module from the [Creator Marketplace](https://create.roblox.com/marketplace/asset/13947506401).
![CreatorMarketplace](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/CreatorMarketplace.png)
![Creator Marketplace](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/CreatorMarketplace.png)

2. Open Roblox Studio and create a new place or open an existing place.

Expand All @@ -22,15 +22,15 @@ Installation of Satchel is easy and painless. Satchel is a drag-and-drop module
### Install from GitHub Releases

1. Download the `Satchel.rbxmx` file from [Releases](https://github.com/RyanLua/Satchel/releases).
![GitHubRelease](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/GitHubReleases.png)
![GitHub Release](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/GitHubReleases.png)

2. Open Roblox Studio and create a new place or open an existing place.

3. Go to [Explorer](https://create.roblox.com/docs/studio/explorer) and right click on [`StarterPlayerScripts`](https://create.roblox.com/docs/reference/engine/classes/StarterPlayerScripts) and click on `Insert from file...`.
![InsertFromFile](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/InsertFromFile.png)
![Insert From File](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/InsertFromFile.png)

4. Select the `Satchel.rbxmx` you downloaded from GitHub and click `Open`.
![UploadFile](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/SelectFile.png)
![Upload File](https://raw.githubusercontent.com/RyanLua/Satchel/main/assets/SelectFile.png)

5. Ensure that `Satchel`is in [StarterPlayerScripts](https://create.roblox.com/docs/reference/engine/classes/StarterPlayerScripts).
![Explorer](https://github.com/RyanLua/Satchel/assets/80087248/97d51886-08b6-40bb-b16b-90433dd7d2b7)
6 changes: 4 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ Satchel is highly customizable & adjustable with [instance attributes](https://c
| TextStrokeColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the text stroke of text in default inventory window and slots. | `[0, 0, 0]` |
| TextStrokeTransparency: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the transparency of the text stroke of text in default chat window and slots. | 0.5 |

Example of customization with instance attributes only:
![Attributes](https://github.com/RyanLua/Satchel/assets/80087248/a115e388-de55-4cfa-9c41-63b117df4b74)
<figure markdown>
![Instance Attributes](https://github.com/RyanLua/Satchel/assets/80087248/a115e388-de55-4cfa-9c41-63b117df4b74)
<figcaption>Example of customization using instance attributes</figcaption>
</figure>

### Scripting

Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,8 @@ markdown_extensions:
- pymdownx.superfences
- abbr
- attr_list
- pymdownx.snippets
- pymdownx.snippets
- md_in_html

plugins:
- glightbox

0 comments on commit 481b045

Please sign in to comment.