This documentation is not yet complete. Information shown may be inaccurate or missing altogether. We appreciate your patience as we improve our documentation.
Downloading the Product
After logging into the website, press 'Download' on the product card.
Downloading easyReviews
Preparing your Game
For our products to work, the game owner must be in the easyPOS group.
Adding onto this, HTTP requests must be enabled.
Inserting the Product
To add easyReviews to your game, right click 'Workspace' and press 'Insert from File'.
Right clicking 'Workspace' in Explorer then pressing 'Insert from File'
Afterwards, locate the file you downloaded from our website and submit it.
Configuration
Location of Settings
The Settings file is located inside the Runtime script as shown below.
Locating Settings
Editing the Questions
You cannot change the amount of ratings available on-screen, there will always be 5.
You can change the question directed at the player based on what rating they'd like to give you.
You can also use the "Validate" function to set limits of the minimum/maximum characters, etc.
We will not provide support for editing the "Validate" function.
Inputs are automatically truncated at 500 characters.
Setting the Webhook
Webhook Settings
You should use a webhook proxy instead of a plain Discord webhook URL here otherwise messages may not be sent.
Webhook Proxies
Click the links below to find out how to use them. You may use another proxy if known to you.
In the same section of the config as the webhook, you can set reviews to be sent in bulk.
This means instead of sending each review one-by-one (1 is sent every 5 seconds for rate limiting purposes), reviews will be sent every 15 minutes and will be included in the same message.
You can enable or disable this feature, even customising the interval of when it's sent.
