mirror of https://github.com/FrankerFaceZ/FrankerFaceZ.git synced 2025-06-27 21:05:53 +00:00

The Twitch Enhancement Suite. Get custom emotes and tons of new features you'll never want to go without. https://www.frankerfacez.com/

Find a file

SirStendec 9de1ad501d Update developer mode. Make sure the extension will still work if dev mode is left on while the local dev server isn't running.		2015-01-15 13:58:10 -05:00
Chrome Extension	Update developer mode. Make sure the extension will still work if dev mode is left on while the local dev server isn't running.	2015-01-15 13:58:10 -05:00
src	Update developer mode. Make sure the extension will still work if dev mode is left on while the local dev server isn't running.	2015-01-15 13:58:10 -05:00
test	Initial commit for modular FrankerFaceZ rewrite.	2015-01-12 17:58:07 -05:00
.gitignore	Fix typo in gitignore.	2015-01-15 13:57:17 -05:00
gulpfile.js	Initial commit for modular FrankerFaceZ rewrite.	2015-01-12 17:58:07 -05:00
package.json	Initial commit for modular FrankerFaceZ rewrite.	2015-01-12 17:58:07 -05:00
README.md	Add a readme.	2015-01-12 18:07:44 -05:00
script.js	Attempt to make FrankerFaceZ work with the expected Twitch changes given what I've learned through emails with Twitch staff.	2015-01-12 18:18:23 -05:00
script.min.js	Attempt to make FrankerFaceZ work with the expected Twitch changes given what I've learned through emails with Twitch staff.	2015-01-12 18:18:23 -05:00

README.md

FrankerFaceZ

This script is free to modify for personal use. You are not allowed to sell or distribute FrankerFaceZ or any components of FrankerFaceZ.

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
Run npm install within the FrankerFaceZ directory.

From there, you can use gulp to build the extension from source:

gulp

Gulp can also watch source files for modifications and rebuild it immediately:

gulp watch

To start the development server, run npm test. The development server listens on port 8000.

You will also need to use the version of the Chrome extension included in the repository. Remove any existing copy of FrankerFaceZ from your browser and load the unpacked extension in the Chrome Extension folder.

Once you're using that extension, use the command /ffz debug in Twitch chat to enable debug mode, and then refresh the page. If the current version of FFZ does not support the debug command, then open the JavaScript console on twitch.tv and run:

localStorage.ffzDebugMode = true;

Refresh the page once debug mode is enabled to use the local version of the script.