Twitch Integration Shortcode Guide

How to use Shortcodes

The most basic shortcode to use with the StreamWeasels Twitch Integration plugins is simply [streamweasels]

This will insert a Twitch Integration according the the settings you have selected in the main Twitch Integration settings page and is the easiest way to use our plugins.

Layout Not Set Error

If you are simply using the shortcode [streamweasels] you might see a Layout Not Set message on your site if you have not selected and saved a layout on the main Twitch Integration settings page.

Make sure you have selected a Layout on the Main Settings page like this:

Main Settings - Layout

Another quick way around this error is to simply set the layout on your shortcode like this: [streamweasels layout="wall"]

More Advanced Shortcodes

Using the settings on the Main Settings Page works great if you are simply going to use one Twitch Integration on your site. Configure your settings, add your simple shortcode [streamweasels] and then you're done.

But what if you want to have multiple Twitch Integrations on your site. Maybe you want to have 2 or 3 on a single page, or you want to have one on multiple different pages with different settings? That's where the shortcode attributes and values come in.

If you want to use multiple different integrations with custom settings on each throughout your site, you will have to set these custom variables in the shortcode. For example;

[streamweasels layout="wall" channels="lirik,shroud,sodapoppin" autoplay="1"]

This will embed a Twitch Wall Integration with 3 declared streamers with autoplay enabled.

StreamWeasels Twitch Integration has over 30 settings, and each add-on also has their own settings. Each and every setting can be added to your shortcodes for fine, granular control. You can find a list of those attributes and settings for each plugin below.

Full List of Shortcode Attributes and Values

Main Settings

Field	Attribute	Values	Description
Game	game=""	Input game name as appears on twitch	Pulls all streams playing selected game
Language	language=""	Type ISO 639-1 2 letter language code	Pulls all streams labelled as this language
Channels	channels=""	Input list of channel names separated by comma (no space required	Pulls only channels defined in field.
Team	team=""	Input name of twitch team exactly as it appears in twitch url.	Pulls all streams from defined twitch team.
Title Filter	title-filter=""	Input a Term to filter streams (E.g "NoPixel")	Displays only streams containing filter in title.
Limit	limit=""	Number up to 100	Limits number of streams to this number.

Layout settings

Field	Attribute	Values	Description
Layout	layout=""	none	Displays basic embedded content
		wall	Displays embedded content using Wall Add On
		rail	Displays embedded content using Rail Add On
		player	Displays embedded content using Player Add On
		status	Displays embedded content using Status Add On
		feature	Displays embedded content using Feature Add On
		vods	Displays embedded content using Vods Add On
		nav	Displays embedded content using Nav Add On

Embed Settings

Field	Attribute	Values	Description
Embed	embed=""	page	Embed the Twitch content directly on the page
		popup	Embed the Twitch content in a popup
		twitch	Direct users directly to Twitch
Embed Colour Scheme	embed-theme=""	dark	Use Dark Theme for embedded twitch content
		light	Use Light Theme for embedded twitch content
Display Chat	embed-chat=""	1	Display chat on Player
		0	Hide Chat on Player
Display Title	embed-title=""	1	Display Title of twitch content as set by streamer
		0	Hide Title of stream
Title Position	title-position=""	top	Display title on top of embedded content
		bottom	Display title at bottom of embedded content
Start Muted	embed-muted=""	1	Start embedded content muted
		0	Start embedded content with sound

Offline Settings

Field	Attribute	Values	Description
Show Offline Streams	show-offline=""	1	Show offline streams in list
		0	Only show online streams in list
Offline Message	show-offline-text=""	Custom Text	Display Custom message when ALL streams are offline
Offline Image	show-offline-image=""	Image URL	Display Image when ALL streams are offline

Autoplay Settings

Field	Attribute	Values	Description
Autoplay Stream	autoplay=""	1	Autoplay stream on loading
		0	Do not load video on page loading
Autoplay Select	autoplay-select=""	most	Autoplay the most viewed stream from list
		least	Autoplay the least viewed stream from list
		random	Autoplay a random stream from list
Featured Streamer	featured-stream=""	Channel name of featured stream	If this channel is online autoplay it.

Appearance Settings

Field	Attribute	Values	Description
Title	title=""	Custom Text	Add your own title to embedded content
Subtitle	subtitle=""	Custom Text	Add your own subtitle to embedded content
Offline Image	offline-image=""	Image URL	Show custom profile image when channel offline
Custom Logo	logo-image=""	Image URL	Use custom image rather than channel profile image
Profile Image		1	Use profile image set by channels (only works when channels are offline at moment)
		0	Do not show profile images at all
Logo Background Colour	logo-bg-colour=""	Colour Hex Code	Add Background colour to logo
Logo Border Colour	logo-border-colour=""	Colour Hex Code	Add border colour to logo
Max Width	max-width	Custom number of pixels	set maximum width of content

Tile Settings

Field	Attribute	Values	Description
Tile Layout	tile-layout=""	detailed	Tile showing channel preview, channel name, logo and background colour
		compact	Tile without background colour or profile logo
Tile Sorting	tile-sorting=""	most	Order tiles from most viewed first then descending
		least	Order tiles from least viewed first then ascending
		alpha	Order tiles alphabetically by channel name
		random	Order tiles randomly
Live Info	tile- live-info=""	viewer	Show number of viewers on top left of tile
		online	Show green online dot next to viewer count or red offline dot for offline
		live	Show "Live" Text on red background on live channels
		none	No display at top left of tile.
Background Colour	tile-background-colour=""	Colour Hex Code	Background colour for tiles.
Title Colour	tile-title-colour=""	Colour Hex Code	Set colour of channel title on tile
Subtitle Colour	subtitle-colour=""	Colour Hex Code	Set colour of channel subtitle on tile
Rounded Corners	tile-rounded-corners=""	Number	Set pixel value for rounded corners, recommended between 5 - 40

Hover Settings

Field	Attribute	Values	Description
Hover Effect	hover-effect=""	None	No Hover effect
		Twitch	Twitch style drop shadow effect on hover
		Play	Play button effect on hover
Hover Colour	hover-colour=""	Colour Hex Code	Colour used with Twitch Hover effect for drop shadow

Twitch Integration Add-ons

StreamWeasels Twitch Integration comes with many Add-on plugins to enable different layouts. These Add-on plugins have their own settings on top of the Main Settings above. You can find out more about each of the StreamWeasels Add-ons and their settings below:

Twitch Wall Add-on

Twitch Wall - Classic Twitch layout for displaying many streams at once.

View Twitch Wall Add-on Shortcode Settings.

Twitch Rail Add-on

Twitch Rail - Horizontal scrolling layout, display many streams in a small space.

View Twitch Rail Add-on Shortcode Settings.

Twitch Player Add-on

Twitch Player - Compact, cinema-style layout, great for embedded stream experience.

View Twitch Player Add-on Shortcode Settings.

Twitch Status Add-on

Twitch Status - Simply display Twitch live status on every page on your website.

View Twitch Status Add-on Shortcode Settings.

Twitch Feature Add-on

Twitch Feature - Slick, professional-style layout inspired by the Twitch homepage.

View Twitch Feature Add-on Shortcode Settings.

Twitch Vods Add-on

Twitch Vods - The easiest way to display Twitch VODS on your website.

View Twitch Vods Add-on Shortcode Settings.

Twitch Showcase Add-on

Twitch Showcase - eSports-inspired Twitch Integration with custom images.

View Twitch Showcase Add-on Shortcode Settings.