Viscra

Setup Guide

Getting Started

Welcome to Viscra. This guide walks you through setting up the bot in your Discord server

Before you begin: You need the Manage Server permission in the Discord server you want to set up Viscra in and may need other permissions for different features.

1. Invite the Bot

Click here to invite the bot

  1. Click the invite link above and select your server.
  2. Review the requested permissions and click Authorise. We recommend giving Viscra administrator permissions.
  3. Once invited, Viscra will appear in your member list and you can access this dashboard.

2. Dashboard Access

The dashboard is one of the primary way to configure Viscra. All settings are applied instantly, you can also run commands in your server (such as /settings) to manage these.

  1. Visit dashboard.viscra.uk and sign in with Discord.
  2. Select your server from the Your Servers page.
  3. Use the sidebar to navigate between configuration sections.

3. Verification Setup

Verification allows members to link their Roblox account to their Discord profile via Roblox's OAuth2 flow.

Once verified, members are assigned the Verification Role if configured. Unverified members receive the Unverified Role, if configured.

Roles to Configure

  • Verification Role Assigned once a member successfully verifies their Roblox account.
  • Unverified Role Assigned to members who have not verified yet.

You can setup a verification panel (a button in a channel where members can initiate the verification process) via the /roblox panel [channel] command

4. Role Binds

Role binds can be setup to assign or remove Discord roles based on a member's Roblox group membership and rank. Members can receieve bound roles for groups they're in via the /update command or via ;update.

Group Bind

Assigns a role to anyone in the specified Roblox group, regardless of rank.

Group binds can be set to inverse, where they only get the role(s) if they're not in the specified Roblox group.

Rank Bind

Assigns a role to members at a specific rank within the group. Optionally set a naming scheme using {roblox_username} to format their Discord nickname which also supports a priority value.

5. Logging

You can setup Viscra to log specific server actions, such as kicks, bans, message deletes/edits and member joins/leaves.

Logs are sent to a specified channel and can be setup via the dashboard's logging section or via the /settings command and navigating to the logging section.

6. Ticket System

The ticket system supports categories and specific channels for panels, allowing users to create and manage support tickets efficiently for different issues.

The system goes off the primary naming scheme and support roles, these can be overriden by using ticket categories when making a ticket panel.

To configure categories, you can use the /ticket options command and select the categories tab, there you can manage or create categories selecting a naming scheme for the channels, support roles, and what category the ticket channel should be made in.

You can use the same command to manage panels, when creating panels you have the option to select a category or just go off the main configurations.

7. Leveling

The leveling system allows members to gain levelling XP and level up within your Discord server via chatting or activity in voice channels (time spent in VC).

You can configure the XP multiplier, level up channel, level specific roles and channel where XP cannot be earnt via the dashboard or via /settings and selecting the levelling category.

There is an option decay system, which reduces a member's level over time if they are inactive; this can be configured in the leveling settings on both the dashboard and via the /settings command.

8. API Keys

API keys allow your Roblox game to communicate with Viscra to trigger promotions, update XP, and other in-game systems such as extensions.

You can also create a public API key, which allows you to interact with Viscra's public API for integration into your own systems.

API keys can be created, revoked, or regenerated at any time via the API Keys section of the dashboard or via the /apikeys command.

Store your keys securely - they are only shown once when generated. Regenerating a key invalidates the previous one immediately. Viscra staff will never ask for your API keys, and you should not share them with anyone you do not trust.

9. Premium Features

Viscra offers a premium tier to support development & maintenance costs. This is $2.99/month and can be purchased via the bots profile in Discord (on the store page) and by selecting your server.

  • Group Logs — Log Roblox group rank changes directly in Discord.
  • Whitelabel — Run Viscra under your own Discord bot profile with a custom token and status.

10. Group logs

Group logs allow you to log Roblox group rank changes directly in Discord. This is a premium feature, see above for details.

To use group logs you'll need to have an alternate account in any groups you want to log and give it ranking & audit log permissions, then get the cookie/token from the account and set it via the /settings command in the Roblox tab.

To get the cookie/token (.ROBLOXSECURITY), log into Roblox on a desktop browser, press F12 (or Ctrl+Shift+I) to open Developer Tools, navigate to the Application tab, click Cookies then find https://www.roblox.com, and locate the value for .ROBLOSECURITY

Never share your cookie/token with anyone, the bot encrypts the value in our database. Viscra staff will never ask for your cookie/token.

Group logs support different types, main group, and sub groups.

  • Main group logs will log rank changes in the group above the provided rank id and will ping for those changes.
  • Sub group logs will log rank changes for all ranks but will only ping for changes above the provided rank id. Sub groups are preferred for large groups (such as main groups with 100+ members) as they are less likely to hit rate limits and cause missed logs.

