oss/FrankerFaceZ
oss/FrankerFaceZ
1
0
Fork 0
mirror of https://github.com/FrankerFaceZ/FrankerFaceZ.git synced 2025-06-27 21:05:53 +00:00
Code Wiki Activity
The Twitch Enhancement Suite. Get custom emotes and tons of new features you'll never want to go without. https://www.frankerfacez.com/
648 commits 5 branches 1 tag 14 MiB
Find a file
SirStendec f9f5f0affa The Big Linting Commit. 
* Add linting for Vue files.
* Fix a bunch of linting problems in Vue files.
* Update README with notes about configuring editors.
2018-03-30 17:58:56 -04:00
res/font Add info and question icons. Bump version to beta1.7. Add chat badge visibility. Add support for setting inheritance merge strategies. 2018-03-22 22:39:27 -04:00
socketserver Add vendoring lockfile 2017-11-13 15:57:48 -08:00
src The Big Linting Commit. 2018-03-30 17:58:56 -04:00
styles Change the settings pop-out to use a chat pop-out. Tweaks to badge visibility rendering. Forcibly set tw-theme--dark on body since Twitch doesn't do it consistently with pop-outs. 2018-03-24 04:19:41 -04:00
.babelrc Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00
.eslintrc.js The Big Linting Commit. 2018-03-30 17:58:56 -04:00
.gitignore Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00
changelog.html Update change-log. Fix a bug with cheer stacking when the standard cheers aren't available. 2018-03-25 22:16:16 -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
jsconfig.json Fix jsconfig.json so that import aliases work in VS Code. 2017-11-17 03:12:49 -05:00
LICENSE Update licensing information. 2016-11-09 23:45:08 -05:00
old_changes.html 4.0.0 Beta 1 2017-11-13 01:23:39 -05:00
package-lock.json The Big Linting Commit. 2018-03-30 17:58:56 -04:00
package.json The Big Linting Commit. 2018-03-30 17:58:56 -04:00
README.md The Big Linting Commit. 2018-03-30 17:58:56 -04:00
webpack.common.js Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00
webpack.web.babel.js Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00
webpack.web.common.js Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00
webpack.web.dev.js Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00
webpack.web.prod.js Developer improvements. Start using babel as the parser for eslint to add support for webpack's dynamic import syntax. Move most babel config into the babel build file to make sure nothing weird happens with eslint. Commit package-lock. Clean up gitignore a bit. Fix linting issues with the webpack build files. 2018-03-15 16:59:10 -04:00

README.md

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:

  1. Install node.js and npm
  2. Run npm install within 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 gulp 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.

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.

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",
		"vue"
	]
}```