Adding yourself to the bot

From StealthBot Wiki Backup
Revision as of 01:37, 12 September 2010 by Ribose (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The database manager is the new way to give access to members.

There are three tabs in the manager: Users and Groups, Clans, and Games

Giving a user access

File:Sbdocu3.png
This is "new_user_#1" being renamed to the user I want to give rank 30 (access) and flag S to.

Select "Create User" at the bottom. Rename "New_User" to the person you want to give access, exactly as the bot sees it (@Gateway if necessary).

On the right of the window, you see a few boxes. Rank (from 1 to 200) is the numeric access. "Access" now refers to both access and flags of the old system, whereas "rank" refers to the numeric form of access. The access system has been trimmed from 1 to 999 to 1 to 200. Next to it is the flags box. "Flags" give certain abilities (commands) to the user.

Using flags is sometimes considered more difficult to understand for inexperienced bot owners, but can be much more flexible.

Available flags

  • A - Administrator (of Database): Can use any database command. Give only to yourself and trusted users.
  • B - Banned: All users with the B flag will be "tagbanned" or "shitlisted". The separate shitlist is gone and the use of the shitlist commands are redirected to giving the user flag B. The separate tagban list is gone and the use of the tagban commands are redirected to giving the tag flag B.
  • D - Designated: Users with flag D will be automatically designated if the bot has ops.
  • I - No-Inherit: Prevents a user from receiving access from group or dynamic access.
  • J - Join: Gives access to channel-join-related commands.
  • M - Master: Master of the bot. Can use all commands.
  • O - Operator: Gives access to moderation (operator) commands.
  • P - Protected: "Locks" the user's access in the database. It cannot be modified by anyone with less than 100 access or the A flag (this flag was L before).
  • R - Restricted Database Administrator: Can use most database commands.
  • S - Safelisted: Safelisted by the bot. The separate safelist is gone and the use of the safelist commands are redirected to giving the user flag S.
  • T - Talk: Gives access to mimicking commands.

Info for what commands can be used by each flag can be accessed with the helpattr command.

If you gave the user the B flag, you can set a ban message to be set instead of the default ban message "Shitlisted".

After setting rank (access) and/or flags (you have to have at least one of them), select Save.

By command

To add users inside the bot, use the add command. Syntax: /add <user> [Access] [Flags] (either flags or access is required)

Example:

/add 7thAce 200 A

To use this command outside the bot, replace "/" with your bot's current trigger. The add command requires at least 20 access or either flag A or flag R. If you are trying to give a greater amount of access than you have yourself or a flag that you don't have yourself, the add command will fail (as it was in 2.6 R3).

To create a user inside a group, click on the group, then click create user. Remember: Hit save after changing each user or group.

Groups

File:SBDocu1.png
This image shows a user with no access as a part of a group with access. This user will be able to execute all commands.

Groups are ways to manage large amounts of users easily. To create a group, hit "Create Group" on the bottom. Name the group as you wish.

From there, you can give the group access and/or flags. All users assigned to this group will be gives this amount of access that group has. If a user individually has more access than the group, that user will not be overwritten. Flags from other groups can overlap. Example: if Tech-7thAce is in the group "Techs" (which you have set to 70 access with flag S) and is personally set to 200 with flags AOP, then 7thAce will have 200 access and flags AOPS.

To create a group from outside the bot, use the special "type" argument with add: type .add <groupname> [Access] [Flags] --type Group (access or flags is still required).

To add a user to a group with add, use the special "group" argument with add: type .add <user> --group <groupname> (note here that an access or flag requirement is provided by the group so is not required).

Clans and Games

File:SBdocu2.png
This image has a member as a part of two groups, and has flag O from being on "STAR" or StarCraft (not shown). The database manager cannot show one user in two groups, so you must set checks in the boxes to add the user to multiple groups (or use the add user to group command).

You can give access to entire WarCraft III clans in the same way you give access to groups. This is called "dynamic" access groups because each user is dynamically part of any of the groups depending on their clan tag or game. The same command is used, but instead of "--type group", use "--type Clan".

The username to use for the username of a dynamic clan group is the two-to-four-character clan abbreviation for the WarCraft III clan (for example SBs).

You can even set everyone on a certain client (game, or product, or whatever term you want to use) by making a dynamic game group. The username to use is the four-character product code or game code. You cannot use any other value or the full name of the game. A full list of game codes can be found here.

Example usages:

/add WAR3 50 S --type Game
/add SBs 70 S --type Clan

Note: The bot can only assign dynamic access to users when they are in the same channel as the bot. So if a clan member is in a different channel and whispers the bot for example, the bot will not recognize him/her having access. You would have to add him/her manually in this case.

Troubleshooting

Template:Faq