https://github.com/tyradigital/tyblox.js
https://github.com/tyradigital/tyblox.js
api api-wrapper js node nodejs roblox roblox-api roblox-api-wrapper roblox-js
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tyradigital/tyblox.js
- Owner: tyradigital
- License: mit
- Created: 2021-11-18T14:57:32.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-18T14:06:20.000Z (about 4 years ago)
- Last Synced: 2024-04-25T11:02:09.538Z (about 2 years ago)
- Topics: api, api-wrapper, js, node, nodejs, roblox, roblox-api, roblox-api-wrapper, roblox-js
- Language: JavaScript
- Homepage: https://tyra.digital/opensource/tyblox-js
- Size: 104 KB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
tyblox.js
The most powerful ROBLOX API Wrapper
---
**tyblox.js** is the most powerful [Node.js](https://nodejs.org/) package which allows you to quickly, and easily interact with the Roblox API.
- Object-Oriented
- Performant
- Typescript Capable
## Installation
**Node.js 16.6.0 or newer is required for this to work properly**
**NPM 7.0.0 or newer is required to work properly.**
```sh
$ npm install tyblox.js
$ yarn add tyblox.js
```
**or for development previews, which may be buggy**
```sh
$ npm install tyblox.js@dev
```
---
## Getting started
Below is an example to login and access many features of tyblox.js
```js
require("dotenv").config();
const { Client } = require("tyblox.js");
const client = new Client();
client.on("ready", () => {
console.log("Ready!");
console.log("Logged in as " + client.user.username);
});
client.login(process.env.example_cookie);
```