Skip to main content

Scheduling Writing Sessions

Your WriterStats Instance allows you to schedule sessions for some time in the future! These sessions can be non-recurring or recurring on a daily or weekly basis, and can be created by any WriterStats server moderator. Read on to learn how to schedule both group sessions and chain sessions for times in the future!

warning

Make sure not to schedule sessions at overlapping times, as only the first one will be able to start. You can have a maximum of 10 scheduled sessions per channel and 25 in your instance overall.

Scheduling Group Sessions​

A group session can be scheduled using the /schedule group command! There are several options to fill out, and not choosing any will result in the default values for the bot being used.

The various options for the command are shown below:

  • schedule_name: The name of the schedule you wish to create. Must be less than 20 characters.
  • session_length: Optional. How long you want the scheduled session to be, in minutes. Defaults to 15 minutes. If you want more detailed control, you can use the hours/minutes/seconds format. All 3 fields must be provided.
  • random_length: Optional. Let WriterStats pick a random length for your scheduled session, based on your criteria!
  • start_delay: Optional. How long before the scheduled session starts, in minutes. Defaults to 1 minute. Must be less than 60 minutes.
  • end_delay: Optional. How long participants will have to submit their final count, in minutes. Defaults to 2 minutes. Must be less than 30 minutes.
  • start_date: The date the session should start on. Format: DD/MM/YYYY.
  • start_time: The time the session should start at. Format: HH:MM.
  • recurring: Optional. How often you'd like this session to reoccur. Defaults to once.
info

You cannot fill out both the session_length and random_length fields!

Scheduling Chain Sessions​

A group session can be scheduled using the /schedule chain command! There are several options to fill out, and not choosing any will result in the default values for the bot being used.

The various options for the command are shown below:

  • schedule_name: The name of the schedule you wish to create. Must be less than 20 characters.
  • session_length: Optional. How long you want each session to be, in minutes. Can be up to an hour long. Defaults to 15.
  • session_count: Optional. How many sessions you want to run. Can be up to 5. Defaults to 2.
  • start_delay: Optional. How long you'd like to wait before starting the first writing session. Defaults to 5 minutes. Maximum of 30 minutes.
  • chain_delay: Optional. How long you'd like to wait between writing sessions. Defaults to 5 minutes. Minimum of 2 minutes. Maximum of 60 minutes.
  • end_delay: Optional. How much of the chain_delay you'd like to spend waiting for results. Maximum of 59 minutes. Must be at least 1 minute less than the chain_delay. Defaults to 4 minutes.
  • mid_leaderboards: Optional. Whether or not you'd like to have a leaderboard after every session. Defaults to no.
  • start_date: The date the session should start on. Format: DD/MM/YYYY.
  • start_time: The time the session should start at. Format: HH:MM.
  • recurring: Optional. How often you'd like this session to reoccur. Defaults to once.

Viewing All Scheduled Sessions​

You can view a list of all scheduled sessions in a channel using the /schedule list command.

Deleting a Scheduled Session​

You can delete a scheduled session in a channel using the /schedule delete command, specifying the name of the schedule you wish to delete.