Management of the World Spotlight community feature: applications, upcoming, reminders and timing.

The Spotlight cog provides functionality which manages the World Spotlight community feature. A number of functions are bundled in this cog:

  • Applications review and management (mod only)
  • Announcing a project in the World Spotlight channel (mod only)
  • Management of a queue of upcoming World Spotlight events (mod only)
  • Following or unfollowing World Spotlight notifications (everyone)
  • Starting a World Spotlight, timing and reminders (Spotlight Host only)

1. spotlight

World Spotlight commands group. See sub-commands.

Usage: .spotlight

1.1. spotlight join

Usage: .spotlight join

Join the World Spotlight Audience. This allows you to be pinged by moderators or the Host for news like the start of a new World Spotlight or a newly released schedule.

To leave the Audience, use `.spotlight leave`.

1.2. spotlight leave

Usage: .spotlight leave

Leave the World Spotlight Audience. See `.help spotlight join` for more information.

To join the World Spotlight Audience, use `.spotlight join`.

1.3. spotlight start

Start the World Spotlight. For use by the Spotlight Host.

KazTron will announce the start of your World Spotlight and start counting down your remaining time. You will get periodic reminders about the time remaining, as well as an announcement about the end of your World Spotlight.

You can stop the World Spotlight early by calling spotlight stop.

Usage: .spotlight start

Details

Members
Spotlight Host, Moderators, Administrators.
Channels
#community-programs.

1.4. spotlight stop

Stop an ongoing World Spotlight previously started with spotlight start.

Usage: .spotlight stop

Details

Members
Spotlight Host, Moderators, Administrators.
Channels
#community-programs.

1.5. spotlight time

Check the remaining time for the current World Spotlight.

Usage: .spotlight time

Details

Channels
#community-programs.

1.6. spotlight list (l)

List all the World Spotlight applications in summary form.

Usage: .spotlight [list|l]

Details

Members
Moderators, Administrators.

1.7. spotlight current (c)

Show the currently selected application.

The “current application” is selected by spotlight roll or spotlight select, and is the application used by spotlight showcase and spotlight queue add.

Usage: .spotlight [current|c]

Details

Members
Moderators, Administrators.

1.8. spotlight select (s)

Set the currently selected application.

Usage: .spotlight [select|s] <list_index>

Parameters

<list_index>
number. The numerical index of an application, as shown by spotlight list.

Details

Members
Moderators, Administrators.

Example

  • .spotlight set 5 - Set the current application to entry

1.9. spotlight roll (r)

Select a World Spotlight application at random, and set it as the currently selected application. Only applications that are marked ‘ready for Spotlight’ will be selected.

Usage: .spotlight [roll|r]

Details

Members
Moderators, Administrators.

1.10. spotlight showcase

Announce the next World Spotlight from the currently selected application in the configured public World Spotlight channel. Also switches the Spotlight Host role to the applicant (if a valid user).

Usage: .spotlight showcase

Details

Members
Moderators, Administrators.

1.11. spotlight queue (q)

Command group containing subcommands that allow managing the queue of upcoming World Spotlight events. See sub-commands for more information.

Usage: .spotlight [queue|q]

Details

Members
Moderators, Administrators.

1.11.1. spotlight queue list (l)

Lists the current queue of upcoming World Spotlight events.

The queue is always ordered chronologically. If two queue items have the exact same date, the order between them is undefined.

Usage: .spotlight queue [list|l]

Details

Members
Moderators, Administrators.

1.11.2. spotlight queue showcase (s)

Lists the queued World Spotlight events for a given month. This is sent as markdown in a code block, suitable for copy-pasting so that a mod can use it to prepare an announcement.

Usage: .spotlight queue [showcase|s] [month]

Parameters

[month]
date. Optional. The month for which to list queued applications. Default: next month

Details

Members
Moderators, Administrators.

Examples

  • .spotlight q s 2018-03
  • .spotlight q s March 2018

1.11.3. spotlight queue add (a)

Add a World Spotlight application scheduled for a given date range.

The currently selected application will be added. Use spotlight select or spotlight roll to change the currently selected application.

Usage: .spotlight queue [add|a] <daterange>

Parameters

<daterange>
string. A string in the form of date1 to date2. Each of the two dates can be in any of these formats:
  • An exact date: 2017-12-25, 25 December 2017, December 25, 2017.
  • A partial date: April 23 (nearest future date)
  • A time expression: tomorrow, next week, in 5 days. You cannot use days of the week (e.g. “next Tuesday”).

Details

Members
Moderators, Administrators.

Examples

  • .spotlight queue add 2018-01-25 to 2018-01-26
  • .spotlight queue add april 3 to april 5

1.11.4. spotlight queue edit (e)

Change the scheduled date of a World Spotlight in the queue.

Usage: .spotlight queue [edit|e] <queue_index> <daterange>

Parameters

<queue_index>
number. The queue position to edit, as shown with spotlight queue list.
<daterange>
string. A daterange in the form date1 to date2. The same kind of dates are accepted as for spotlight queue add.

Details

Members
Moderators, Administrators.

Example

  • .spotlight queue edit 3 april 3 to april 6

1.11.5. spotlight queue next (n)

Pop the next World Spotlight in the queue and set it as the currently selected application. This is a useful shortcut to announce the next World Spotlight in queue, and is usually followed by a call to spotlight showcase.

Usage: .spotlight queue [next|n]

Details

Members
Moderators, Administrators.

1.11.6. spotlight queue rem (r, remove)

Remove a World Spotlight application from the queue.

Usage: .spotlight queue [rem|r|remove] [queue_index]

Parameters

[queue_index]
number. Optional. The queue position to remove, as shown with spotlight queue list. If not specified, then the last item in the queue is removed.

Details

Members
Moderators, Administrators.

Examples

  • .spotlight queue rem - Remove the last spotlight in the queue.
  • .spotlight queue rem 3 - Remove the third spotlight in the queue.

1.11.7. spotlight queue insert (i)

Unsupported as of v2.1.

Usage: .spotlight queue [insert|i]

Details

Members
Moderators, Administrators.