ET:Setting up Shrubbot (Jaymod)/en

From sl.Wiki

NOTE: This article is part of our Enemy Territory section.

Contents 1 Initial Setup 2 Syntax 2.1 [level]-Keys 2.2 [admin]-Keys 3 Sample Config 4 Flags 4.1 Flags by command 4.2 Flags by Letter 4.3 Special Digit Flags

Initial Setup

If you don't have an existing shrubbot config file, all you need to do to get started is fire up the game with the g_shrubbot Cvar set to your desired shrubbot config file (for simplicity, this manual will refer to this file as shrubbot.cfg). Since the file will not exist, the game will automatically create the file with 2 admin levels assigned: 0 and 1. Level 0 will have basic commands, such as !about, !time, etc., and level 1 users will have access to every command. This should get you started so that you can manually edit this file and add on to meet your needs.

Syntax

The way the file is written resembles a Windows .ini configuration file. The shrubbot config file is structured into different sections. The resp. section header is set in square brackets, the settings follow below in the form "key=value". There are 2 possible section types: [level] and [admin]. Each section type can occur more than once.

[level]-Keys

Key	Value	Description
level	A number.	Specifies what level number it is, usually the higher the more rights theuser with this level has.
name	A text snippet including game color codes.	The name of the level, e.g. it shows when !admintest is used.
flags	A list of valid shrubbot flags.	Defines what privileges this level has. See the flags section for information on what flags there are. Note: You can use * to grant all permissions. Also, * followed by flags means that level has all permissions except for the ones specified.
greeting	A text snippet including game color codes.	A greeting text that is displayed when a player of this level enters. You can use [player] and [level] as place holders: [player] gets replaced with the player name. [level] gets replaced with the level name.

[admin]-Keys

Key	Value	Description
name	A text snippet including game color codes.	The name of the player.
guid	A valid GUID.	The GUID of the player.
level	A number.	What level is assigned to the player (one of the levels defined in a [level] section).
flags	A list of valid shrubbot flags.	Modifications to default privileges. For example, if you wanted to add a flag to a user beyond what his level was, you would add +flag. To take away a privilege, use -flag. |-
greeting	A text snippet including game color codes.	A greeting text that is displayed when a player of this level enters. You can use [player] and [level] as place holders: [player] gets replaced with the player name. [level] gets replaced with the level name.

Sample Config

[level]
level = 0
name = ^xR^fegular ^xU^fser
flags = iahCp
greeting =

[level]
level = 2
name = ^xS^erver ^xA^dmin
flags = *kb
greeting =

[admin]
name = ^xJay^4bird
guid = 12345PLAYERGUID12345
level = 1
flags =
greeting =

[admin]
name = ^xJay^4bird the 2nd
guid = 54321PLAYERGUID54321
level = 2
flags = +k-C
greeting = Stand up! [player] (a [level]) has entered!

Line	Config	Comment
1	[level]	Tells the game that the following information sets up a level.
2	level = 0	This section defines the rights for players with level 0.
3	name = ^xR^fegular ^xU^fser	This level has the name "Regular User".
4	flags = iahCp	User with this level can use the following commands: i⇒!listplayers, a⇒!admintest, h⇒!help, C⇒!time and p⇒!putteam.
5	greeting =	No greeting text.
6
7	[level]	Tells the game that the following information sets up a level.
8	level = 2	This section defines the rights for players with level 2.
9	name = ^xS^erver ^xA^dmin	This level has the name "Server Admin".
10	flags = *kb	User with this level can use all commands, but can't use !kick (k) or !ban resp. !unban (b).
11	greeting =	No greeting text.
12
13	[admin]	Tells the game that the following information sets up an admin.
14	name = ^xJay^4bird	Name of the player.
15	guid = 12345PLAYERGUID12345	The GUID of the player.
16	level = 1	What level is assigned to the player.
17	flags =	No additional flags for this admin.
18	greeting =	No special greeting text.
19
20	[admin]	Tells the game that the following information sets up an admin.
21	name = ^xJay^4bird the 2nd	Name of the player.
22	guid = 54321PLAYERGUID54321	The GUID of the player.
23	level = 2	The player has level 2 rights.
24	flags = +k-C	The player has the rights of level 2 and additionally the right to use the !kick command (+k). But he isn't allowed to use the !time command (-C).
25	greeting = Stand up! [player] (a [level]) has entered!	Will output something like: "Stand up! Jaybird the 2nd (a Server Admin) has entered!"

Flags

Flags by command

Command	Flag	Command	Flag
!about	A	!putteam	p (lower P)
!admintest	a	!readconfig	G
!ban	b	!rename	N
!baninfo	B	!reset	r
!cancelvote	c (lower C)	!resetmyxp	X (upper)
!crazygravity	M	!resetxp	R
!crybaby	y	!restart	r
!disorient	d	!revive	v (lower V)
!finger	I (capital i)	!seen	E
!fling	l (lower L)	!setlevel	s (lower S)
!flinga	L	!shake	H
!ftime	g	!showbans	B
!glow	z (lower Z)	!shuffle	S (captial s)
!help	h	!slap	l (lower L)
!kick	k (lower K)	!smite	U (capital u)
!launch	l (lower L)	!sniperwar	M
!launcha	L	!spec	e
!listplayers	i	!spec999	P (capital p)
!lock	K (capital k)	!splat	l (lower L)
!lol	x (lower X)	!splata	L
!mute	m	!swap	w (lower W)
!news	W (captial w)	!throw	l (lower L)
!nextmap	n	!throwa	L
!orient	d	!time	C (captial C)
!pants	z (lower Z)	!unban	b
!panzerwar	M	!unlock	K (capital k)
!pause	Z (captial z)	!unmute	m
!pip	z (lower Z)	!unpause	Z (captial z)
!pop	z (lower Z)	!uptime	U (captial u)

Flags by Letter

Flag	Commands	Flag	Commands
A	!about	a	!admintest
b	!ban, !unban	B	!baninfo, !showbans
c	!cancelvote	C	!time
d	!disorient, !orient	D
e	!spec	E	!seen
f		F
g	!ftime	G	!readconfig
h	!help	H	!shake
i	!listplayers	I	!finger
j		J
k	!kick	K	!lock, !unlock
l	!fling, !launch, !slap, !splat, !throw	L	!flinga, !launcha, !splata, !throwa
m	!mute, !unmute	M	!crazygravity, !sniperwar
n	!nextmap	N	!rename
o		O
p	!putteam	P	!spec999
q		Q
r	!reset, !restart	R	!resetxp
s	!setlevel	S	!shuffle
t		T
u		U	!smite, !uptime
v	!revive	V
w	!swap	W	!news
x	!lol	X	!resetmyxp
y	!crybaby	Y
z	!glow, !pants, !pip, !pop	Z	!pause, !unpause

Special Digit Flags

Digit flags give admins additional abilities.

Flag	Ability
1	Cannot be vote kicked, vote muted, dropped for inactivity or complained against.
2	Cannot be censored or flood protected.
3	Can run commands silently from console (/!command).
4	Can see all team, fireteam, and PM chat as spectator.
5	Can switch to any team regardless of balance.
6	Does not need to specify a reason for kick/ban.
7	Can call a vote anytime (even if disabled).
8	Does not need to specify the duration of a ban (i.e. can issue a permanent ban).
9	Can run commands from team or fireteam chat.