Developer docs
A Bento plugin is a folder of Luau that runs in the Bento Box client. Try it from your plugins folder, then publish it to the marketplace with one command.
Start here
- Write a pluginThe package shape, a complete example, every hook, and editor types for luau-lsp.
- Plugin API referenceEvery global, type and method a plugin can call, generated from the live declaration.
- Package and publishThe archive rules, what a listing needs to go live, the CLI and the HTTP API behind it.
Plugin API
Every type has its own page. Press / to search by name.
- Plugin1 type
- The game59 types
- Constants306 types
- Entities29 types
- Coordinates2 types
- Queries6 types
- Passed to hooks13 types
- Options you pass in38 types
- Compatibility classes243 types
By domain
The types each lowercase global returns.
Publishing endpoints
Releasing comes down to four versioned requests, and npx @bentobot/cli push makes the upload for you. The listing requests take a browser session or a CLI access token scoped to plugin:publish; the source upload takes a one-use upload ticket. How sign-in and upload tickets work.
| Step | Request |
|---|---|
| Create a draft | POST /api/v1/plugins |
| Update a listing | PUT /api/v1/plugins/:id/listing |
| Submit source | POST /api/v1/plugins/:id/submissions |
| List a draft | POST /api/v1/plugins/:id/publish |
Your plugins
Drafts, listings, pricing and release notes are on Your plugins. Any account with an active plan can publish.