mirror of https://github.com/FrankerFaceZ/FrankerFaceZ.git synced 2025-06-27 12:55:55 +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 830726432b Update licensing information.		2016-11-09 23:45:08 -05:00
socketserver	stop panicing earlier than needed	2016-07-16 15:29:12 -07:00
src	Fix pinned cheers.	2016-11-09 22:19:37 -05:00
.gitignore	3.5.266. Yeah. This is me remembering to commit again, but only because I told someone to make a pull request.	2016-08-09 20:45:28 -04:00
changelog.html	Fix pinned cheers.	2016-11-09 22:19:37 -05:00
credits.html	3.5.313. Logviewer integration.	2016-10-05 01:31:10 -04:00
dark.css	3.5.363. Properly position search popout. Dispatch events correctly for TwitchBot. Fix an issue with BTTV compatibility. Dark mode CSS tweaks.	2016-11-08 16:43:02 -05:00
gulpfile.js	3.5.342. Fixes for the API breaking when it's used before FFZ has initialized. Make API instances event emitters. Events for stuff. Deprecate non-event callbacks for the API. Everything is nice.	2016-10-20 02:34:55 -04:00
ISSUE_TEMPLATE.md	3.5.307. Increment the version. Update ISSUE_TEMPLATE to be a bit simpler.	2016-10-03 18:36:59 -04:00
LICENSE	Update licensing information.	2016-11-09 23:45:08 -05:00
old_changes.html	Fix pinned cheers.	2016-11-09 22:19:37 -05:00
package.json	3.5.271 to 3.5.284. As usual, I only remember to commit when someone mentions it.	2016-09-09 17:34:20 -04:00
README.md	Update licensing information.	2016-11-09 23:45:08 -05:00
style.css	Fix pinned cheers.	2016-11-09 22:19:37 -05:00

README.md

FrankerFaceZ

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
Run npm install -g gulp to install the gulp command line utility.
Run npm install within the FrankerFaceZ directory.

From there, you can use gulp to build the extension from source simply by running gulp. For development, you can instruct gulp to watch the source files for changes and re-build automatically with gulp watch

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. To start the server, run gulp server

For convenience, the server is run automatically along with gulp watch

Use the command /ffz developer_mode on or /ffz developer_mode off in Twitch chat to toggle developer mode on or off. You must then refresh the page for changes to take effect. If FFZ is not working or the command otherwise fails to work, you can open the JavaScript console on twitch.tv and run localStorage.ffzDebugMode = true; or localStorage.ffzDebugMode = false; to enable or disable the feature.