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

Kane York 4874d2577f Update the archetecture drawing		2016-02-03 22:06:57 -08:00
Chrome Extension	Final manifest version? I hope.	2015-02-08 23:14:29 -05:00
socketserver	Update the archetecture drawing	2016-02-03 22:06:57 -08:00
src	Revert "Update tweet tooltip display code"	2015-12-16 09:44:52 -08:00
.gitignore	3.5.78 to 3.5.83. It's been so long since I've commited. I'm a bad person. Added grouping for hosted channels, and a menu to select which channel you visit. Added weights for selecting which socket server to use. Added server time offset calculations. Refactored a LOT of how chat badges and chat line rendering and history processing works behind the scenes. Removed a ton of duplicate code. Added basic adjacent chat message lookups. Need better server support.	2015-11-19 02:45:56 -05:00
dark.css	3.5.84 to 3.5.100. Most importantly, started using new Ember stuff. -view-registry instead of Ember.View.views, and such. Finally added UI for managing pinned channels. Use HTTPS for the API and socket servers. Don't immediately unload chat rooms. Smarter chat tab behavior. Added /card command for opening mod cards. Other stuff.	2015-12-12 13:28:35 -05:00
gulpfile.js	3.5.78 to 3.5.83. It's been so long since I've commited. I'm a bad person. Added grouping for hosted channels, and a menu to select which channel you visit. Added weights for selecting which socket server to use. Added server time offset calculations. Refactored a LOT of how chat badges and chat line rendering and history processing works behind the scenes. Removed a ton of duplicate code. Added basic adjacent chat message lookups. Need better server support.	2015-11-19 02:45:56 -05:00
package.json	3.5.41 to 3.5.50. Viewer list sorting is now optional. CSS is now embedded in the script to prevent loading issues. Started testing new socket server. Added chat batching option to display new messages in batches for performance reasons. Changed socket server rotation logic. Added error checks for Stream Latency. Socket protocol now uses ok instead of True. Added deploy and clear_cache commands to gulp for convenience.	2015-11-01 17:28:19 -05:00
README.md	Fix initial setup, have dev server only listen on localhost.	2015-08-08 23:36:02 -07:00
style.css	3.5.84 to 3.5.100. Most importantly, started using new Ember stuff. -view-registry instead of Ember.View.views, and such. Finally added UI for managing pinned channels. Use HTTPS for the API and socket servers. Don't immediately unload chat rooms. Smarter chat tab behavior. Added /card command for opening mod cards. Other stuff.	2015-12-12 13:28:35 -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 -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.