Skip to content

Latest commit

 

History

History
1095 lines (673 loc) · 16.5 KB

Owner.md

File metadata and controls

1095 lines (673 loc) · 16.5 KB

Module: Owner

This module contains owner-only commands.

Group: blockedchannels

Expand for additional information

Hidden.

Blocked channels control commands.

Privileged users only.

Aliases: bc, blockedc, blockchannel, bchannels, bchannel, bchn

Overload 3:

No arguments.

Overload 2:

  • [channel...]: Entities to block

Overload 1:

  • [string]: Reason for the action
  • [channel...]: Entities to block

Overload 0:

  • [channel]: Entities to block
  • [string...]: Reason for the action

Examples:

!blockedchannels
!blockedchannels #my-text-channel

blockedchannels add

Expand for additional information

Blocks channels from interacting with the bot.

Privileged users only.

Aliases: register, reg, a, +, +=, <<, <, <-, <=

Overload 2:

  • [channel...]: Entities to block

Overload 1:

  • [string]: Reason for the action
  • [channel...]: Entities to block

Overload 0:

  • [channel]: Entities to block
  • [string...]: Reason for the action

Examples:

!blockedchannels add #my-text-channel
!blockedchannels add #my-text-channel Because I can!

blockedchannels delete

Expand for additional information

Removes channels from bot block list.

Privileged users only.

Aliases: unregister, remove, rm, del, d, -, -=, >, >>, ->, =>

Overload 0:

  • [channel...]: Entities to unblock

Examples:

!blockedchannels delete #my-text-channel

blockedchannels list

Expand for additional information

Lists all blocked channels.

Privileged users only.

Aliases: print, show, view, ls, l, p

Overload 0:

No arguments.

Examples:

!blockedchannels list

Group: blockedguilds

Expand for additional information

Hidden.

Blocked guilds control commands.

Privileged users only.

Aliases: bg, blockedg, blockguild, bguilds, bguild, bgld

Overload 3:

No arguments.

Overload 2:

  • [guild...]: Entities to block

Overload 1:

  • [string]: Reason for the action
  • [guild...]: Entities to block

Overload 0:

  • [guild]: Entities to block
  • [string...]: Reason for the action

Examples:

!blockedguilds
!blockedguilds Some Guild

blockedguilds add

Expand for additional information

Blocks guilds from interacting with the bot.

Privileged users only.

Aliases: register, reg, a, +, +=, <<, <, <-, <=

Overload 2:

  • [guild...]: Entities to block

Overload 1:

  • [string]: Reason for the action
  • [guild...]: Entities to block

Overload 0:

  • [guild]: Entities to block
  • [string...]: Reason for the action

Examples:

!blockedguilds add Some Guild
!blockedguilds add Some Guild Because I can!

blockedguilds delete

Expand for additional information

Removes guilds from bot block list.

Privileged users only.

Aliases: unregister, remove, rm, del, d, -, -=, >, >>, ->, =>

Overload 0:

  • [guild...]: Entities to unblock

Examples:

!blockedguilds delete Some Guild

blockedguilds list

Expand for additional information

Lists all blocked guilds.

Privileged users only.

Aliases: print, show, view, ls, l, p

Overload 0:

No arguments.

Examples:

!blockedguilds list

Group: blockedusers

Expand for additional information

Hidden.

Blocked users control commands.

Privileged users only.

Aliases: bu, blockedu, blockuser, busers, buser, busr

Overload 3:

No arguments.

Overload 2:

  • [user...]: Entities to block

Overload 1:

  • [string]: Reason for the action
  • [user...]: Entities to block

Overload 0:

  • [user]: Entities to block
  • [string...]: Reason for the action

Examples:

!blockedusers
!blockedusers @User

blockedusers add

Expand for additional information

Blocks users from interacting with the bot.

Privileged users only.

Aliases: register, reg, a, +, +=, <<, <, <-, <=

Overload 2:

  • [user...]: Entities to block

Overload 1:

  • [string]: Reason for the action
  • [user...]: Entities to block

Overload 0:

  • [user]: Entities to block
  • [string...]: Reason for the action

Examples:

!blockedusers add @User
!blockedusers add @User Because I can!

blockedusers delete

Expand for additional information

Removes users from bot block list.

Privileged users only.

Aliases: unregister, remove, rm, del, d, -, -=, >, >>, ->, =>

