Installation

My goal is to make this as straightforward as possible

Setting up the proxy

For security, you should probably set up your own proxy. Don't worry, it's not very difficult. If you don't trust glitch.com, you can set it up through heroku or your own hosting provider but there will not be a tutorial for those because it's way more complicated.

1. Sign into / create an account on glitch.com

2. Click on the project link and hit the name in the top left and "Remix Project"

3. Once it's remixed, find the share button and copy the "live site" url.

Tada! You're ready to go and set up the in game side!

Setting up the module

NOTE: For the initial release, I'd recommend using the auto-update loader to keep up to date with bugs but if you're worried about security you can go to the next steps. This version is way easier to set up but it's down to your preference.

local client = require(7721972330)({
    ["proxy"] = ... --> YOUR URL HERE
}).client();

If you don't feel comfortable you can go onto these steps:

The module is what you probably came for, it allows you to interact with the proxy we created previously.

1. Get the source code here.

2. Add it to studio where you want it

3. Set up a script with the client and proxy

local client = require(LOCATION HERE)({
    ["proxy"] = ... --> YOUR URL HERE
}).client();

4. Go to the API reference and go nuts! You're all set up, now it's just time to learn how to actually use it.

pageIntroduction to PromisespageIntroduction to PagespageAPI Reference