Plasma Admin

Contents

Introduction

Welcome to the official documentation of Plasma Admin. To start off, Plasma Admin is a universal admin script with plugins and custom commands for certain games.

Plasma Admin fully encourages the use and sharing of plugins, making it one of the most extensible admin scripts available for Roblox.

Plasma Admin is designed to be user-friendly while providing powerful administration tools for Roblox game creators and moderators.

Key Features

Universal compatibility across Roblox games
Extendable plugin system
Custom commands for specific games
Customizable settings and interface
Active community for plugin sharing
Regular updates and improvements

Plugins

You can download or make plugins to extend Plasma Admin's functionality. Plugins are stored in a specific directory within your workspace.

Plugin Location

workspace > Plasma Admin > plugins

This is where you'll put the plugins you download or create.

Download Plugins

Browse and download community-created plugins from our Discord server to enhance your admin experience here: Plasma Admin Discord

Create Plugins

Develop your own plugins with our simple API to add custom functionality to Plasma Admin. Share them with the community.

Making Plugins

Adding Commands

The addcmd function is used to make a command. The arguments are:

Name:
The command name (can include aliases separated by |)
Description:
What shows up on the command list
Function:
The function to execute when the command is called
Split Args:
Whether to split the arguments or not (boolean)
Description:
The Description of the command that shows on the cmdlist

The getPlayer function returns a list of player instances with users that contain the input string in their display or username. You can also use special keywords like "all", "others", "random", or "me". 

addcmd("kill", "kill (plr)", function(plr) 
  local targets = getPlayer(plr) 
  for _, target in pairs(targets) do 
    targetChar = target.Character or target.CharacterAdded:Wait() 
    targetChar:WaitForChild("Humanoid").Health = 0 
  end 
end, true, "Kills the given plr/plrs")

In this example, true means the arguments will be split, allowing multiple arguments to be processed separately. 

addcmd("print", "print (msg)", function(msg) 
  print(msg) 
end, false, "Prints the text entered to the console.")

Here, false means the arguments will stay as one string instead of splitting up.

Tip: Command Aliases

The "|" symbol can be used to separate different aliases for the command.

addcmd("kill|ckill|krill", "kill (plr)", function()...)

Creating Notifications

The createnotification function is used to make notifications for your plugins: 

createnotification("Admin", "This Is A Notification", 5)

This creates a notification that says "Admin: This Is A Notification" that will display for five seconds.

Posting Your Plugin

We have a plugins channel in the Discord server where you can share your creations with the community.

Important

To ensure safety, all plugins MUST be unobfuscated when posted to our community.

Running Commands

The runcommand function can be used to run commands programmatically in Plasma Admin: 

runcommand("re", {})

The table passed is the arguments of the command, while the string is the command to run.

Command Examples

runcommand("kill", {"all"})

Kills all players in the game

runcommand("speed", {"50"})

Sets your character's speed to 50

runcommand("tp", {"me", "player2"})

Teleports you to player2

runcommand("print", {"Hello World"})

Prints "Hello World" to the console

Built in functions

Getting rigtype

The plasmaadmin['is R6'] function is used to get the rigtype: 

plasmaadmin['is R6']()

This returns a true or false value, true if the lp is R6, false if not.

Getting loops and other things

The plasmaadmin['currentloops'] function is used to get the running plasma loops, and some other random things: 

plasmaadmin['currentloops']()

This returns a table of the loops.

Checking windows

The plasmaadmin['settings open'], plasmaadmin['cmds open'], and plasmaadmin['panel open'] functions are used to get if Plasma uis are open.: 

plasmaadmin['cmds open']()

This returns true if the cmd list is open, false if not. This is the same with the others.

Checking game

The plasmaadmin['game supported'] function is used to check if the games supported: 

plasmaadmin['game supported']()

This returns a true if the game is supported, false if not.

Getting chat prefix

The plasmaadmin['chat prefix'] function is used to get the chat prefix: 

plasmaadmin['chat prefix']()

This returns a string of the current chat prefix.

Getting cmdbar prefix

The plasmaadmin['cmdbar prefix'] function is used to get the cmdbar prefix: 

plasmaadmin['cmdbar prefix']()

This returns a Keycode Name string of the current cmdbar prefix, for example "Minus".

Getting if the user is premium

The plasmaadmin['premium'] function is used to get the players script status: 

plasmaadmin['premium']()

This returns true if the lp is premium, false if not.

Settings

What is the "Plasma.Settings" file?

The file "Plasma.Settings" holds the settings for Plasma, including:

GUI colors
Commands to autorun
FOV settings
Theme options
Plugin configurations
And more...

You can share these files among friends or with the server to share your settings with them.

How to change settings?

Manually

You can open the "Plasma.Settings" file with notepad or any text editor and manually change the settings from there.

Edit the Plasma.Settings file directly with your preferred text editor

Via Script

You can also edit the file via a script. After the loadstring, you can modify settings programmatically: 

plasmaadmin['settings']['setting'] = value
update_settings()

For example:

plasmaadmin['settings']['skip_loadscreen'] = true
update_settings()

Using settings in a plugin

If you are a plugin developer, you can store settings within Plasma Admin's settings file using the following functions:

update_settings function

The update_settings function saves the current settings to the "Plasma.Settings" file. 

-- After changing a setting
update_settings()

set_settings_table function

To add tables for RGB or any other settings, you can use: 

set_settings_table("table", values)

For example:

set_settings_table('cmdbar_color', 0, 0, 0)

This would set the cmdbar_color value to {0, 0, 0}

delitem_settings_table function

The delitem_settings_table function deletes a value from a table.

For example, if you have a setting called "test_table" that looks like this:

['test_table'] = {
    ['bleh'] = "value",
    ['blez'] = "value"
}

You could do:

delitem_settings_table('test_table', 'bleh')

And it would turn the table into this:

['test_table'] = {
    ['blez'] = "value"
}

get_settings_table function

The get_settings_table function can be used to get a Color3 or Vector3 from a table. 

get_settings_table('cmdbar_color', "color3") -- color3 could also be vector3

This would return Color3.fromRGB of the table cmdbar_color

Adding settings

Adding a setting manually

Open the "Plasma.Settings" file and add to it directly.

Via script 

plasmaadmin['settings']['setting'] = value
update_settings()

For example:

plasmaadmin['settings']['speed'] = 7546456453243436578
update_settings()

Community Guidelines

When sharing plugins or settings with the Plasma Admin community, please follow these guidelines:

  • Keep all plugins unobfuscated for safety and transparency
  • Provide clear documentation of what your plugin does
  • Credit other developers if you've built upon their work
  • Test your plugins thoroughly before sharing