https://github.com/memorycode/cirrus

A Luau library for interacting with Roblox's Open Cloud
https://github.com/memorycode/cirrus

Last synced: 5 days ago
JSON representation

A Luau library for interacting with Roblox's Open Cloud

• Host: GitHub
• URL: https://github.com/memorycode/cirrus
• Owner: memorycode
• License: apache-2.0
• Created: 2024-07-02T16:52:17.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-19T00:25:20.000Z (4 months ago)
• Last Synced: 2024-07-19T08:36:46.154Z (4 months ago)
• Language: Luau
• Homepage:
• Size: 18.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-roblox - Cirrus - A Luau library for interacting with Roblox's Open Cloud. (Libraries / Open Cloud)

README

        
# Cirrus

Cirrus is a Luau (Lune) library for interacting with Roblox's Open Cloud.

> [!WARNING]

The API is unstable and changing often.

## Supported Endpoints

✅ full

🟡 some

❌ none

| V2 | Status |         | V1 | Status |

| :---: | :---: | :---: | :---: | :---: |

| Creator Store | ❌ | | Assets | ❌

| Groups | ❌ | | Data Stores |  ❌

| Instances | ❌ | | Messaging | ✅ 

| Inventory | ❌ | | Place Publishing | ✅ 

| Memory Stores | 🟡

| Places | ✅

| Subscriptions | ❌

| Universes | ❌

| Users | 🟡

## Example

```luau

-- Create Cirrus client

local cirrus = Cirrus.new({

	apiKey = process.env.API_KEY,

	retries = 0,

})

local v1, v2 = cirrus.v1, cirrus.v2

-- Call v2 endpoints

local response = v2.user:generateThumbnail({ userId = 4000, size = "48x48", format = "PNG", shape = "ROUND" })

if response.ok then

	print(response.data)

else

	print(response.reason)

end 

-- Call v1 endpoints

v1.messaging:publish({

	message = "Hello",

	topic = "topic",

	universeId = 1,

})

```