Overload 0:

  • [user...]: Entities to unblock

Examples:

!blockedusers delete @User

blockedusers list

Expand for additional information

Lists all blocked users.

Privileged users only.

Aliases: print, show, view, ls, l, p

Overload 0:

No arguments.

Examples:

!blockedusers list

Group: commands

Expand for additional information

Hidden.

Bot command manipulation during runtime.

Owner-only.

Aliases: cmds, cmd

Overload 0:

No arguments.

Examples:

!commands

commands add

Expand for additional information

Add a new bot command.

Owner-only.

Aliases: register, reg, new, a, +, +=, <<, <, <-, <=

Overload 0:

  • [string...]: C# code snippet in a markdown code block

Examples:

!commands add ```cs
[Command("test")]
public Task Test(CommandContext ctx) => ctx.RespondAsync("Hello");
</p></details>

---

### commands delete
<details><summary markdown='span'>Expand for additional information</summary><p>

*Deletes existing bot command.*

**Owner-only.**


**Aliases:**
`unregister, remove, rm, del, d, -, -=, >, >>, ->, =>`

**Overload 0:**
- \[`string...`\]: *Command name*

**Examples:**

```xml
!commands delete sample command

commands list

Expand for additional information

Lists all bot commands.

Owner-only.

Aliases: print, show, view, ls, l, p

Overload 0:

No arguments.

Examples:

!commands list

Group: owner

Expand for additional information

Hidden.

Commands restricted to bot owner(s).

Aliases: admin, o

owner announce

Expand for additional information

Send a message to all guilds the bot is in.

Owner-only.

Aliases: ann

Overload 0:

  • [string...]: Announcement message

Examples:

!owner announce Some important announcement!

owner avatar

Expand for additional information

Sets the bot avatar.

Owner-only.

Aliases: setavatar, setbotavatar, profilepic, a

Overload 0:

  • [URL]: Image URL

Examples:

!owner avatar http://some-image-url.com/image.png

owner dbquery

Expand for additional information

Queries the bot database using given SQL query or uploaded SQL file.

Owner-only.

Aliases: sql, dbq, q, query

Overload 1:

No arguments.

Overload 0:

  • [string...]: SQL query

Examples:

!owner dbquery SELECT * FROM gf.<DATABASE_NAME>

owner eval

Expand for additional information

Evaluates a snippet of C# code, in context.

Owner-only.

Aliases: evaluate, compile, run, e, c, r, exec

Overload 0:

  • [string...]: C# code snippet in a markdown code block

Examples:

!owner eval ```cs
[Command("test")]
public Task Test(CommandContext ctx) => ctx.RespondAsync("Hello");
</p></details>

---

### owner generatecommandlist
<details><summary markdown='span'>Expand for additional information</summary><p>

*Generates bot documentation in markdown ready for GitHub.*

**Owner-only.**


**Aliases:**
`gendocs, generatecommandslist, docs, cmdlist, gencmdlist, gencmds, gencmdslist`

**Overload 0:**
- (optional) \[`string...`\]: *Output folder* (def: `None`)

**Examples:**

```xml
!owner generatecommandlist

owner leaveguilds

Expand for additional information

Generates bot documentation in markdown ready for GitHub.

Owner-only.

Aliases: leave, gtfo

Overload 1:

  • [guild...]: Guild names or IDs

Overload 0:

  • [unsigned long...]: Guild names or IDs

Examples:

!owner leaveguilds Some Guild
!owner leaveguilds 361119455792594954

owner log

Expand for additional information

Logs a given remark or uploads bot log file if remark is not given.

Owner-only.

Aliases: getlog, remark, rem

Overload 1:

  • (optional) [boolean]: Bypass current bot configuration? (def: False)

Overload 0:

  • [LogEventLevel]: Log event level
  • [string...]: Log message

Examples:

!owner log
!owner log Information
!owner log Some string here

owner name

Expand for additional information

Sets the bot name.

Owner-only.

Aliases: botname, setbotname, setname

Overload 0:

  • [string...]: New name

Examples:

!owner name SampleName

owner restart

Expand for additional information

Restarts the bot.

Privileged users only.

Aliases: reboot

Overload 0:

No arguments.

Examples:

!owner restart

owner sendmessage

Expand for additional information

Sends a message to user or channel.

