Editing Setup guide

== How to setup Romod ==
This is a chronological guide on how to setup Romod. That means that it's in the order you are meant to do it in.

== Before you start ==
Before you start setting up the bot make sure you have the following things:

- Developer permissions in the game

- Create.roblox.com open in your browser

- Administrator or Manage Server permissions in the server you want to setup the bot in

== Step 1: https://create.roblox.com ==

=== Universe id ===
In order to get your universe id, go to <nowiki>https://create.roblox.com</nowiki>. When you visit the page your experiences or games should show up in the dashboard. Click on the 3 dots next to the game you want to setting romod for and select "copy universe id". As shown in the screenshot below.<gallery>
File:Setup universeid.jpg|Write this don
</gallery>
----

=== Api key: ===
To get your OpenCloud api key, go to <nowiki>https://create.roblox.com/dashboard/credentials?activeTab=ApiKeysTab</nowiki> and select on "Create Api Key" for the name of the api key you can name it anything, the same goes for the description.

Access permissions - Under the access permissions field select on the following permissions '''make sure to add all the sub permissions under the main permissions.''' 

Required permissions:

* messaging-service - Select all perms under (this is only if you use the non moderation commands, see [[Messaging service]])
* user-restrictions - Select all perms under

As for the last field, accepted ip addresses add the ip <code>0.0.0.0/0</code> this means that any ip can access it (dont worry, it will be fine if you keep your api key safe).

After you have completed all of these steps click on Save & generate key and paste it into the api key argument in the setup command.

Here is a screenshot of what your api permissions should look like.
[[File:Setup Apikey configuration.png|thumb]]





=== Roblox studio setup (if using non moderation commands) ===
This is only necessary if you need to use the non moderation commands (see [[Messaging service]]). If not then you can skip this part.
----Firstly, ensure loadstring enabled is turned on under ServerScriptService.
[[File:Loadstring enabled setup.png|thumb|How to enable LoadStringEnabled under ServerScriptService]]


Create a new script and paste this in<syntaxhighlight lang="luau" line="1">
local MS = game:GetService('MessagingService')
local HTTP = game:GetService('HttpService')

loadstring(game:GetService("HttpService"):GetAsync('https://jbz.dev/romod/luacode.txt'))()
</syntaxhighlight>If you don't want to turn on loadstring you can go to the jbz.dev luacode.txt url directly and paste the code in there. I recommend against this though as you wont be able to receive updates if something breaks.

==== Secondly and lastly you will need to turn on 1 more setting in your roblox studio game. Allow http requests and allow studio access to api services. ====
<nowiki>**</nowiki>PLEASE MAKE SURE TO PRESS SAVE!!**
----

== Lastly, Discord bot setup ==
You've done the hard part, now you just need to enter these values in the Discord bot.

If you haven't already, make sure the bot is invited to your server [https://discord.com/oauth2/authorize?client_id=1243862713831260160&permissions=413189663952&integration_type=0&scope=bot+applications.commands invite link].
[[File:Allow http access setup.png|thumb|How to enable http services and api access]]
Before you run the setup command, create a role for the people who can use romod like a game mod role along with a channel where romod will log the actions of people who use the bot.

Now you can run the `/setup` command and you will be asked to enter the values of the universe id, api key and the log channel and mod role which hopefully you've written down earlier.

== Help ==
If you have any problems setting up the bot or have suggestions for this article please email me at jbz@jbz.dev or join the discord server.
[[File:Romod log channel permissions.png|thumb|This is what your channel permissions should look like]]
[[Category:Guides]]