Installation
Comprehensive instructions on how to set up Vision MIS with your game. Follow on for step by step details on how to achieve success in your installation, and set up your Vision discord bot.
If you want to set up the discord bot integration, skip to discord bot setup
Studio Setup
The following instructions are to be used for installing Vision MIS into your game through Roblox Studio. Please head to [link here] for setting up discord integration.
Ensure you have the licence for this product, through our website or our product hub
Getting started
You must enable HTTP Requests and API Services within the Game Settings tab in Roblox studio. This is located under the Security section. Please ensure this is enabled before opening a ticket with our support team.
Place the file in Workspace
After downloading the product file, drag and drop into Workspace under your game
Ensure HTTP requests/API services are enabled
Check to make sure your security settings are correct. You can do this by heading to Home in Roblox Studio, then Game Settings
Configuration
Under the jaVision folder provided, there will be a Settings script. Please open it to continue.
Discord Bot Setup
Please read the information below before proceeding to setting up the Vision discord bot
You must have a fully working Roblox-setup before continuing with setup on the discord bot
Add the Vision bot to your discord server
If you have not already added the discord bot, you can do so here. Please note, that you must be an Administrator of the guild (server) you wish to setup the Vision bot in.
Follow along and read through
We recommend that you read through all of the documentation thoroughly before contacting support — our support agents follow the same documentation to assist you.
Initial Setup
Please ensure you have each of the following pieces of information before continuing:
| Information | Description |
|---|---|
| Experience Id | The experience id of your game which contains the Vision System. |
| OpenCloud Key | An API key to interact with the in-game Vision System from Discord. |
| Community Id | The id of your Roblox group/community. |
| Log Channel Id | The id of a log channel within your Discord server to send all bot logs to. |
You can retrieve the information through each of the tabs below. We’d recommend keeping all of this stored somewhere as you get each piece of information.
To get started, head to the Creator Dashboard, if you are not already logged in make sure to do so.
Once you are on the home page, you must click View As in the top left of the side-bar and switch to your Roblox Community which owns your game with the Vision System in
Once you have switched to your group, select the Creations tab and find your experience in the list. Once you find the experience with your Vision System in, click the 3 dots that appear when you hover over the game. Once this is done, click Copy Universe ID.
To get started, head to the Creator Dashboard, if you are not already logged in make sure to do so.
Once you are on the home page, you must click View As in the top left of the side-bar and switch to your Roblox Community which owns your game with the Vision System in
Once you have switched to your group, select the Creations tab and find your experience in the list. Once you find the experience with your Vision System in, click the 3 dots that appear when you hover over the game. Once this is done, click Copy Universe ID.
When you enter your OpenCloud Key into our system it automatically encrypts to ensure that, in the event of a data breach, your key remains secure and intact.
-
To get started, head to the Creator Dashboard, if you are not already logged in make sure to do so.
-
Once you have been brought to the API Key page, press Create API Key.
From there, you will be presented a screen to fill in some general information regarding the new API Key. You can fill in the fields with guidance below.
| Field | Description |
|---|---|
| Name | You may set any name you want, we recommend jaVision-Bot |
| Description | A description to describe the key, you may leave this field empty if you would like |
Adding API Systems
MessagingService
Next, scroll down until you find the Access Permissions section. Press the Select API System and scroll down until you find messaging-service , click on it and press Add API System.
After that, ensure to add your experience. You can do that by clicking Select an Experience and then clicking your experience from the given list and pressing Add Experience
The chosen experience must correspond with the experience id retrieved in the previous step. Your Vision system must also be fully setup and working in the experience you select.
Select the API System operation from the Select Operations to Add dropdown and click publish.
Universe Datastores
Head back up to the Select API System dropdown, click it and scroll down until you find universe-datastores , click on it and press Add API System.
By using the same steps before, add your experience by clicking Select an Experience and then clicking your experience from the given list and pressing Add Experience.
Press the Select Operations to Add dropdown and select the following:
If you do not select all the operations above, or select different ones your Vision Botwill not work as intended and may error.
Security
Scroll down until you reach the Security section once the aforementioned steps are completed fully. Inside of the Enter an IP Address or CIDR enter the IP Address 0.0.0.0/0 Then press Add IP Address
This IP Address allows our servers to communicate with Roblox systems through your API Key.
Then make sure to set the Expiration to No Expiration to ensure that the key never expires.
You may set the key with an expiration date but you will have to update the key before it expires, it is recommended to set it to no expiration
Once all the steps above have been completed fully, using the screenshots provided, press the blue Create API Key button and copy the key given to you.
The key given to you is your Roblox OpenCloud Key, keep it safe and never send it to anyone.
Vision Developers and jaDevelopment Staff Members will never ask you for your OpenCloud Key.
To find your community id, head to the Roblox Communities page. Find your group on the left sidebar and click on it. In the URL bar you will find some numbers, this is your community/group id.
Setting Up
Once you have retrieved the necessary information for system setup,
Run the /setup command to initiate the setup process. You will be prompted an embed with a button on it, click the button and a modal form will popup asking you to input the information you retrieved before.
Input the information into all the fields and then click Submit. If the setup was successful you will be notified, else you will receive an error message stating what went wrong.
If you do not want any system logs enter a 0 (zero) when asked for a Channel Id.
If you update your in-game datastore names within your Vision settings, the cached datastore names in our database will become out of sync with the live stores. View the System Refresh section to refresh the cached names.
System Permissions
Ensure that you setup the correct permissions before attempting to run any commands. By default, some commands are locked to “Staff” ranks and some to “Admin” ranks, much like the in-game Vision system. Currently, you are unable to specify which commands you want to lock to administrator or staff members.
Our current command permissions are below:
| Staff & Admin Commands | Admin Commands |
|---|---|
| analytics | attendance |
| year-analytics | timeout-pass grant timeout-pass remove |
| timetable | uniform-pass grant uniform-pass remove |
| search | |
| roleplay-name | |
| timeout-pass has | |
| uniform-pass has | |
| merit | |
| behaviour-point | |
| incident | |
| isolate | |
| detention |
Guild Members who have any administrative roles can access both admin and staff locked commands. Guild Members who have any staff roles can only access staff locked commands.