1
0
Fork 0
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 80931479c1 4.63.0
* Added: Setting to display Content Flags on directory pages.
* Fixed: The setting to make the player larger on `clips.twitch.tv` pages incorrectly defaulting to true. Closes #1440.
* Fixed: Exception thrown when pressing Escape in chat with a tray open.
* Fixed: Chat not correctly displaying messages until the mouse is moved when using an option to pause chat using mouse movement.
* Fixed: Misspelled entry in the Content Flags list.
* Fixed: Some directory cards not being correctly detected by FFZ.
* Fixed: Color processing throwing an exception if the input value is empty.
* Fixed: Some page elements failing to appear correctly, instead showing an error. Notably this affects the PrattleNot add-on as well as some emote tool-tips. Closes https://github.com/FrankerFaceZ/Add-Ons/issues/193
* Changed: Add a note to the setting to hide extensions that recommends CommanderRoot's Disable Twitch Extensions browser extension.
* Changed: Log a warning when users use external scripts to mess with experiments.
* API Changed: `deep_copy` now correctly handles RegExp, Date, Set, and Map objects.
2023-12-18 17:11:44 -05:00
.github 4.42.0 2023-03-06 17:08:47 -05:00
bin Initial commit for converting FrankerFaceZ to TypeScript. 2023-11-13 20:47:45 -05:00
res 4.44.0 2023-03-27 18:50:32 -04:00
socketserver 4.8.1 2019-08-07 14:13:04 -04:00
src 4.63.0 2023-12-18 17:11:44 -05:00
styles 4.63.0 2023-12-18 17:11:44 -05:00
types More type progress. 2023-11-16 18:41:50 -05:00
.editorconfig Initial commit for converting FrankerFaceZ to TypeScript. 2023-11-13 20:47:45 -05:00
.eslintrc.js Maintenance: This commit updates to webpack v5 and esbuild. I'm still testing it, but I think this'll work. 2023-09-01 17:01:52 -04:00
.gitignore Initial commit for converting FrankerFaceZ to TypeScript. 2023-11-13 20:47:45 -05:00
changelog.html 4.0.0-rc13.7 2018-11-12 13:34:53 -05:00
fontello.client.json This is a maintenance commit with no released build. 2019-09-29 15:49:29 -04:00
fontello.config.json 4.44.0 2023-03-27 18:50:32 -04:00
jsconfig.json Maintenance: This commit updates to webpack v5 and esbuild. I'm still testing it, but I think this'll work. 2023-09-01 17:01:52 -04: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.json 4.63.0 2023-12-18 17:11:44 -05:00
pnpm-lock.yaml More type progress. 2023-11-16 18:41:50 -05:00
README.md Dependency Maintenance 2021-11-06 20:12:55 -04:00
tsconfig.json More type progress. 2023-11-16 18:41:50 -05:00
typedoc.json Initial commit for converting FrankerFaceZ to TypeScript. 2023-11-13 20:47:45 -05:00
webpack.config.js Initial commit for converting FrankerFaceZ to TypeScript. 2023-11-13 20:47:45 -05:00

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. This project uses the pnpm package manager. To get everything you need:

  1. Install node.js and pnpm
  2. Run pnpm install within the FrankerFaceZ directory.

From there, you can use npm to build FrankerFaceZ from source simply by running pnpm build. For development, you can instruct webpack to watch the source files for changes and re-build automatically with pnpm 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-server internally, 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 pnpm 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 pnpm start, you'll be able to automatically save changes to the Fontello font by clicking Fontello's Export button. Otherwise, you can use pnpm 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"
	]
}