Group logs can be configured from the dashboard or via the /grouplogs command, where you can also set the role that is pinged for 'HICOM' changes.

11. Game bans

Game bans allow you to ban a user from your game via the bot in your server.

To set it up, use /settings, head to the Roblox tab, and authorise gamelink (and select your game), you'll also need to configurethe universe id (can be found on the Roblox creator hub).

12. XP System

The XP system allows members to earn XP in-game and and rank up in configured groups.

The XP system requires the ViscraHandler module from here (our support server).

  • Configure the promotion requirements in the ViscraConfigs module.
  • Set your API key and server ID in the ViscraConfigs module.
  • Authorise gamelink in the dashboard or via /settings and navigating to the Roblox tab.

    • Your configuration should look something like this:


    local Configs = {
	APIKey = "viscra_gk_........", -- The key generated with /apikeys generate (a game key, server owner only)
	--[[
	
		DO NOT share this with anyone, including Viscra staff. If you believe your key has been compromised, regenerate it immediately and update your game with the new key.
	
	]]
	
	serverId = "1411468373803663523", -- The ID of your server
	GroupId = 34801188, -- The group the bot will be ranking in (must have a bot linked in the server with perms in the group)
	XPEarningTeams = {game.Teams.Red}, -- Table of teams a user can earn XP on, eg: {game.Teams.Red}, or {game.Teams.Red, game.Teams.Blue}, or just {},
	XPSystemEnabled = true, -- Whether you want players to be able to earn XP at all,
	
	statName = "Merit", -- The name of the stat that the auto-rank will run off, eg: Power
	statIncreaseInterval = 5, -- MINUTES! This will be how often the stat is increased
	statIncrease = 1, -- The amount the stat will increase every time it's given
	
	promotionReqs = {
		[1] = {
			statReq = 0, -- Base level
			groupRoleId = 1, -- Default rank (entry, such as recruit)
		},
		[2] = {
			statReq = 2, -- How high the player's stat specified above will need to be to proceed
			groupRoleId = 2, -- The id of the role the user will be promoted to on attaining the above
		},
		[3] = {
			statReq = 4, -- How high the player's stat specified above will need to be to proceed
			groupRoleId = 3, -- The id of the role the user will be promoted to on attaining the above
		},
		--// Continue from here if needed
	},
	
	-- Extra XP teams
	
	otherTeams = { -- if you're not using the otherTeams values you'll get an error, to fix it just remove the inside of this table to make "otherTeams = {}"
		{
			GroupId = 34801188, -- The group the bot will be ranking in (must have a bot linked in the server with perms in the group)
			XPEarningTeams = {game.Teams.Blue}, -- Table of teams a user can earn XP on, eg: {game.Teams.Red}, or {game.Teams.Red, game.Teams.Blue}, or just {},

			statName = "Raider Merit", -- The name of the stat that the auto-rank will run off, eg: Power
			Reference = "RM", -- The reference, changing this will remove it from your server data and clear any players current progress on this value

			promotionReqs = {
				[1] = {
					statReq = 0, -- Base level
					groupRoleId = 1, -- Default rank (entry)
				},
				[2] = {
					statReq = 2, -- How high the player's stat specified above will need to be to proceed
					groupRoleId = 2, -- The id of the role the user will be promoted to on attaining the above
				},
				[3] = {
					statReq = 4, -- How high the player's stat specified above will need to be to proceed
					groupRoleId = 3, -- The id of the role the user will be promoted to on attaining the above
				},
				--// Continue from here if needed
			},
		}
	}
}

return Configs

Troubleshooting

To resolve common issues with Viscra, please follow these steps. If you cannot find a solution, please reach out for support.

Bot not assigning roles?

  • Ensure Viscra's role is above the roles it needs to assign in your server's role order.
  • Check that the member has run /verify or /update after your bind changes.
  • Verify the Group ID and Rank ID are correct in your bind configuration.
  • Allow up to a minute after rank changes before updating a user.

Dashboard not showing my server?

  • Make sure you have the Manage Server permission in that server.
  • Confirm Viscra is actually in the server, it won't appear if the bot hasn't been invited.

Automatic promotions not working?

  • Ensure the promotion requirements are correctly configured in the ViscraConfigs module in your game.
  • Check you have set a valid API key and your server ID in the ViscraConfigs module.
  • Ensure you have authorised Viscra to promote users via the /settings command, navigating to the Roblox tab and selecting authorise gamelink.

Still stuck?

Open a ticket in our support server or email support@viscra.uk.