Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/capabilities.md → docs/sandboxing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
[Script capabilities] is used to sandbox Purse to ensure safety and prevent malicious code.
[Script capabilities] is used to sandbox Purse and tools to ensure safety and prevent malicious code.

!!! danger
This is optional and disabled by default but can be enabled using the [`Sandboxed`][Sandboxed] property.

Malicious clones may remove script capabilities sandboxing. Double check the [`Capabilities`][Capabilities] property and that [`Sandboxed`][Sandboxed] is enabled.
!!! warning

By enabling script capabilities, all tools will be sandboxed. Make sure you have [`Capabilities`][Capabilities] for your tools set on top of Purse or they will error.

[Script capabilities]: https://create.roblox.com/docs/scripting/capabilities
[Capabilities]: https://create.roblox.com/docs/scripting/capabilities#capabilities
Expand All @@ -15,6 +17,8 @@ Purse uses the following capabilities:
* **AssetRead** - Check for latest version
* **AssetManagement** - Preload icon images
* This capability does not allow read, create, or update operations on assets
* **AvatarAppearance** - Equip and unequip tools
* **AvatarBehavior** - Equip and unequip tools
* **Basic** - Run Purse
* **CreateInstances** - Create GUI instances
* **Input** - Binding for equipping slots and toggling inventory
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ nav:
- Installation: installation.md
- Guide: guide.md
- Performance: performance.md
- Capabilities: capabilities.md
- Sandboxing: sandboxing.md
- Philosophy: philosophy.md
- API Reference: api-reference.md
4 changes: 2 additions & 2 deletions models/Purse/init.meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"properties": {
"Capabilities": {
"SecurityCapabilities": 224447170816
"SecurityCapabilities": 9007424238782720
},
"Sandboxed": true
"Sandboxed": false
}
}
Loading