Skip to main content

WriterStats Events

Server Events allow you to create writing events for your server, where members work together across sessions to write the most within a given period of time!

All writing done in group sessions in the server during the event period count towards a member's progress, with leaderboards available throughout the event and at its conclusion! Events are the perfect way to incentivise writing activity in your server and hold organised events for periods such as NaNoWriMo!

Events have 3 phases:

  • Scheduled: An embed is sent to the event channel with the details of the event. Members can now start joining the event.
  • Started: An embed is sent to the event channel announcing that the event has started. All group sessions run in the server will count towards a member's event progress!
info

You must be a WriterStats Server Moderator to schedule and manage events. Learn more about these on the server settings page!

Scheduling an Event​

You can schedule an event using the /event schedule command!

The various options for the command are shown below:

  • event_name: The name of the event you wish to create. Must be under 50 characters long.
  • start_date: The date the event should start on. Format: DD/MM/YYYY. Must be a date in the future.
  • start_time: The time the event should start at. Must be in an interval of 15 minutes. Format: HH:MM, in 24 hour time. Must be a time in the future.
  • finish_date: The date the event should finish on. Format: DD/MM/YYYY. Must be after the start date.
  • finish_time: The time the event should finish at. Must be in an interval of 15 minutes. Format: HH:MM, in 24 hour time. Must be after the start time.
  • event_channel: The channel where event messages should be posted.
  • event_description: The description for the event. This will display on event start and information embeds.

An image of a sample event scheduling command is shown below. Feel free to use it as a guide for your own events!

A screenshot of an event being scheduled using /event schedule.

note

A server can only have one scheduled event at a time.

Joining an Event​

You can join a currently scheduled event using the /event join command!

tip

Don't worry if you've missed the start of the event! Joining an event after it has started will still lead to all the sessions you have run in the event period counting towards your results!

Leaving an Event​

You can leave an event you have joined in a specific server using the /event leave command.

Viewing Information for the Current Event​

You can view information for a currently running event using the /event info command.

Viewing an Event's Leaderboard​

You can view the current event's leaderboard using the /event leaderboard command! You can specify the type of leaderboard you wish to view using the leaderboard_type field.

Viewing your Event Rank​

You can view your ranks in the current event using the /event rank command.

note

Event leaderboards and ranks update the first time either command is used in an hour.

Modifying an Event​

Events can be modified using the /event rename, /event set and /event reset commands and subcommands.

The various fields that can be modified are detailed below:

Event Name​

You can rename an event using the /event rename command. This changes the event name for all future interactions with it!

Event Description​

Your event description shows up on its scheduled and information embeds. You can change an event's description using the /event set description command, and reset using the /event reset command.

Event Role​

You can set an event role to be mentioned for all event-related messages using the /event set role command, and reset it using the /event reset command.

You can set a link for the event information embed using the /event set link command, and reset it using the /event reset command. Provide a valid URL in order to ensure it is displayed.

Event Image​

You can set an image for the event information embed using the /event set image command, and reset it using the /event reset command. Provide a valid URL to an image in order to ensure it is displayed.

Event Leaderboard Type​

You can set the type of leaderboard displayed at the end of the event using the /event set leaderboard_type command, and reset it using the /event reset command.

Cancelling an Event​

You can cancel an event using the /event cancel command.

Viewing Results for a Past Event​

You can view your results for an event completed in the last three days using the /event results command! Simply select the event you wish to view using the event_name field.