> For the complete documentation index, see [llms.txt](https://tuneguycodr.gitbook.io/robloxy-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tuneguycodr.gitbook.io/robloxy-docs/master.md).

# Introduction

This is the documentation and a guide on using blox.js npm package for your own project. Robloxy is a module for interacting with the roblox API.

Robloxy returns promises, if you do not know what promises are, go [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). If you already know what promises are and have worked with them before, then great! You can resolve promises with the .then() function to resolve it into a JSON set, integer or a string, example code will be given to help first timers!

Roblox API was not created by us and we do not take any credit for creating Roblox or its API

Alright, let's start using this package! First install the package and require it! Run this in your shell!

```
npm i robloxy --save
```

After installing it, require it in your code!

```javascript
const blox = require('robloxy')
```

And boom! You are done! So easy isn't it? Now lets take a look at the functions we offer and how to use them!