Merge branch 'main' into codespaces

.editorconfig

@@ -1,4 +1,4 @@
-[*.lua]
+[*.luau]
 indent_style = tab
 indent_size = 4
 charset = utf-8

.github/workflows/CI.yml → .github/workflows/ci.yml

@@ -1,6 +1,22 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+
+  pull_request:
+    paths-ignore:
+      - "**"
+      - "!.github/workflows/ci.ya?ml"
+      - "!**.luau"
+
+  push:
+    paths-ignore:
+      - "**"
+      - "!.github/workflows/ci.ya?ml"
+      - "!**.luau"
+
+permissions:
+  contents: read
 
 jobs:
   lint:
@@ -11,7 +27,6 @@ jobs:
       - name: Setup Selene
         uses: ok-nick/[email protected]
         with:
-          cache: true
           token: ${{ secrets.GITHUB_TOKEN }}
       - name: Run Selene
         run: selene src
@@ -21,7 +36,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Run StyLua
-        uses: JohnnyMorganz/stylua-action@v3
+        uses: JohnnyMorganz/stylua-action@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest

.github/workflows/documentation.yml

@@ -1,8 +1,12 @@
-name: documentation
+name: Build Documentation
 
 on:
   push:
     branches: ["main"]
+    paths-ignore:
+      - "**"
+      - "!.github/workflows/documentation.ya?ml"
+      - "!docs/**"
 
   workflow_dispatch:
 
@@ -29,7 +33,7 @@ jobs:
             mkdocs.yml
 
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
 
       - name: Setup Python runtime
         uses: actions/setup-python@v5

.github/workflows/markdown.yml

@@ -1,6 +1,22 @@
 name: markdown
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+
+  pull_request:
+    paths-ignore:
+      - "**"
+      - "!.github/workflows/markdown.ya?ml"
+      - "!**.md"
+
+  push:
+    paths-ignore:
+      - "**"
+      - "!.github/workflows/markdown.ya?ml"
+      - "!**.md"
+
+permissions:
+  contents: write
 
 jobs:
   lint:
@@ -9,6 +25,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Run markdownlint
-        uses: DavidAnson/markdownlint-cli2-action@v15
+        uses: DavidAnson/markdownlint-cli2-action@v16
         with:
+          fix: true
           globs: "**/*.md"

.github/workflows/release.yml

@@ -0,0 +1,75 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      draft:
+          description: 'This release will be saved as a draft and not published.'
+          default: false
+          required: false
+          type: boolean
+      prerelease:
+        description: 'This release will be labeled as non-production ready.'
+        default: false
+        required: false
+        type: boolean
+      tag_name:
+        description: 'Choose an existing tag, or create a new tag when you publish this release.'
+        required: true
+        type: string
+      make_latest:
+        description: 'This release will be labeled as the latest for this repository.'
+        default: true
+        required: false
+        type: boolean
+
+permissions:
+  contents: write
+  discussions: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Aftman
+        uses: ok-nick/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Wally
+        env:
+          WALLY_AUTH_TOKEN: ${{ secrets.WALLY_AUTH_TOKEN }}
+        run: |
+          wally login --token "$WALLY_AUTH_TOKEN"
+          wally install
+
+      - name: Build using Rojo
+        run: |
+          mkdir builds
+          rojo build --output builds/Satchel.rbxm default.project.json
+          rojo build --output builds/Satchel.rbxmx default.project.json
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: builds/
+          generate_release_notes: true
+          tag_name: ${{ inputs.tag_name }}
+          draft: ${{ inputs.draft }}
+          prerelease: ${{ inputs.prerelease }}
+          make_latest: ${{ inputs.make_latest }}
+
+      - name: Publish to Wally
+        run: wally publish
+
+      - name: Archive build files
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-file-builds
+          path: builds/
+          if-no-files-found: error
+          compression-level: 9

.gitignore

@@ -49,13 +49,5 @@ site*/
 # Rojo
 sourcemap.json
 
-# Added by cargo
-
-/target
-
-
-# Added by cargo
-#
-# already existing elements were commented out
-
-#/target
+# Workflow builds
+builds/

.markdownlint.json

@@ -2,5 +2,6 @@
     "MD013": false,
     "MD024": false,
     "MD033": false,
-    "MD041": false
+    "MD041": false,
+    "MD046": false
 }

.vscode/settings.json

