# Ranking center

### Implementation

To implement the ranking center, download it from our [downloads page](https://vibez.dev/downloads).

### Usage

#### Important

It is important you keep the Script in `ServerScriptStorage`\
In order for it to properly work, you need to enable "Allow Third Party Teleports" in > Home > Game Settings > Security.

![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FEV5iDBtCIii9e2sTKegN%2Fimage.png?alt=media\&token=44e5159e-836f-4d7a-8ae3-75f72e5520d2)

#### Configuration

In `ServerScriptStorage`you can find a configuration file, below you can find an example:

```lua
-- __     ___ _              
-- \ \   / (_) |__   ___ ____
--  \ \ / /| | '_ \ / _ \_  /
--   \ V / | | |_) |  __// / 
--    \_/  |_|_.__/ \___/___|


-- You are using Vibez ranking centre v1.2
-- Created by AnishMarapin & vdJacob (noob) with <3
-- Modified 2 years later by the one and only LearnCSharp


-- In this file you can edit all the settings on how the ranking centre should behave.
return {
	-- All messages it can display --
	SearchingMessage = 'Searching your inventory for gamepasses...'; -- Displays the message when searching.
	SuccessMessage = 'You were ranked sucessfully!'; -- Displays when a rank was sucessful
	LoadingMessage = 'Loading rank...';
	ErrorMessage = 'You do not own any gamepasses higher than the current rank you have.'; -- Displays when a user doesn't own any gamepases OR if the gamepass rank is lower than the rank the user currently has.
	NotInGroupKickMessage = 'Join the group first before trying to claim a rank.'; -- Is a kick message when the user is not in your group.
	
	-- Other settings --
	title = 'disable'; -- set it to 'disable' to disable, set it to anything else to enable. Displays a title with the text.
	
	-- Ranking Configuration --
	ApiKey = 'YOUR API KEY HERE'; -- Insert here your vibez ranking API key
	Ranks = {
		{
			RankID = 5;
			GamePass = 8787681;
		};
		{
			RankID = 2;
			GamePass = 51844649;
		};
	}
}
	
-- DOCUMENTATION OF THE RANKS --

	
-- 	Ranks = {
--		{
--			RankID = 0; -- Please here the ID the user needs to be ranked to upon purchasing the gamepass.
--			GamePass = 0; -- Place here the gamepassID.
--		};
--	}
--}

```