Skip to main content

Session Presets

Session presets allow you to create "preset" sessions with certain values such as their length, start delay and end delay already filled out! This reduces the time it takes for you to start a session, and quickly begin with one of your favourite configurations.

Read on to learn more about this feature!

note

Session presets are a patron-exclusive feature! Learn more about becoming a supporter using the /support command or by visiting the Support WriterStats page!

Creating a Session Preset​

A preset can be created using the /presets create command.

The various options for the command, which are similar to those of group sessions, are shown below:

  • preset_name: The name of the preset you wish to create. Must be less than 20 characters.
  • session_type: Whether the session preset is for an individual or group session.
  • session_length: How long you want the preset 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: Let WriterStats pick a random length for your session preset, based on your criteria!
  • start_delay: Optional. How long before the preset 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.
  • join_type: Optional. Whether you wish to join as a paricipant or a spectator. This is participant, by default.
tip

Pick the name of your preset carefully! Once created, the name of a preset cannot be changed. You can have a maximum of 10 presets.

Running a Preset Session​

Once created, you can run a preset session in any place you could ordinarily run the session using the /session preset command! Simply start typing in your preset name into the preset_name field and select one of your displayed presets!

You can also fill out the optional starting_count and project_name fields, which behave in a similar manner to their counterparts in the /session individual and /session group commands.'

Deleting a Session Preset​

You can delete a preset using the /presets delete command.

Type in the preset's name into the preset_name field and select one of your displayed presets, as shown below:

A screenshot of /presets delete being used.

Click on the "Confirm" button on the embed that follows to complete deleting your preset.

danger

This action is irreversible.

Viewing a Session Preset​

You can view the details for a preset using the /presets delete command.

Type in the preset's name into the preset_name field and select one of your displayed presets to see the preset's details.

What's Next?​

You have now learned how to create and use session presets! This completes the docs' overview on WriterStats sessions. Be sure to join the official support server if you have any further questions, where one of our helpers can help you!