Skip to content

Configuration

Jump to bottom
Brian edited this page Sep 5, 2019 · 4 revisions

Configuration

Introduction

When you first load up the plugin without any configuration, SteamInviteHelper will add its default config options under every ASF bot's config file.

After editing the config, ASF needs to be restarted to reload the config.

Default Config

Default config is appended to every bot's config file. You can modify them to fit your needs. The default config have the following structure:

"SteamInviteHelper":{  
   "ActionPriority":[  
      "block",
      "ignore",
      "add",
      "none"
   ],
   "PrivateProfile":{  
      "action":"block"
   },
   "SteamRepScammer":{  
      "action":"block"
   },
   "SteamLevel":[  
      {  
         "condition":"default",
         "value":-1,
         "action":"none"
      },
      {  
         "condition":"less_than",
         "value":1,
         "action":"block"
      },
      {  
         "condition":"less_than",
         "value":5,
         "action":"ignore"
      }
   ],
   "VACBanned":[  
      {  
         "condition":"default",
         "value":-1,
         "action":"none"
      },
      {  
         "condition":"more_than",
         "value":1,
         "action":"ignore"
      }
   ],
   "GameBanned":[  
      {  
         "condition":"default",
         "value":-1,
         "action":"none"
      },
      {  
         "condition":"more_than",
         "value":1,
         "action":"ignore"
      }
   ],
   "DaysSinceLastBan":[  
      {  
         "condition":"default",
         "value":-1,
         "action":"none"
      },
      {  
         "condition":"less_than",
         "value":90,
         "action":"ignore"
      }
   ],
   "CommunityBanned":{  
      "action":"none"
   },
   "EconomyBanned":{  
      "action":"none"
   },
   "ProfileName":[  
      {  
         "condition":"default",
         "value":"",
         "action":"none"
      },
      {  
         "condition":"contain",
         "value":"shittygamblingsite.com",
         "action":"ignore"
      }
   ]
}

All options are explained below.

Universal options

These are options that are used by other options.

action

action defines what SteamInviteHelper should do when a rule is matched. It can be one of the followings:

  • block: Decline the invite and block all communication with the user.
  • ignore: Ignore the invite.
  • add: Accept the invite and add the user as friend.
  • none: Do nothing. This will leave the invite unhandled.

condition

condition defines how SIH compares the user's data with the define value. It can be one of the followings:

  • default: Defines the default condition when no other conditions are matched.
  • less_than: Defines the condition when the user's value is less than the config value.
  • more_than: Defines the condition when the user's value is more than the config value.
  • equal: Defines the condition when the user's value is equal to the config value.
  • contains: Defines the condition when the user's value contains config value. Only works with ProfileName option.

value

value defines what SIH compares the user's data to. For example, under the SteamLevel options, SIH will compare the config value with the user's steam level.

Rules options

ActionPriority

This option contains a list that defines the action's priority. When multiple rules matched and produced different actions, SteamInviteHelper will execute the action that have the priority.

Example with default config: The incoming invite matches the rule SteamRepScammer which returns the action block. It also matches with the rule CommunityBanned which returns the action none. Since block have the priority over none, SteamInviteHelper will execute the action block.

PrivateProfile

This option defines the action when the user's steam profile is private

SteamRepScammer

This option defines the action when the user is marked as Scammer on Steamrep.com

SteamLevel

This option contains a list that defines the actions when the user's steam level matches with the conditions.

VACBanned

This option contains a list that defines the action when user's numbers of VAC Banned games matches with the conditions. less_than options ignores 0 (No VAC Banned games)

GameBanned

This option contains a list that defines the action when user's numbers of Game Banned games matches with the conditions. less_than options ignores 0 (No Game Banned games)

DaysSinceLastBan

This options contains a list that defines the action when user's days since last banned matches with the conditions. less_than options ignores 0 (No ban history)

CommunityBanned

This option defines the action when the user is community banned

EconomyBanned

This option defines the action when the user is economy banned

ProfileName

This option contains a list that defines the action when the user's profile name matches with the conditions.

Clone this wiki locally