Grav Hitbox Plugin

Hitbox is a simple Grav Plugin that converts markdown links into Hitbox.tv embeds.

Installation

Installing the Hitbox plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM)through your system's Terminal (also called the command line). From the root of your Grav install type:

bin/gpm install hitbox

This will install the Hitbox plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/hitbox.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to hitbox. You can find these files either on GitHubor via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/hitbox

Config

Config Defaults

enabled: true

player:
    enabled: true
    properties:
        frameborder: 0
        height: 720
        width: 75%
        style: 'float: left;'

chat:
    enabled: true
    properties:
        frameborder: 0
        height: 720
        width: 25%
        style: 'float: right'

Note: those settings work pretty well with the default Grav Antimatter theme for a stream focused page layout but should probably be modified depending on your theme and your usage.

Config File

If you need to change any value, then the best process is to copy the hitbox.yaml file into your users/config/plugins/ folder (create it if it doesn't exist), and then modify there. This will override the default settings.

Page-level Config

You can also use a page-level configuration by including a hitbox: tag in your page front-matter. The content of this YAML tag is similar to the configuration file :

title: Home

hitbox:
    player:
        enabled: true
        properties:
            frameborder: 0
            height: 720
            width: 75%
            style: 'float: left;'
    chat:
        enabled: true
        properties:
            frameborder: 0
            height: 720
            width: 25%
            style: 'float: right'

This method should be only used if the settings of the Hitbox plugin are different from a page to another. (e.g: A stream preview on your homepage and the full stream with the chat on a dedicated page)

Usage

To use this plugin you simply need to include a hitbox channel name in a markdown link such as:

[plugin:hitbox](esltv)

This example will be converted into a Hitbox embed of the http://www.hitbox.tv/esltv channel.