Sign upLogin

NabDev/NabBot

View on GitHub
Star
docs/commands/timers.md

Summary

Maintainability
Test Coverage
# Timers commands

----
## boss
**Syntax:** `boss <name>` 

Shows the remaining cooldown time for a specific boss.

??? Summary "Examples"
    **/boss lloyd**  
    ![image](../assets/images/commands/timers/boss.png)

----

### boss bosslist
Shows a list of supported boss cooldowns.

??? Summary "Examples"
    **/boss bosslist**  
    ![image](../assets/images/commands/timers/boss_bosslist.png)

----

### boss list
Shows a list of all your active cooldowns.

For privacy reasons, only characters matching the tracked world of the current server will be shown.
To see all your characters, try it on a private message.

??? Summary "Examples"
    **/boss list**  
    ![image](../assets/images/commands/timers/boss_list.png)

----

### boss set
**Syntax:** `boss set <boss>,<character>[,time_ago]`

Sets the cooldown for a boss.

The cooldown is set as if you had just killed the boss.  
You will receive a private message when the cooldown is over.

You can also specify how long ago the boss was killed, so the time is considered in the cooldown.

??? Summary "Examples"
    **/boss set kroazur,galarzaa fidera**  
    ![image](../assets/images/commands/timers/boss_set.png)  
    *When the cooldown is over*  
    ![image](../assets/images/commands/timers/boss_timer.png)

----

### boss remove
**Syntax:** `boss remove <boss>,<character>`  
**Other aliases:** `boss clear`, `boss unset`

Removes an active boss cooldown.

----

## events
**Other aliases:** `event` 

Shows a list of upcoming and recent events.

??? Summary "Examples"
    **/event**  
    ![image](../assets/images/commands/timers/event.png)

----
   
### events add
**Syntax:** `events add <starts in> <name>[,description]`

Creates a new event.

`starts in` is in how much time the event will start from the moment of creation.
This is done to avoid dealing with different timezones.
Just say in how many days/hours/minutes the event is starting.

The time can be set using units such as 'd' for days, 'h' for hours, 'm' for minutes and 'd' for seconds.
Examples: 1d20h5m, 1d30m, 1h40m, 40m

The event description is optional, you can also use links like: `[link title](link url)`.

Once the event is created, the id of the event will be returned. This is used for further edits.

??? Summary "Example"
    **/event add 5h Inquisition Quest,Remember to bring holy water!**  
    **`[TibiaWiki link](http://tibia.fandom.com/wiki/Inquisition_quest)`**  
    ![image](../assets/images/commands/timers/event_add.png)

----

### event addplayer
**Syntax:** `event addplayer <id> <character>`  
**Other aliases:** `event addchar`

Adds a character to an event.

Only the creator can add characters to an event.
If the event is joinable, anyone can join an event using `event join`

??? Summary "Examples"
    **/event addplayer 136 Nezune**  
    ![image](../assets/images/commands/timers/event_addchar.png)

----

### event edit

Use the subcommands to edit the event's properties.
Only the creator of the event and mods can edit an event.
Past events can't be edited.

----

#### event edit description
**Syntax:** `event edit description <id> [new description]`  
**Other aliases:** `event edit desc`, `event edit details`

Edits an event's description.
        
If no new description is provided initially, the bot will ask for one.  
To remove the description, say `blank`.

----

#### event edit joinable 
**Syntax:** `event edit joinable <id> [yes/no]`  
**Other aliases:** `event edit open`

Changes whether anyone can join an event or only the owner may add people.

If an event is joinable, anyone can join using `event join`  .
Otherwise, the event creator has to add people with `event addplayer`.

----

#### event edit name
**Syntax:** `event edit name <id> [new name]`  
**Other aliases:** `event edit title`

Edit's an event's name.

If no new name is provided initially, the bot will ask for one.

----

#### event edit slots
**Syntax:** `event edit slots <id> [new slots]`  
**Other aliases:** `event edit size`

Edits an event's number of slots

Slots is the number of characters an event can have. By default this is 0, which means no limit.

----

#### event edit time
**Syntax:** `event edit time <id> [new start time]`

Edit's an event's start time.

If no new time is provided initially, the bot will ask for one.

----

### events info
**Syntax:** `events info <id>`

Displays an event's info.

The start time shown in the footer is always displayed in your device's timezone.
  
??? Summary "Examples"
    **/event info 136**  
    ![image](../assets/images/commands/timers/event_info.png)

----
    
### event join
**Syntax:** `event join <id> <char>`

Join an event with a specific character

You can only join an event with a character at a time.  
Some events may not be joinable and require the creator to add characters themselves.

??? Summary "Examples"
    **/event join 136 Galarzaa Fidera**  
    ![image](../assets/images/commands/timers/event_join.png)

----
    
### event leave
**Syntax:** `event leave <id>`

Leave an event you were participating in.

??? Summary "Examples"
    **/event leave 136**  
    ![image](../assets/images/commands/timers/event_leave.png)

----

### event make

Creates an event guiding you step by step

Instead of using confusing parameters, commas and spaces, this commands has the bot ask you step by step.

----

### event participants
**Syntax:** `event participants <id>`

Shows the list of characters participating in this event.

??? Summary "Examples"
    **/event participants 190**  
    ![image](../assets/images/commands/timers/event_participants.png)

----

### event remove
**Syntax:** `event <id>`  
**Other aliases:** `event delete`, `event cancel`

Deletes or cancels an event.

??? Summary "Examples"
    **/event delete 136**  
    ![image](../assets/images/commands/timers/event_remove.png)

----

### event removeplayer
**Syntax:** `event removeplayer <id> <character>`  
**Other aliases:** `event removechar`

Removes a player from an event.

Players can remove themselves using `event leave`

??? Summary "Examples"
    **/event addplayer 136 Nezune**  
    ![image](../assets/images/commands/timers/event_removechar.png)

----

### event subscribe
**Syntax:** `event subscribe <id>`  
**Other aliases:** `event sub`

Subscribe to receive a PM when an event is happening.

??? Summary "Examples"
    **/event sub 136**  
    ![image](../assets/images/commands/timers/event_sub.png)

----

### event unsubscribe
**Syntax:** `event unsubscribe id`  
**Other aliases:** `event unsub`

Unsubscribes you from an event.

??? Summary "Examples"
    **/event unsub 136**  
    ![image](../assets/images/commands/timers/event_unsub.png)

----
    
## remindme
**Syntax:** `remindme <when> <what>`

Creates a personal reminder.

You will be notified in the same channel when the time is over.

??? Summary "Examples"
    **/event remindme 2h check old fortress**  
    ![image](../assets/images/commands/timers/remindme.png)  
    *Once the time has passed*  
    ![image](../assets/images/commands/timers/remindme_response.png)