How To Use

To Use UGK, You Must Put The Following Snippet Of Code Into The First Line Of A Server Script

repeat

wait

()

until

game

.

ServerStorage

:

FindFirstChild

(

"UGK"

)

local

UGK =

require

(

game

.

ServerStorage

.

UGK

)

Config

You Can Find The Config Inside The "UGK" Object


Config Options:
  1. Ranks

    The Ranks List Follows This Format:

    Name Of Rank Rank Power (Max 1000) Rank Details (Display, Color) Users To Give The Rank (UserID)

    Example:

    [

    "Owner"

    ] = {

    1000

    , {

    "👑 Owner"

    ,

    "#F7EF8A"

    }, {

    12345

    ,

    6789

    }};

  2. Gamepasses

    The Gamepass List Follows This Format:

    Gamepass Id Rank Name

    Example:

    [

    12345

    ] =

    "Vip";

  3. Groups

    The Gamepass List Follows This Format:

    Group ID Rank Value Rank Name

    Example:
    [

    12345

    ] = {

    [

    254

    ] =

    "Head Admin"

    ;

    [

    1

    ] =

    "Fan"

    ;

    }

  4. Banned

    The Banned List Is Just A List Of Player Ids
    Example:

    12345

  5. System Settings
    1. Prefix

      The character you use before every command (e.g. ' ̲;kick player').

    2. Split Key

      The character inbetween command arguments (e.g. setting it to '/' would change ';kick player' to ';kick/player').

    3. Show Admin Icon

      Whether not to show the "TC" icon at the top of the screen.

    4. Welcome Badge Id

      The Badge Id Of The Badge To Award The Player When They Join For The First Time

    5. Admin Enabled

      Whether Not TC Admin Is Enabled

    6. Auto Save

      How Often To Autosave Every Players Stats (Seconds, Set To -1 For Never)

DataStores

To Use The DataStore Functionality, Use The Following Snippet:

local

Datastores = UGK.

DataStores


List Of Datastore Commands
  1. Datastores.

    SetPlayer

    Datastores.

    SetPlayer

    (

    Player

    ,

    Key

    ,

    Value

    )
    • Player: Instance, The Player Whose Data We're Saving
    • Key: String, The Key In Which The Value Will Be Stored (Any)
    • Value: String, The Value That Will Be Stored

  2. Datastores.

    GetPlayer

    Datastores.

    GetPlayer

    (

    Player

    ,

    Key

    )
    • Player: Instance, The Player Whose Data We're Getting
    • Key: String, The Key From Which The Value Will Be Retrieved

  3. Datastores.

    Set

    Datastores.

    Set

    (

    DataStore

    ,

    Key

    ,

    Value

    )
    • DataStore: String, The Datastore To Save The Value To (PlayerData Or GameData)
    • Key: String, The Key In Which The Value Will Be Stored (Any)
    • Value: String, The Value That Will Be Stored In The Datastore

  4. Datastores.

    Get

    Datastores.

    Get

    (

    DataStore

    ,

    Key

    )
    • DataStore: String, The Datastore To Get The Value From (PlayerData Or GameData)
    • Key: String, The Key From Which The Value Will Be Retrieved

Leaderstats

To Use The Leaderstat Functionality, Use The Following Snippet:

local

Leaderstats = UGK.

Leaderstats


List Of Leaderstat Commands

Coming Soon....

Extra Info

Please Note That Most Of The Code On This Page Is Case Sensitive, So I Would Recommend You Copy And Paste The Code Instead Of Typing It By Hand.