Privileged users only.

Aliases: send, s

Overload 0:

  • [string]: u (User) or c (Channel)
  • [unsigned long]: ID
  • [string...]: Message to send

Examples:

!owner sendmessage u
!owner sendmessage 361119455792594954
!owner sendmessage Sample message

owner shutdown

Expand for additional information

Powers off the bot.

Privileged users only.

Aliases: disable, poweroff, exit, quit

Overload 1:

  • [time span]: Time until shutdown
  • (optional) [int]: Process exit code (def: 0)

Overload 0:

  • (optional) [int]: Process exit code (def: 0)

Examples:

!owner shutdown
!owner shutdown 10s 5
!owner shutdown 10s

owner sudo

Expand for additional information

Executes command as another user.

Guild only.

Privileged users only.

Aliases: execas, as

Overload 0:

  • [member]: Member
  • [string...]: Full command call with arguments

Examples:

!owner sudo Member
!owner sudo sample command

owner toggleignore

Expand for additional information

Toggle bot listening status.

Privileged users only.

Aliases: ti

Overload 0:

No arguments.

Examples:

!owner toggleignore

owner update

Expand for additional information

Restarts and updates the bot.

Owner-only.

Overload 0:

No arguments.

Examples:

!owner update

owner uptime

Expand for additional information

Prints bot uptime information.

Privileged users only.

Overload 0:

No arguments.

Examples:

!owner uptime

Group: privilegedusers

Expand for additional information

Hidden.

Commands to manage privileged users. Privileged users have permissions to execute some sensitive bot commands.

Owner-only.

Aliases: pu, privu, privuser, pusers, puser, pusr

Overload 1:

No arguments.

Overload 0:

  • [user...]: User(s)

Examples:

!privilegedusers

privilegedusers add

Expand for additional information

Adds given user(s) to privileged users list.

Owner-only.

Aliases: register, reg, new, a, +, +=, <<, <, <-, <=

Overload 0:

  • [user...]: User(s)

Examples:

!privilegedusers add @User

privilegedusers delete

Expand for additional information

Removes given user(s) from privileged users list.

Owner-only.

Aliases: unregister, remove, rm, del, d, -, -=, >, >>, ->, =>

Overload 0:

  • [user...]: User(s)

Examples:

!privilegedusers delete @User

privilegedusers list

Expand for additional information

Lists all privileged users.

Owner-only.

Aliases: print, show, view, ls, l, p

Overload 0:

No arguments.

Examples:

!privilegedusers list

Group: status

Expand for additional information

Hidden.

Manipulates bot statuses. Group call either lists all statuses or adds a new status.

Owner-only.

Aliases: statuses, botstatus, activity, activities

Overload 1:

No arguments.

Overload 0:

  • [ActivityType]: Activity type (Playing/Watching/Streaming/ListeningTo)
  • [string...]: Bot status

Examples:

!status
!status Playing Some Game

status add

Expand for additional information

Adds a new status to the status list.

Owner-only.

Aliases: register, reg, new, a, +, +=, <<, <, <-, <=

Overload 0:

  • [ActivityType]: Activity type (Playing/Watching/Streaming/ListeningTo)
  • [string...]: Bot status

Examples:

!status add Playing Some Game

status delete

Expand for additional information

Removes a status from the status list.

Owner-only.

Aliases: unregister, remove, rm, del, d, -, -=, >, >>, ->, =>

Overload 0:

  • [int...]: Bot status ID

Examples:

!status delete 5

status list

Expand for additional information

Lists all currently registered statuses.

Owner-only.

Aliases: print, show, view, ls, l, p

Overload 0:

No arguments.

Examples:

!status list

status set

Expand for additional information

Disables automatic rotation of bot statuses and sets the currents status by ID or explicit string until status rotation is enabled again.

Owner-only.

Aliases: s

Overload 1:

  • [ActivityType]: Activity type (Playing/Watching/Streaming/ListeningTo)
  • [string...]: Bot status

Overload 0:

  • [int]: Bot status ID

Examples:

!status set 5
!status set Playing Some Game

status setrotation

Expand for additional information

Enables or disables automatic rotation of bot statuses.

Owner-only.

Aliases: sr, setr, rotate

Overload 0:

  • (optional) [boolean]: Enable? (def: True)

Examples:

!status setrotation Yes/No