rblx-open-cloud
rblx-open-cloud is a Python API wrapper for Roblox Open Cloud.
Key Features
- Support for most endpoints, including the OAuth2 flow and authentication.
- Allows both syncronous and asyncronous usage.
- Logic for operation polling and internal error retrying.
Documentation: https://rblx-open-cloud.readthedocs.io/en/latest/
Quickstart
Getting Started
- Install the library with pip in your terminal.
# Stable (PyPi, recommended)
pip install rblx-open-cloud~=2.0
# Development (GitHub)
pip install "rblx-open-cloud @ git+https://github.com/treeben77/rblx-open-cloud@main"
- Create an API key from the Creator Dashboard. You can read Managing API Keys for help.
You've got the basics down, below are examples for some of the APIs.
Accessing Data Stores
import rblxopencloud
# create an Experience object with your experience ID and your api key
# TODO: replace '13058' with your experience ID
experience = rblxopencloud.Experience(13058, api_key="api-key-from-step-2")
# get the data store, using the data store name and scope (defaults to global)
datastore = experience.get_data_store("data-store-name", scope="global")
# sets the key 'key-name' to 68 and provides users and metadata
# DataStore.set does not return the value or an EntryInfo object, instead it returns a EntryVersion object.
datastore.set("key-name", 68, users=[287113233], metadata={"key": "value"})
# get the value with the key 'number'
# info is a EntryInfo object which contains data like the version code, metadata, userids and timestamps.
value, info = datastore.get("key-name")
print(value, info)
# increments the key 'key-name' by 1 and ensures to keep the old users and metadata
# DataStore.increment retuens a value and info pair, just like DataStore.get and unlike DataStore.set
value, info = datastore.increment("key-name", 1, users=info.users, metadata=info.metadata)
print(value, info)
# deletes the key
datastore.remove("key-name")
Publishing To Message Service
NOTE: Messages published with Open Cloud only arrive in live game servers and not in Studio.
import rblxopencloud
# create an Experience object with your experience ID and your api key
# TODO: replace '13058' with your experience ID
experience = rblxopencloud.Experience(13058, api_key="api-key-from-step-2")
# publish a message with the topic 'topic-name'
experience.publish_message("topic-name", "Hello World!")
Uploading Assets
NOTE: Only Decal, Audio, and Model (fbx) are supported right now.
import rblxopencloud
# create an User object with your user ID and your api key
# TODO: replace '13058' with your user ID
user = rblxopencloud.User(13058, api_key="api-key-from-step-2")
# or, create a Group object:
group = rblxopencloud.Group(13058, api_key="api-key-from-step-2")
# this example is for uploading a decal:
with open("path/to/file.png", "rb", encoding="utf-8") as file:
asset = user.upload_asset(file, rblxopencloud.AssetType.Decal, "name", "description").wait()
print(asset.id)
Examples for more APIs are avalible in the examples directory.
1 maintainer
Metadata
1 maintainer
Release files for rblx-open-cloud 2.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rblx_open_cloud-2.3.0.tar.gz | 105.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rblx_open_cloud-2.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 235.3 kB
Release files / rblx_open_cloud-2.3.0.tar.gz
| Download URL | rblx_open_cloud-2.3.0.tar.gz |
|---|---|
| Size | 105.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
003821ee6c499e3fa06a9e687215e9861eedc239d716b33817177244d75220aa
|
|
BLAKE2b-256 checksum How to use checksums |
21bdc7bb98cb2c84c1b681523722fc487580fb92ffce2b11bdfe8ef8ea0a83f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / rblx_open_cloud-2.3.0-py3-none-any.whl
| Download URL | rblx_open_cloud-2.3.0-py3-none-any.whl |
|---|---|
| Size | 129.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a8f3b2b9b7f8b53871dc212ae67bce0b3d86a66793d759969b5b0ef77632d42e
|
|
BLAKE2b-256 checksum How to use checksums |
ff77cff86b42094aef1dffe01961dbe1aff06d39a05355594e85249ef4f0d07a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
