Astrea Toolbox - Server Essentials: Prop Protection, Physgun Enhancement + More

Astrea is a toolbox of utilities and features that are essential to a gmod server. From Physgun Enhancements to Prop Protection, Lightsaber Control to Chat Utilities and Branding, it has everything.

Backed with a powerful permission system, you really have full control over who does what.

Hey, how do I do this?

Things you should know

Chat Commands

• /astrea or !astrea
• /toolgunsettings or !toolgunsettings

Console Commands

• astrea
• toolgun_permissions
• buddies_menu
• player_management
• astrea_assign_role steamid role

Does Astrea replace darkrp!!?!??

Frequently Asked Questions

Does Astrea replace FPP

• Yes, Astrea is made to replace FPP. I wouldn't use both at the same time.

Does Astrea support CPPI

• Of course it does. Who'd be foolish enough to not follow standards!

How do I disable FPP

• Go into your server addons folder, find darkrpmodifications/lua/darkrp_config/disabled_defaults.lua then set fpp to true.

Does Astrea replace [insert admin mod here]

• No! Astrea is not an admin mod. Run it along side an existing admin mod, like ULX or SAM!

How do I assign a role to everybody

• Give a role to everyone by using a * in the roles usergroups, this will automatically assign it to every usergroup.

Does Astrea protect me against [insert minge exploit here]

• Who knows! There are so many exploits and ways to minge around on servers that it's impossible to catch everything. If you are having certain issues, drop a support ticket and I'll look into it! The more ways to minge I can patch the better!

Third Party Addon - Made By Owain

Astrea Protect

What is it?

Astrea Protect is a module for Astrea that attempts to provide some basic but essential exploit protection for your server. Utilizing Astrea's easy to use in-game config, you will be able to fine tune your settings easily on the fly. No need to dig through configs and restart your server after you catch someone exploiting.

What does it include?

• Net Message rate limiting.
• Net Message logging.
• [To Do] Known exploit patching.
• [To Do] Anti-family share.
• [To Do] Honey pots.
• [To Do] HTTP Logging.

a few screenshots:

HTTP Logging

Net Message Limiting/Logging

Infinite Scroll so we don't strain your server with one big net message!

Download:

https://github.com/owainjones74/astrea-protect

Third Party Addon - Made By Me

bDumpsters

What is it?

bDumpsters is a simple yet nicely designed dumpster script that gives hobo's a lil something to do other than minge around and make houses.

What does it include?

• Four tiers of loot!
• Chance to get money, or an entity.
• Cool prop throwing sequence.

a few screenshots:

Overall Config

Customisable Loot Tables

Quick Showcase Video

(Note: whilst I do support the creation of these third party modules, I am not responsible for any errors/fixes they may need, leave an issue on the github page if you find an issue!)

Use my in-game config!

Dev Stuff

You can use Astrea to provide in-game config for your addons!

It's a little finicky here and there, definitely not perfect. But, it beats making your own in-game config!

Here's a quick dumpster addon I made as an example, you'll find all the Astrea stuff in sh_bdumpsters_astrea.lua and sh_bdumpsters_load.lua

I'll give you a more indepth look into the file here:

Hooks Used

AstreaToolboxInitialModule(module)

• This runs on our first ever time loading the module. The argument is the module name. (Same name used in enablemodule on line 11)

AstreaToolboxLoadModules()

• This runs just before we load any modules, making it the perfect place to setup and load ours.

Functions Used

AstreaToolbox.Core.EnableModule(str module, bool enabled)

• Pretty self explanatory, this initiates our module.
• The first arg is the module name.
• The second arg is whether or not it should be enabled or not.

AstreaToolbox.derma.downloadImage(str ImgurID, str subfile, func callback, func err, bool proxy) 

• This is the function that downloads images to be used in astrea.
• The first arg is the Imgur ID of the image.
• The second arg is the file in which the image will be stored. If part of the addon, use 'main'.
• The third arg is the callback when the image is downloaded and has the new filename as it's argument.
• The fourth arg is the callback when an error arises.
• The fifth arg isn't for use, it's used internally when reverting to using a proxy as a base case to stop infinite recursion.

AstreaToolbox.Core.AddToList(str list, str item)

• This function is used to add an item to an astrea list.
• The first arg is the list name, specified in the subsetting.
• The second arg is the item being added.

AstreaToolbox.Core.GetSetting(str settingName)

• This function is used to get the value of a setting
• The first arg is the setting name.
• The addon is using this function in another file, to make it's own GetSetting function.

