Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 3.26 KB

README.md

File metadata and controls

100 lines (76 loc) · 3.26 KB
Raw

Nightbot Queue

Simple queue system for Nightbot (requires your own server/database/domain to run)

Setting it up

  1. Make sure you have your own server, domain and database running and reachable.
  2. See below how to set up your database tables.
  3. Upload these files to your server, directly on the domain root.
  4. In config.php, change the values for your database connection to match your credentials.

Setting up the databaes

--
-- Table structure that houses the actual list
-- Replace <CHANNEL_NAME> with your desired channel name
-- For multiple channels, each channel should have a table
--

CREATE TABLE `<CHANNEL_NAME>` (
  `id` int(11) NOT NULL,
  `user` varchar(255) COLLATE utf8_unicode_ci NOT NULL
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

-- --------------------------------------------------------

--
-- Table structure for telling if the queue is open or not
-- Make <CHANNEL_NAME> the same as above
-- Insert any additional channels as needed (needs a table like above)
--

CREATE TABLE `channel_statuses` (
  `id` int(11) NOT NULL,
  `channel_name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  `is_open` tinyint(1) NOT NULL
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

INSERT INTO `channel_statuses` (`id`, `channel_name`, `is_open`) VALUES
(1, '<CHANNEL_NAME>', 0);

Create the Nightbot commands

All "channel" values must be the same as <CHANNEL_NAME>

Command: !addme

!commands add !addme $(urlfetch http://www.example.com/add.php?channel=dsc&user=$(user))

Usage: !addme

Definition: Adds the calling user to the bottom of the list. Only allows one entry per user, until their entry is deleted by !nextup.

Command: !showqueue

!commands add !showqueue $(urlfetch http://www.example.com/list.php?channel=dsc)

Usage: !showqueue

Definition: Lists up to 100 characters from the top of the queue. This is limited because the message size for the chat is limited.

Command: !nextup INTEGER

!commands add !nextup $(urlfetch http://www.example.com/next.php?channel=dsc&count=$(query))

Usage: !nextup 3

Definition: Pulls the top 3 names from the queue and deletes them from the database

Note: Make sure this is set to Owner or Owner/Moderators only! You don't want random users coming in and deleting so many names out of the queue just because.

Command: !clearqueue

!commands add !clearqueue $(urlfetch http://www.example.com/clear.php?channel=dsc)

Usage: !clearqueue

Definition: Removes all users currently in the database so the queue can be started again fresh.

Note: Make sure this is set to Owner or Owner/Moderators only! You don't want random users coming in and deleting names out of the queue just because.

Command: !openqueue

!commands add !openqueue $(urlfetch http://www.example.com/status.php?channel=dsc&desired=open)

Usage: !openqueue

Definition: Opens the queue up to user submissions

Command: !closequeue

!commands add !closequeue $(urlfetch http://www.example.com/status.php?channel=dsc&desired=close)

Usage: !closequeue

Definition: Closes the queue up to user submissions

Developer's notes for streamers

  • Use the !showqueue command to check for names that may have persisted from the last stream.

TODO

  • Convert to a true RESTful API