Skip to content

Commit bc48259

Browse files
Update readme on instructions on how to create an API key for ocale (#15)
1 parent d3a0667 commit bc48259

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ You can also manually grab a release from the [releases](https://github.com/Robl
1313

1414
Run `rocale-cli help` to see available commands and run `rocale-cli <command> --help` for more information on how to use each command.
1515

16+
## rocale-cli run
17+
18+
To spawn an OCALE task and use `rocale-cli run`, you will need to [create a new place](https://create.roblox.com/dashboard/creations) and generate an [Open Cloud API Key](https://create.roblox.com/dashboard/credentials). Your key will need the following permissions to your place:
19+
20+
- `universe-places:write`
21+
- `luau-execution-sessions:write`
22+
1623
## Building
1724

1825
First, run `foreman install` to install dependencies.
@@ -21,7 +28,7 @@ To build, run `lute scripts/build`. The build artifacts will be created in the `
2128

2229
To build for release, run `lute scripts/build <version> $(git rev-parse HEAD)` to bake the version and commit hash of the build into the binary.
2330

24-
To test, [create a new place](https://create.roblox.com/dashboard/creations) and generate an [Open Cloud API Key](https://create.roblox.com/docs/cloud). Set the `TEST_UNIVERSE_ID`, `TEST_PLACE_ID` and `ROBLOX_API_KEY` environment variables. Then, run `lute scripts/test`.
31+
To test, follow the instructions above to create a new test place. Set the `TEST_UNIVERSE_ID`, `TEST_PLACE_ID` and `ROBLOX_API_KEY` environment variables. Then, run `lute scripts/test`.
2532

2633
## Publishing
2734

0 commit comments

Comments
 (0)