@@ -1 +1,13 @@
-{}
+{
+  "yaml.schemas": {
+    "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+  },
+  "yaml.customTags": [
+    "!ENV scalar",
+    "!ENV sequence",
+    "!relative scalar",
+    "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+    "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+    "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+  ]
+}

CITATION.cff

@@ -6,7 +6,7 @@ authors:
   - family-names: Luu
     given-names: Ryan
     orcid: https://orcid.org/0009-0004-0813-879X
-version: 1.2.0
+version: 1.3.0
 date-released: "2023-7-3"
 keywords:
   - github

README.md

@@ -12,9 +12,10 @@
   [![GitHub release](https://img.shields.io/github/v/release/RyanLua/Satchel?include_prereleases&logo=robloxstudio&logoColor=white&color=00a2ff&style=for-the-badge)](../../releases)
   [![GitHub top language](https://img.shields.io/github/languages/top/RyanLua/Satchel?logo=lua&color=00a2ff&style=for-the-badge)](../../search?l=lua)
   [![GitHub license](https://img.shields.io/github/license/RyanLua/Satchel?logo=mozilla&color=00a2ff&style=for-the-badge)](LICENSE.txt)
+  [![Discord](https://img.shields.io/discord/1162303282002272359?style=for-the-badge&label=discord&logo=discord&color=00a2ff&logoColor=white)](https://discord.gg/hYU4rvT7DK)
 
+  [![Download](https://gist.githubusercontent.com/RyanLua/d507e8ad7581fe264deb91606954b920/raw/8013a784d7518ddd465512d31f4f51e18d35c06c/GitHubDownloadBadge.svg)](https://github.com/RyanLua/Satchel/releases/latest/download/Satchel.rbxm)
   [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/RyanLua/Satchel?quickstart=1)
-
 </div>
 
 Satchel is a modern open-source alternative to Roblox's default backpack. Satchel aims to be more customizable and easier to use than the default backpack while still having a "vanilla" feel. Installation of Satchel is as simple as dropping the module into your game and setting up a few properties if you like to customize it. It has a familiar feel and structure as to the default backpack for ease of use for both developers and players.
@@ -75,7 +76,7 @@ Installation of Satchel is easy and painless. Satchel is a drag-and-drop module
 
 <details>
 
-<summary><h3>Install from Creator Marketplace</h3></summary>
+<summary>Install from Creator Marketplace</summary>
 
 1. Get the Satchel module from the [Creator Marketplace](https://create.roblox.com/marketplace/asset/13947506401).
 ![CreatorMarketplace](assets/CreatorMarketplace.png)
@@ -98,7 +99,7 @@ Installation of Satchel is easy and painless. Satchel is a drag-and-drop module
 
 <details>
 
-<summary><h3>Install from GitHub Releases</h3></summary>
+<summary>Install from GitHub Releases</summary>
 
 1. Download the `Satchel.rbxmx` file from [Releases](../../releases).
 ![GitHubRelease](assets/GitHubReleases.png)
@@ -142,7 +143,7 @@ Satchel has it's very own [documentation site](https://ryanluu.dev/Satchel) you
 
 <details>
 
-<summary><h3>Attributes</h3></summary>
+<summary>Attributes</summary>
 
 Satchel supports instance attributes allowing you to change and customize many aspects including various behaviors in a friendly easy-to-use interface without having to touch any code. Below see all attributes.
 
@@ -153,7 +154,7 @@ Satchel supports instance attributes allowing you to change and customize many a
 | CornerRadius: [`UDim`](https://create.roblox.com/docs/reference/engine/datatypes/UDim) | Determines the radius, in pixels, of the default inventory window and slots. | `0, 8` |
 | EquipBorderColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the equip border when a slot is equipped. | `[255, 255, 255]` |
 | EquipBorderSizePixel: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Determines the pixel width of the equip border when a slot is equipped. | `5` |
-| FontFace: [`Font`](https://create.roblox.com/docs/reference/engine/enums/Font) | Determines the font of the default inventory window and slots. | `Gotham SSm` |
+| FontFace: [`Font`](https://create.roblox.com/docs/reference/engine/enums/Font) | Determines the font of the default inventory window and slots. | `Builder Sans` |
 | InsetIconPadding: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Determines whether or not the tool icon is padded in the default inventory window and slots. | True |
 | OutlineEquipBorder: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Determines whether or not the equip border is outline or inset when a slot is equipped. | True |
 | TextColor3: [`Color3`](https://create.roblox.com/docs/reference/engine/datatypes/Color3) | Determines the color of the text in default inventory window and slots. | `[255, 255, 255]` |
@@ -165,7 +166,7 @@ Satchel supports instance attributes allowing you to change and customize many a
 
 <details>
 
-<summary><h3>Methods</h3></summary>
+<summary>Methods</summary>
 
 Satchel offers access to some of its internal methods and events for scripting purposes. Below see a table with all the methods available.
 

default.project.json

@@ -1,7 +1,7 @@
 {
   "name": "Satchel",
   "servePort": 34872,
-  "globIgnorePaths": ["**/*.spec.lua"],
+  "globIgnorePaths": ["**/*.spec.luau"],
   "tree": {
     "$path": "src"
   }

docs/alternatives.md

@@ -2,11 +2,6 @@
 title: Alternatives
 description: Alternatives to Satchel along with pros and cons.
 icon: material/card-multiple-outline
-comments: true
-tags:
-  - Others
-  - Comparison
-  - Third-party
 ---
 
 Satchel isn't the best backpack system out there or the only one but it does offer some advantages against others. Some free and open-souce alternaves of Satchel.