Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/compeydev/roblox.js

⚒ A JavaScript wrapper for the ROBLOX OpenCloud API.
https://github.com/compeydev/roblox.js

javascript nodejs opencloud roblox roblox-js typescript wrapper-library

Last synced: about 6 hours ago
JSON representation

⚒ A JavaScript wrapper for the ROBLOX OpenCloud API.

Host: GitHub
URL: https://github.com/compeydev/roblox.js
Owner: CompeyDev
License: mit
Created: 2022-09-12T07:32:56.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-09-17T05:41:39.000Z (about 1 year ago)
Last Synced: 2024-10-29T00:14:27.130Z (10 days ago)
Topics: javascript, nodejs, opencloud, roblox, roblox-js, typescript, wrapper-library
Language: TypeScript
Homepage: https://npm.im/rblx.js
Size: 245 KB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

A JavaScript wrapper for the ROBLOX OpenCloud API.

---

# Introduction
Recently at RDC 2022, ROBLOX announced OpenCloud API endpoints for DataStore, MessagingService and more to programatically access Roblox Studio Services from external sources. These would have official libraries for languages such as Python and JavaScript eventually, but until then, roblox.js bridges this gap as an API wrapper.

# Installation
## Yarn:
```console
yarn add rblx.js
```

## NPM:
```console
npm i rblx.js
```

# Usage
Roblox.js is a OpenCloud API wrapper with full TypeScript support. Once installed, you can access the following classes:
- Datastore
- MessagingService

Functions are named similar to the Lua equivalents and follow a similar structure. Each class is initialized with a universeId and an apiKey from https://create.roblox.com/credentials.

# Documentation
For detailed documentations and examples check out [the wiki](https://github.com/CompeyDev/roblox.js/wiki) or the [`docs`](https://github.com/CompeyDev/roblox.js/tree/HEAD/docs) directory.

# License
[MIT](https://compeydev.mit-license.org) © DevComp - see the [LICENSE.md](LICENSE) file for details.