Example (bDumpsters using Astrea GetSetting to make it's own function that can revert to original config if needed.)


-- bDumpsters Get Config Command, this allows us to have astrea integration.

-- We need to make sure our setting names are the same in astrea and our local config.
-- Basically we're checking 'if Astrea exists, and "Overwrite Config" is turned on, use AstreaToolbox.Core.GetSetting(), else just check our config table'

function bDumpsters.GetSetting(setting)
	return (AstreaToolbox and AstreaToolbox.Core.GetSetting("dumpster_settings")) and AstreaToolbox.Core.GetSetting(setting) or bDumpsters.Config[setting]
end


function bDumpsters.GetLootSetting(setting)
	return (AstreaToolbox and AstreaToolbox.Core.GetSetting("dumpster_loot")) and AstreaToolbox.Core.GetSetting(setting) or bDumpsters.Config[setting] 
end


AstreaToolbox.Core.AddSetting(str setting, str group, table type, bool default, str displayName, str displayDesc)

• This function is used to create an astrea setting (the settings in the middle panel on the main Astrea menu)
• The first arg is the setting name, this will be used in Astrea to refer to the setting, as well as when creating sub settings.
• The second arg is the group, as in the name of the module it's part of. (So in our example, "dumpsters")
• The third arg is the type. The type is a table with different information. For AddSetting the default is {["type"] = "bool", ["clientside"] = false}. More information about this below.
• The fourth arguement is whether or not this setting is on by default.
• The fifth arg is the settings display name in the Astrea menu.
• The sixth arg is the settings display description in the Astrea menu.
• Here's an example from bDumpsters.

	AstreaToolbox.Core.AddSetting("dumpster_settings",


	-- The module name.
	"dumpster",
	
	-- The type.
	{
	 	["type"] = "bool",
		["clientside"] = false
	},
	
	-- Default?
	false,


	-- Display Name and Description
	"Override Dumpster Settings", "Configure the dumpsters settings to your liking.")

AstreaToolbox.Core.AddSubSetting(parentsetting, setting, group, type, default, displayName, displayDesc)

• This is the function used to create a subsetting for a main setting. (The settings in the panel that appears on the right when you click on a main setting)
• The first arg is the name of the parent setting.
• The second arg is the unique setting name
• The third arg is the module the subsetting belongs too, (so again, in our example "dumpsters")
• The fourth arg is the type. With this being a subsetting there are many more types, more info below.
• The fifth arg is the default value of the setting. (For list settings, just put an empty table {})
• The sixth arg is the display name in the Astrea menu.
• The seventh arg is the display description in the Astrea Menu
• Here's an example from bDumpsters.

	-- This is a subsetting for the 'dumpster_settings' main setting.
	AstreaToolbox.Core.AddSubSetting("dumpster_settings", 


	-- This is the name of the subsetting. 
	"dumpster_jobs",


	-- This is the name of the module. 
	"dumpster",


	-- This is the subsettings type. Since this subsetting is a 'List', it also has a subtype (What the list contains)
	{
		["type"] = "list",
		["clientside"] = false,
		
		-- In this case, it's pretty straight forward, this is a toggle list of jobs.
		{
			["type"] = "job"
		}
	},


	-- The subsetting is a list, set the default to {}
	{},


	-- The name and description.
	"Job Table","What jobs can open dumpsters?")

Types

Different types have different attributes. Not the nicest way of doing things i'll admit, but it allowed for a lot of growth when adding new things.

Here are the different possible types and their settings.

bool

• clientside

Example (boolean, not shared with client)

{
  ["type"] = "bool", 
  ["clientside"] = false
}

number

• clientside
• min (min value)
• max (max value)
• decimal (should we add decimals to the mix?)

Example (Whole Number between 0 and 500)

{
  ["type"]="number",
  ["min"]=0,
  ["max"]=500,
  ["decimal"] = false
}
  

string

• clientside
• min (length of string)
• max (length of string)
• printname (Name of placeholder in text box)
• case ("lower" or "upper")
• numeric
• percentage (requires numeric)

Example (Lowercase string between 0 and 128 characters, placeholder 'Prop')

{
  ["type"] = "string", 
  ["min"]=0, 
  ["max"]=128,
  ["printname"] = "Prop",
  ["case"] = "lower"
}

List

• string (setting attributes too)
• player (List of players, both online and offline)
• job (List of jobs)

Example (List of lowercase strings between 0 and 128 characters, placeholder 'Prop')

{
  ["type"] = "list", 
  ["clientside"] = false, 
  
  {
    ["type"] = "string", 
    ["min"]=0, 
    ["max"]=128, 
    ["printname"] = "Prop", 
    ["case"] = "lower"  
  }  
}  
  

Example (List of jobs)

{
	["type"] = "list",
	["clientside"] = false,
		
	{
		["type"] = "job"
	}
}