An open API service indexing awesome lists of open source software.

https://github.com/maxwlang/bttv-highlight-deleted-messages

Fork of BTTV that highlights deleted messages instead of just un-deleting them
https://github.com/maxwlang/bttv-highlight-deleted-messages

Last synced: about 19 hours ago
JSON representation

Fork of BTTV that highlights deleted messages instead of just un-deleting them

Awesome Lists containing this project

README

          

BetterTTV
=========

[![Build Status](https://github.com/night/betterttv/actions/workflows/ci.yml/badge.svg)](https://github.com/night/betterttv/actions/workflows/ci.yml) [![Dependencies Status](https://david-dm.org/night/BetterTTV/status.svg)](https://david-dm.org/night/BetterTTV) [![Discord](https://img.shields.io/discord/229471495087194112?color=%237289DA&label=discord)](https://discord.gg/nightdev)

Building BetterTTV
===

Getting the essentials
---
1. Install nodejs.
2. Run ```npm install``` within the BetterTTV directory.

Development
----

We use webpack to concatenate all of the files and templates into one.
Just run the following command from the BetterTTV directory to start a dev server.

```
npm start
```

A webserver will start and you are able to use the development version of BetterTTV on Twitch using this userscript in a script manager like TamperMonkey:

```
// ==UserScript==
// @name BetterTTV Development
// @description Enhances Twitch with new features, emotes, and more.
// @namespace http://betterttv.com/
// @copyright NightDev, LLC
// @icon https://cdn.betterttv.net/assets/logos/bttv_logo.png
// @version 0.0.1
// @match https://*.twitch.tv/*
// @grant none
// ==/UserScript==

(function betterttv() {
const script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'http://127.0.0.1:2888/betterttv.js';
const head = document.getElementsByTagName('head')[0];
if (!head) return;
head.appendChild(script);
})()
```

Once installed you should disable BetterTTV's main extension so BetterTTV will only be loaded from your computer.

**Debug Messages:**

In order to receive debug messages inside the browser's console log, you must toggle the consoleLog localStorage setting.

Type this in the JavaScript console to enable console logging:
```
BetterTTV.settings.set('consoleLog', true);
```

Linting
---
We use [ESLint](https://eslint.org/) to ensure a consistent code style and avoid buggy code.

Running ```npm run lint``` will automatically check for any errors in the code. Please fix any errors before creating a pull request. Any warnings produced prior to your changes can be ignored.

**Live Linting with Sublime Text:**

If you use Sublime Text as your text editor, you can set it up to highlight any errors that ESLint would throw in real-time.

1. Get ESLint using ```npm install eslint```
2. Install [Sublime Package Control](https://packagecontrol.io/installation)
3. Install [SublimeLinter](https://www.sublimelinter.com/en/latest/installation.html#installing-via-pc)
4. Install [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint#linter-installation)

**Live Linting with VSCode:**

If you use VSCode as your text editor, you can set it up to highlight any errors that ESLint would throw in real-time.

1. Get ESLint using ```npm install eslint```
2. Install the ESLint extension from the extensions marketplace