a473c6eb93
The Embedded Player Update! Adds support for the Compressor, Reset Button, and metadata to the embedded / pop-out player using a minimal build of FFZ. * Added: Support for the embedded player. * Fixed: Update the regex for clip URLs to match new extended slugs. * Fixed: Bugs in `experiments` and `raven` when the `site` module cannot be loaded or does not provide `getCore()`. * Fixed: Bug in the main menu where the menu may sometimes become unresponsive when opening to a page with no settings. * Fixed: Attempting to initialize the Compressor when a user has not yet interacted with a page may result in a broken audio stack. * Fixed: Setting Profile filters that are unknown would always match, rather than always failing. This is problematic if an add-on that provides a filter type has not yet loaded. |
||
|---|---|---|
| .github | ||
| bin | ||
| res | ||
| socketserver | ||
| src | ||
| styles | ||
| .babelrc | ||
| .eslintrc.js | ||
| .gitignore | ||
| changelog.html | ||
| fontello.client.json | ||
| fontello.config.json | ||
| jsconfig.json | ||
| LICENSE | ||
| old_changes.html | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| webpack.clips.common.js | ||
| webpack.clips.dev.js | ||
| webpack.clips.prod.js | ||
| webpack.common.js | ||
| webpack.web.common.js | ||
| webpack.web.dev.js | ||
| webpack.web.dev.prod.js | ||
| webpack.web.prod.js | ||
FrankerFaceZ
Copyright (c) 2018 Dan Salvato LLC
Licensed under the Apache License, Version 2.0. See LICENSE.
Developing
FrankerFaceZ uses node.js to manage development dependencies and to run an HTTP server for development. To get everything you need:
- Install node.js and npm
- Run
npm installwithin the FrankerFaceZ directory.
From there, you can use npm to build FrankerFaceZ from source simply by
running npm run build. For development, you can instruct webpack to watch
the source files for changes and re-build automatically with npm start
FrankerFaceZ comes with a local development server that listens on port 8000 and it serves up local development copies of files, falling back to the CDN when a local copy of a file isn't present.
Note: The local development server uses
webpack-dev-serverinternally, which self-signs a certificate for hosting content via HTTPS. You will need to ensure your browser accepts a self-signed certificate for localhost.
To make FrankerFaceZ load from your local development server, you must set
the local storage variable ffzDebugMode to true. Just run the following
in your console on Twitch: localStorage.ffzDebugMode = true;
It should be noted that this project is not a browser extension that you would load in your browser's extensions system. You still need the FrankerFaceZ extension or user-script for your browser.
You can edit the project's icon font using the npm run font command. This will
create a new Fontello session, if one doesn't already exist, and open your
default web browser to Fontello so you can edit the font.
If you're running the development server with npm start, you'll be able to
automatically save changes to the Fontello font by clicking Fontello's Export
button. Otherwise, you can use npm run font:save to download the changes
from your session.
Editor Settings
Please make sure that your editor is configured to use tabs rather than spaces
for indentation and that lines are ended with \n. It's recommended that you
configure linting support for your editor as well.
If you're using Visual Studio Code, make sure to install the ESLint extension and add the following to your workspace settings:
{
"eslint.validate": [
"javascript",
"javascriptreact",
"vue"
]
}