├── .eslintignore ├── src ├── README.md ├── render │ ├── common.ts │ ├── highlights │ │ └── render.ts │ └── arrows │ │ ├── defs │ │ └── render.ts │ │ └── render.ts ├── message.ts ├── defaults.ts ├── state.ts ├── options │ ├── swatches.ts │ └── color-picker.ts ├── options.ts ├── index.ts └── dependency-graph.svg ├── icons ├── icon@48.png └── icon@128.png ├── images ├── promo.png └── comparison.png ├── static ├── rainbow.png ├── index.css ├── options.html └── options.css ├── .gitignore ├── tsconfig.json ├── rollup.config.js ├── .eslintrc.json ├── package.json ├── manifest.json ├── README.md └── LICENSE.txt /.eslintignore: -------------------------------------------------------------------------------- 1 | bundled 2 | -------------------------------------------------------------------------------- /src/README.md: -------------------------------------------------------------------------------- 1 | ![Graph of module dependencies](dependency-graph.svg) 2 | -------------------------------------------------------------------------------- /icons/icon@48.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/370417/fancyground/HEAD/icons/icon@48.png -------------------------------------------------------------------------------- /images/promo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/370417/fancyground/HEAD/images/promo.png -------------------------------------------------------------------------------- /icons/icon@128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/370417/fancyground/HEAD/icons/icon@128.png -------------------------------------------------------------------------------- /static/rainbow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/370417/fancyground/HEAD/static/rainbow.png -------------------------------------------------------------------------------- /images/comparison.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/370417/fancyground/HEAD/images/comparison.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **/node_modules/ 2 | 3 | # output from tsc 4 | js/ 5 | 6 | # output from rollup 7 | bundled/ 8 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "noImplicitAny": true, 4 | "lib": ["ES2018", "DOM"], 5 | "outDir": "js", 6 | "moduleResolution": "node", 7 | "module": "es6", 8 | "target": "ES5" 9 | }, 10 | "include": ["src/"] 11 | } 12 | -------------------------------------------------------------------------------- /src/render/common.ts: -------------------------------------------------------------------------------- 1 | export function keyToXY(key: string, flip: boolean): { x: number, y: number } { 2 | const xy = { 3 | x: 'abcdefgh'.indexOf(key[0]), 4 | y: '87654321'.indexOf(key[1]), 5 | }; 6 | if (flip) { 7 | xy.x = 7 - xy.x; 8 | xy.y = 7 - xy.y; 9 | } 10 | return xy; 11 | } 12 | -------------------------------------------------------------------------------- /src/message.ts: -------------------------------------------------------------------------------- 1 | import { ColorName, Shape } from './defaults'; 2 | 3 | export type Message = { 4 | property: 'color', 5 | colorName: ColorName, 6 | color: string, 7 | } | { 8 | property: 'opacity', 9 | shape: Shape, 10 | // We model opacity as a string instead of a number because we don't need 11 | // to manipulate it. To us, it's just an arbitrary css value. 12 | opacity: string, 13 | }; 14 | -------------------------------------------------------------------------------- /static/index.css: -------------------------------------------------------------------------------- 1 | cg-container cg-board svg { 2 | position: absolute; 3 | z-index: 3; 4 | } 5 | 6 | cg-container .cg-shapes circle, 7 | cg-container .cg-shapes line { 8 | display: none; 9 | } 10 | 11 | cg-board svg.fancyground-arrows { 12 | width: 100%; 13 | height: 100%; 14 | pointer-events: none; 15 | } 16 | 17 | highlight { 18 | position: absolute; 19 | top: 0; 20 | left: 0; 21 | width: 12.5%; 22 | height: 12.5%; 23 | z-index: 0; 24 | will-change: transform; 25 | pointer-events: none; 26 | } 27 | -------------------------------------------------------------------------------- /rollup.config.js: -------------------------------------------------------------------------------- 1 | import commonjs from '@rollup/plugin-commonjs'; 2 | import { nodeResolve } from '@rollup/plugin-node-resolve'; 3 | 4 | export default [ 5 | { 6 | input: 'js/index.js', 7 | output: { 8 | file: 'bundled/index.js', 9 | format: 'iife', 10 | }, 11 | plugins: [commonjs(), nodeResolve()], 12 | }, 13 | { 14 | input: 'js/options.js', 15 | output: { 16 | file: 'bundled/options.js', 17 | format: 'iife', 18 | }, 19 | plugins: [commonjs(), nodeResolve()], 20 | }, 21 | ]; 22 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es2021": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:@typescript-eslint/recommended" 9 | ], 10 | "parser": "@typescript-eslint/parser", 11 | "parserOptions": { 12 | "ecmaVersion": 12, 13 | "sourceType": "module" 14 | }, 15 | "plugins": [ 16 | "@typescript-eslint" 17 | ], 18 | "rules": { 19 | "indent": [ 20 | "error", 21 | 4 22 | ], 23 | "linebreak-style": [ 24 | "error", 25 | "unix" 26 | ], 27 | "quotes": [ 28 | "error", 29 | "single" 30 | ], 31 | "semi": [ 32 | "error", 33 | "always" 34 | ] 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/defaults.ts: -------------------------------------------------------------------------------- 1 | export type Num = 1 | 2 | 3 | 4; 2 | export type Shape = 'square' | 'arrow'; 3 | 4 | export type ColorName = `${Shape}_color_${Num}`; 5 | 6 | export type Defaults = { 7 | [name in ColorName]: string; 8 | } & { 9 | [K in Shape]: string; 10 | }; 11 | 12 | export const defaults: Defaults = { 13 | arrow_color_1: '#15781B', // green 14 | arrow_color_2: '#C60B0B', // red 15 | arrow_color_3: '#0080C6', // blue 16 | arrow_color_4: '#FFC20E', // yellow 17 | square_color_1: '#E69000', 18 | square_color_2: '#003088', 19 | square_color_3: '#990018', 20 | square_color_4: '#125740', 21 | arrow: '0.85', 22 | square: '0.65', 23 | }; 24 | 25 | export const lichessColors = [ 26 | 'green', 27 | 'red', 28 | 'blue', 29 | 'yellow', 30 | ]; 31 | 32 | export function getColorNum(lichessColor: string): Num | 0 { 33 | const i = lichessColors.indexOf(lichessColor); 34 | return (i + 1) as Num; 35 | } 36 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fancyground", 3 | "version": "1.2.0", 4 | "description": "Custom arrows and square highlights for lichess.org.", 5 | "keywords": [ 6 | "chess", 7 | "lichess" 8 | ], 9 | "browser": "index.ts", 10 | "scripts": { 11 | "build": "tsc; rollup -c; rm -r js", 12 | "madge": "madge --extensions ts --image src/dependency-graph.svg src" 13 | }, 14 | "author": "Albert Ford ", 15 | "license": "GPL-3.0-or-later", 16 | "repository": "github:370417/fancyground", 17 | "dependencies": { 18 | "webextension-polyfill-ts": "^0.26.0" 19 | }, 20 | "devDependencies": { 21 | "@rollup/plugin-commonjs": "^19.0.1", 22 | "@rollup/plugin-node-resolve": "^13.0.2", 23 | "@typescript-eslint/eslint-plugin": "^4.28.4", 24 | "@typescript-eslint/parser": "^4.28.4", 25 | "eslint": "^7.31.0", 26 | "madge": "^5.0.1", 27 | "rollup": "^2.53.2", 28 | "typescript": "^4.3.5" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "manifest_version": 2, 3 | "name": "Fancyground", 4 | "version": "1.2.0", 5 | "description": "Custom arrows and square highlights for lichess.org.", 6 | "author": "Albert Ford", 7 | "homepage_url": "https://github.com/370417/fancyground", 8 | "permissions": ["storage"], 9 | "icons": { 10 | "48": "icons/icon@48.png", 11 | "128": "icons/icon@128.png" 12 | }, 13 | "content_scripts": [ 14 | { 15 | "matches": ["https://lichess.org/*"], 16 | "js": ["bundled/index.js"], 17 | "css": ["static/index.css"] 18 | } 19 | ], 20 | "browser_specific_settings": { 21 | "gecko": { 22 | "id": "fancyground@albertford.com" 23 | } 24 | }, 25 | "options_ui": { 26 | "page": "static/options.html" 27 | }, 28 | "page_action": { 29 | "default_icon": "icons/icon@48.png", 30 | "default_popup": "static/options.html", 31 | "default_title": "Fancyground", 32 | "show_matches": ["https://lichess.org/*"] 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/state.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Hold state in memory for content scripts. 3 | * Options pages should not use this module. 4 | */ 5 | 6 | import { ColorName, Defaults, defaults, Num, Shape } from './defaults'; 7 | 8 | const state = defaults; 9 | 10 | export function initState(newState: Defaults): void { 11 | for (const colorName in defaults) { 12 | state[colorName as ColorName] = newState[colorName as ColorName]; 13 | } 14 | state.arrow = newState.arrow; 15 | state.square = newState.square; 16 | } 17 | 18 | // Get the custom color that corresponds to the normal shape color on lichess 19 | export function getColor(shape: Shape, colorNum: Num | 0): string { 20 | if (colorNum === 0) return '#4a4a4a'; // for gray arrows in analysis 21 | const colorName: ColorName = `${shape}_color_${colorNum}`; 22 | return state[colorName]; 23 | } 24 | 25 | export function getOpacity(shape: Shape): string { 26 | return state[shape]; 27 | } 28 | 29 | // Only updates the colors in memory. 30 | // Updating stored colors should be done elsewhere. 31 | export function setColor(shape: Shape, colorNum: Num, color: string): void { 32 | const colorName: ColorName = `${shape}_color_${colorNum}`; 33 | state[colorName] = color; 34 | } 35 | 36 | export function setOpacity(shape: Shape, opacity: string): void { 37 | state[shape] = opacity; 38 | } 39 | -------------------------------------------------------------------------------- /static/options.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 |
10 | 11 |
12 |
13 | 19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Fancyground logo](images/promo.png) 2 | 3 | Fancyground is a browser extension that changes the appearance of arrows and circles on [lichess.org](https://lichess.org/). 4 | 5 | - Highlight entire squares instead of drawing circles 6 | - Customize arrow and highlight colors 7 | - Arrows no longer cover the pieces that they originate from 8 | 9 | Fancyground is available at the **[Chome web store](https://chrome.google.com/webstore/detail/fancyground/emmjdpamcocnkljijkbdlihffabahgjd)** or at **[Firefox add-ons](https://addons.mozilla.org/en-US/firefox/addon/fancyground/)**. 10 | 11 | [Demo of it in action](https://i.imgur.com/XgDqV19.mp4) 12 | 13 | Stock Lichess on the left, Fancyground on the right: 14 | 15 | ![Fancyground vs stock Lichess comparison](images/comparison.png) 16 | 17 | ## Drawing arrows with different colors 18 | 19 | On Lichess, right click and drag to draw arrows. 20 | Hold shift and/or alt as you draw to change the arrow's color. 21 | Right click in place to highlight squares. 22 | 23 | With Firefox, use control instead of shift 24 | because shift right click forces the context menu to appear. 25 | 26 | ## Building 27 | 28 | ```bash 29 | npm install 30 | npm run build 31 | ``` 32 | 33 | Generated javascript will be in the `bundled/` folder. 34 | HTML and CSS is in `static/`. 35 | 36 | Versions used: 37 | - npm: 7.4.3 38 | - node: v15.7.0 39 | 40 | Optional: Madge (generating the module dependency graph) requires graphviz. 41 | 42 | ### Zipping 43 | 44 | The chrome branch strips Firefox-specific features from the manifest and uses manifest version 3 instead of 2. 45 | To package the extension, run the following command: 46 | 47 | ```bash 48 | zip -r -X -FS "fancyground.zip" bundled static icons manifest.json -x "*.DS_Store" 49 | ``` 50 | 51 | `-x .DS_Store` exists to deal with macOS's hidden files. 52 | 53 | ## License 54 | 55 | The source code for Fancyground is licensed under [GNU GPLv3](LICENSE.txt) or any later version. 56 | 57 | The Fancyground icon is licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/). It uses maestro chess pieces made by sadsnake1. 58 | 59 | The font used in the logo is Crimson Pro licenced under OFL-1.1. That doesn't require attribution, but it's getting some anyway. 60 | -------------------------------------------------------------------------------- /static/options.css: -------------------------------------------------------------------------------- 1 | body { 2 | --swatch: 22px; 3 | --gutter: 17px; 4 | --soft-border: #0003; 5 | --hard-border: #000; 6 | --inner-glow: #fffc; 7 | --soft-bg: #eee; 8 | --bg: #fff; 9 | --fg: #111; 10 | background: var(--soft-bg); 11 | width: calc(8 * var(--swatch) + 9 * var(--gutter)); 12 | margin: 0; 13 | /* default is display: flex for some reason */ 14 | display: block; 15 | } 16 | 17 | @media (prefers-color-scheme: dark) { 18 | body { 19 | --soft-border: #fff5; 20 | --hard-border: #fff9; 21 | --inner-glow: #000a; 22 | --soft-bg: #1c1c1c; 23 | --bg: #2a2a2a; 24 | --fg: #ccc; 25 | } 26 | } 27 | 28 | .row { 29 | display: flex; 30 | margin: var(--gutter) 0; 31 | } 32 | 33 | #canvas-wrapper { 34 | position: relative; 35 | margin: 0 var(--gutter); 36 | } 37 | 38 | #canvas-wrapper::after { 39 | content: ''; 40 | box-shadow: inset 0 0 0 1px var(--soft-border); 41 | position: absolute; 42 | top: 0; 43 | left: 0; 44 | right: 0; 45 | bottom: 0; 46 | } 47 | 48 | canvas { 49 | display: block; 50 | } 51 | 52 | #thumb { 53 | position: absolute; 54 | top: 0; 55 | left: 0; 56 | width: 12px; 57 | height: 12px; 58 | border: 1px solid #000; 59 | border-radius: 50%; 60 | transform: translate(-7px, -7px); 61 | z-index: 1; 62 | } 63 | 64 | #slider { 65 | display: block; 66 | width: var(--swatch); 67 | height: 256px; 68 | background: url('./rainbow.png'); 69 | position: relative; 70 | box-shadow: inset 0 0 0 1px var(--soft-border); 71 | } 72 | 73 | #slider path { 74 | fill: var(--fg); 75 | } 76 | 77 | #slider svg { 78 | position: absolute; 79 | left: calc((var(--swatch) - 48px) / 2); 80 | top: -12px; 81 | } 82 | 83 | #swatches div { 84 | width: var(--swatch); 85 | height: var(--swatch); 86 | margin-left: var(--gutter); 87 | box-sizing: border-box; 88 | } 89 | 90 | #swatches div:hover { 91 | border: 1px solid var(--hard-border); 92 | } 93 | 94 | #swatches div.active { 95 | border: 1px solid var(--hard-border); 96 | box-shadow: inset 0 0 0 1px var(--inner-glow); 97 | } 98 | 99 | input { 100 | box-sizing: border-box; 101 | height: var(--swatch); 102 | border: 1px solid var(--soft-border); 103 | background: var(--bg); 104 | color: var(--fg); 105 | padding: 0 5px; 106 | margin: 0 0 0 var(--gutter); 107 | font-size: 14px; 108 | line-height: normal; 109 | } 110 | 111 | #color-input { 112 | width: calc(6 * var(--swatch) + 5 * var(--gutter)); 113 | } 114 | 115 | #opacity-input { 116 | width: calc(2 * var(--swatch) + var(--gutter)); 117 | } 118 | -------------------------------------------------------------------------------- /src/options/swatches.ts: -------------------------------------------------------------------------------- 1 | import { ColorName, defaults, Shape } from '../defaults'; 2 | 3 | export class Swatches { 4 | private readonly container: HTMLElement; 5 | private originalColors = new Map(); 6 | private opacities = new Map(); 7 | private _activeColorName: ColorName = 'arrow_color_1'; 8 | 9 | /** 10 | * colorRgb is the new color's value in string rgb form. 11 | * originalColor is the same color but in it's original string form. 12 | */ 13 | onSwitchActiveColor: (colorRgb: string, originalColor: string, opacity: string) => void; 14 | 15 | constructor(container: HTMLElement) { 16 | this.container = container; 17 | 18 | for (let i = 0; i < this.container.children.length; i++) { 19 | const swatch = this.container.children[i] as HTMLElement; 20 | swatch.addEventListener('click', () => { 21 | this.switchActiveColor(swatch.dataset.name as ColorName, true); 22 | }); 23 | } 24 | } 25 | 26 | get activeColorName(): ColorName { 27 | return this._activeColorName; 28 | } 29 | 30 | get activeShape(): Shape { 31 | if (this._activeColorName.startsWith('square')) return 'square'; 32 | else return 'arrow'; 33 | } 34 | 35 | setColorsAndOpacities(state: { [s: string]: string }): void { 36 | for (let i = 0; i < this.container.children.length; i++) { 37 | const swatch = this.container.children[i] as HTMLElement; 38 | const color = state[swatch.dataset.name]; 39 | swatch.style.background = color; 40 | this.originalColors.set(swatch.dataset.name as ColorName, color); 41 | } 42 | this.opacities.set('square', state.square); 43 | this.opacities.set('arrow', state.arrow); 44 | } 45 | 46 | /** Set the value of the active color. It can be empty string to set the default color */ 47 | setColor(color: string): void { 48 | const activeSwatches = this.container.getElementsByClassName('active'); 49 | if (activeSwatches.length !== 1) return; 50 | const swatch = activeSwatches[0] as HTMLElement; 51 | this.originalColors.set(this._activeColorName, color); 52 | swatch.style.background = color || defaults[this._activeColorName]; 53 | } 54 | 55 | setOpacity(opacity: string): void { 56 | this.opacities.set(this.activeShape, opacity); 57 | } 58 | 59 | /** Change which color is the active color */ 60 | switchActiveColor(colorName: ColorName, propagate?: true): void { 61 | this._activeColorName = colorName; 62 | let activeColorRgb: string | undefined; 63 | for (let i = 0; i < this.container.children.length; i++) { 64 | const swatch = this.container.children[i] as HTMLElement; 65 | if (swatch.dataset.name === colorName) { 66 | swatch.classList.add('active'); 67 | activeColorRgb = getComputedStyle(swatch).backgroundColor; 68 | } else { 69 | swatch.classList.remove('active'); 70 | } 71 | } 72 | if (this.onSwitchActiveColor && propagate && activeColorRgb) { 73 | this.onSwitchActiveColor( 74 | activeColorRgb, 75 | this.originalColors.get(colorName), 76 | this.opacities.get(this.activeShape), 77 | ); 78 | } 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /src/render/highlights/render.ts: -------------------------------------------------------------------------------- 1 | import { getColorNum, Num } from '../../defaults'; 2 | import { getColor, getOpacity } from '../../state'; 3 | import { keyToXY } from '../common'; 4 | 5 | export function updateHighlights(shapes: Element, board: Element): void { 6 | const highlightContainer = board.querySelector('div.fancyground-highlights') || createNewHighlightContainer(board); 7 | highlightContainer.innerHTML = ''; 8 | const circles = shapes.querySelectorAll('g[cgHash]'); // also includes arrows which later get filtered out 9 | const flip = !!board.closest('.orientation-black'); 10 | for (let i = 0; i < circles.length; i++) { 11 | const circleElement = circles[i].firstElementChild; 12 | if (!circleElement || circleElement.tagName.toUpperCase() != 'CIRCLE') continue; 13 | const cgHash = circles[i].getAttribute('cgHash'); 14 | // cgHash format for circles is number,number,square,color 15 | // where square is algebraic like e4 16 | // and color is yellow, red, blue, or green 17 | // Except for circles which are actively being pressed down, in which case the 18 | // format presumably is number,number,true,square,color 19 | const cgHashParts = cgHash.split(',').filter(val => val != 'true'); 20 | // Filter out arrows (which should have a length of 5) 21 | if (cgHashParts.length != 4) continue; 22 | const key = cgHashParts[2]; 23 | const color = cgHashParts[3]; 24 | const translucent = circleElement.getAttribute('opacity') !== '1'; 25 | createHighlight(key, highlightContainer, flip, color, translucent); 26 | } 27 | } 28 | 29 | export function updateHighlightColor(board: Element, colorNum: Num, newColor: string): void { 30 | const highlights = board.getElementsByTagName('highlight'); 31 | for (let i = 0; i < highlights.length; i++) { 32 | const highlight = highlights[i] as HTMLElement; 33 | if (highlight.dataset.colorNum === `${colorNum}`) { 34 | highlight.style.background = newColor; 35 | } 36 | } 37 | } 38 | 39 | export function updateHighlightColorAll(board: Element): void { 40 | const highlights = board.getElementsByTagName('highlight'); 41 | for (let i = 0; i < highlights.length; i++) { 42 | const highlight = highlights[i] as HTMLElement; 43 | const colorNum = Number(highlight.dataset.colorNum) as Num; 44 | highlight.style.background = getColor('square', colorNum); 45 | } 46 | } 47 | 48 | export function updateHighlightOpacity(board: Element): void { 49 | const containers = board.getElementsByClassName('fancyground-highlights'); 50 | if (containers.length === 0) return; 51 | const container = containers[0] as HTMLElement; 52 | container.style.opacity = getOpacity('square'); 53 | } 54 | 55 | function createNewHighlightContainer(board: Element): HTMLDivElement { 56 | const div = document.createElement('div'); 57 | div.classList.add('fancyground-highlights'); 58 | div.style.opacity = getOpacity('square'); 59 | board.insertAdjacentElement('beforeend', div); 60 | return div; 61 | } 62 | 63 | function createHighlight(key: string, board: Element, flip: boolean, lichessColor: string, translucent: boolean): HTMLElement { 64 | const highlight = document.createElement('highlight'); 65 | const colorNum = getColorNum(lichessColor); 66 | const color = getColor('square', colorNum); 67 | let opacity = '1'; 68 | if (translucent) opacity = '0.25'; 69 | highlight.dataset.colorNum = `${colorNum}`; 70 | highlight.style.background = color; 71 | highlight.style.opacity = opacity; 72 | highlight.style.transform = createTransform(key, flip); 73 | board.insertAdjacentElement('beforeend', highlight); 74 | return highlight; 75 | } 76 | 77 | function createTransform(key: string, flip: boolean): string { 78 | const { x, y } = keyToXY(key, flip); 79 | return `translate(${100 * x}%,${100 * y}%)`; 80 | } 81 | -------------------------------------------------------------------------------- /src/options.ts: -------------------------------------------------------------------------------- 1 | import { browser, Runtime } from 'webextension-polyfill-ts'; 2 | import { Picker } from './options/color-picker'; 3 | import { defaults, ColorName, Shape } from './defaults'; 4 | import { Message } from './message'; 5 | import { Swatches } from './options/swatches'; 6 | 7 | let port: Runtime.Port | undefined; 8 | 9 | function saveColor(colorName: ColorName, color: string) { 10 | browser.storage.sync.set({ 11 | [colorName]: color, 12 | }).catch(console.error); 13 | } 14 | 15 | function saveOpacity(shape: Shape, opacity: string) { 16 | browser.storage.sync.set({ 17 | [shape]: opacity, 18 | }).catch(console.error); 19 | } 20 | 21 | // Send updated color info to content scripts. 22 | // This is separate from saveColor because we want to call it more often. 23 | // We call sendColor on mousemove and we only call saveColor on mouseup. 24 | function sendColor(colorName: ColorName, color: string) { 25 | const message: Message = { property: 'color', color, colorName }; 26 | port?.postMessage(message); 27 | } 28 | 29 | function sendOpacity(shape: Shape, opacity: string) { 30 | const message: Message = { property: 'opacity', shape, opacity }; 31 | port?.postMessage(message); 32 | } 33 | 34 | const colorInput = document.getElementById('color-input') as HTMLInputElement; 35 | const opacityInput = document.getElementById('opacity-input') as HTMLInputElement; 36 | 37 | colorInput.addEventListener('input', function() { 38 | const color = this.value || defaults[swatches.activeColorName]; 39 | if (CSS.supports('color', color)) { 40 | sendColor(swatches.activeColorName, color); 41 | saveColor(swatches.activeColorName, color); 42 | // easy way to rerender swatch and picker 43 | swatches.setColor(this.value); 44 | swatches.switchActiveColor(swatches.activeColorName, true); 45 | } 46 | }); 47 | 48 | opacityInput.addEventListener('input', function() { 49 | const shape = swatches.activeShape; 50 | const opacity = this.value || defaults[shape]; 51 | if (CSS.supports('opacity', opacity)) { 52 | sendOpacity(shape, opacity); 53 | saveOpacity(shape, opacity); 54 | swatches.setOpacity(opacity); 55 | } 56 | }); 57 | 58 | restoreState(); 59 | 60 | // Start sending updates to the current tab 61 | browser.tabs.query({ 62 | active: true, 63 | currentWindow: true, 64 | }).then(tabs => { 65 | if (tabs.length === 0) return; 66 | // This will throw an exception in Chrome if the tab isn't lichess.org 67 | // and can't respond to the connection. 68 | // It's async, so try catch doesn't help. Checking the tab url would 69 | // help, but I don't want to request the permimssion. I'd rather throw 70 | // the exception. 71 | port = browser.tabs.connect(tabs[0].id); 72 | port.onDisconnect.addListener(() => port = undefined); 73 | }, console.error); 74 | 75 | const picker = new Picker( 76 | document.getElementsByTagName('canvas')[0], 77 | document.getElementById('thumb'), 78 | document.getElementById('slider'), 79 | document.querySelector('#slider svg'), 80 | ); 81 | 82 | const swatches = new Swatches( 83 | document.getElementById('swatches'), 84 | ); 85 | 86 | picker.onRender = color => { 87 | swatches.setColor(color); 88 | sendColor(swatches.activeColorName, color); 89 | colorInput.value = color; 90 | }; 91 | 92 | picker.saveColor = color => { 93 | saveColor(swatches.activeColorName, color); 94 | }; 95 | 96 | swatches.onSwitchActiveColor = (colorRgb: string, originalColor: string, opacity: string) => { 97 | picker.setColorRgbStr(colorRgb); 98 | colorInput.value = originalColor; 99 | colorInput.placeholder = defaults[swatches.activeColorName]; 100 | opacityInput.value = opacity; 101 | opacityInput.placeholder = defaults[swatches.activeShape]; 102 | }; 103 | 104 | function restoreState() { 105 | browser.storage.sync.get(defaults).then(state => { 106 | swatches.setColorsAndOpacities(state); 107 | swatches.switchActiveColor('arrow_color_1', true); 108 | colorInput.value = state[swatches.activeColorName]; 109 | opacityInput.value = state[swatches.activeShape]; 110 | }, console.error); 111 | } 112 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { browser, Runtime } from 'webextension-polyfill-ts'; 2 | import { Defaults, defaults, Num } from './defaults'; 3 | import { Message } from './message'; 4 | import { updateArrowColor, updateArrowColorAll, updateArrowOpacity, updateArrows } from './render/arrows/render'; 5 | import { updateHighlightColor, updateHighlightColorAll, updateHighlightOpacity, updateHighlights } from './render/highlights/render'; 6 | import { initState, setColor, setOpacity } from './state'; 7 | 8 | // Init colors 9 | browser.storage.sync.get(defaults).then(initState, console.error); 10 | 11 | // Keep track of already-found chessground elements 12 | // without leaking memory (hopefully) 13 | const chessgrounds = new WeakSet(); 14 | 15 | // Rememeber, this is a live collection. 16 | const cgContainers = document.body.getElementsByTagName('cg-container'); 17 | 18 | function findNewChessgrounds() { 19 | for (let i = 0; i < cgContainers.length; i++) { 20 | const cgContainer = cgContainers[i]; 21 | if (!chessgrounds.has(cgContainer)) { 22 | chessgrounds.add(cgContainer); 23 | watchChessground(cgContainer); 24 | } 25 | } 26 | } 27 | 28 | new MutationObserver(findNewChessgrounds).observe(document.body, { 29 | childList: true, 30 | subtree: true, 31 | }); 32 | 33 | function shapeCallback( 34 | shapes: Element, 35 | board: Element, 36 | prefix: string, 37 | listener: PortListener, 38 | openPorts: Set, 39 | ): MutationCallback { 40 | return (_, observer) => { 41 | if (!document.body.contains(board)) { 42 | observer.disconnect(); 43 | openPorts.forEach(port => port.onMessage.removeListener(listener)); 44 | openPorts.clear(); 45 | return; 46 | } 47 | updateHighlights(shapes, board); 48 | updateArrows(shapes, board, prefix); 49 | }; 50 | } 51 | 52 | let uniqueCounter = 0; 53 | 54 | function watchChessground(cgContainer: Element) { 55 | // create a unique prefix to avoid conflicts between multiple chessgrounds 56 | const prefix = `board${uniqueCounter}_`; 57 | uniqueCounter += 1; 58 | 59 | const shapes = cgContainer.getElementsByClassName('cg-shapes'); 60 | const board = cgContainer.getElementsByTagName('cg-board'); 61 | if (!shapes.length || !board.length) return; 62 | 63 | const openPorts = new Set(); 64 | 65 | const listener = portListener(board[0]); 66 | const callback = shapeCallback(shapes[0], board[0], prefix, listener, openPorts); 67 | 68 | browser.runtime.onConnect.addListener(port => { 69 | port.onMessage.addListener(listener); 70 | openPorts.add(port); 71 | port.onDisconnect.addListener(port => { 72 | port.onMessage.removeListener(listener); 73 | openPorts.delete(port); 74 | }); 75 | }); 76 | 77 | const observer = new MutationObserver(callback); 78 | observer.observe(shapes[0], { 79 | childList: true, 80 | subtree: true, 81 | }); 82 | callback([], observer); 83 | } 84 | 85 | type PortListener = (message: Message) => void; 86 | 87 | // Listen to color changes from options.html 88 | function portListener(board: Element): PortListener { 89 | return (message: Message) => { 90 | if (message.property === 'opacity') { 91 | setOpacity(message.shape, message.opacity); 92 | if (message.shape === 'square') { 93 | updateHighlightOpacity(board); 94 | } else { 95 | updateArrowOpacity(board); 96 | } 97 | } else if (message.colorName.startsWith('square')) { 98 | const colorNum = Number(message.colorName.slice(-1)) as Num; 99 | setColor('square', colorNum, message.color); 100 | updateHighlightColor(board, colorNum, message.color); 101 | } else if (message.colorName.startsWith('arrow')) { 102 | const colorNum = Number(message.colorName.slice(-1)) as Num; 103 | setColor('arrow', colorNum, message.color); 104 | updateArrowColor(board, colorNum, message.color); 105 | } 106 | }; 107 | } 108 | 109 | const boards = document.body.getElementsByTagName('cg-board'); 110 | 111 | // Refresh colors on window focus in case colors have changed while this 112 | // page was in the background. 113 | window.addEventListener('focus', () => { 114 | browser.storage.sync.get(defaults).then(newColors => { 115 | initState(newColors as Defaults); 116 | for (let i = 0; i < boards.length; i++) { 117 | updateHighlightColorAll(boards[i]); 118 | updateArrowColorAll(boards[i]); 119 | updateHighlightOpacity(boards[i]); 120 | updateArrowOpacity(boards[i]); 121 | } 122 | }, console.error); 123 | }); 124 | -------------------------------------------------------------------------------- /src/render/arrows/defs/render.ts: -------------------------------------------------------------------------------- 1 | import { lichessColors, Num } from '../../../defaults'; 2 | import { getColor } from '../../../state'; 3 | import { keyToXY } from '../../common'; 4 | 5 | export function createDefs(prefix: string): SVGDefsElement { 6 | const defs = document.createElementNS('http://www.w3.org/2000/svg', 'defs'); 7 | for (let num = 0; num <= lichessColors.length; num++) { 8 | const marker = createMarker(num as Num | 0, prefix); 9 | defs.insertAdjacentElement('beforeend', marker); 10 | } 11 | return defs; 12 | } 13 | 14 | export function capId(prefix: string, colorNum: Num | 0): string { 15 | return `${prefix}arrowhead${colorNum}`; 16 | } 17 | 18 | export function getCap(prefix: string, colorNum: Num | 0): string { 19 | return `url(#${capId(prefix, colorNum)})`; 20 | } 21 | 22 | function createMarker(colorNum: Num | 0, prefix: string): SVGMarkerElement { 23 | const path = document.createElementNS('http://www.w3.org/2000/svg', 'path'); 24 | path.setAttributeNS(null, 'd', 'M0,0 V4 L3,2 Z'); 25 | path.setAttributeNS(null, 'fill', getColor('arrow', colorNum)); 26 | path.dataset.colorNum = `${colorNum}`; 27 | 28 | const marker = document.createElementNS('http://www.w3.org/2000/svg', 'marker'); 29 | marker.setAttributeNS(null, 'id', capId(prefix, colorNum)); 30 | marker.setAttributeNS(null, 'orient', 'auto'); 31 | marker.setAttributeNS(null, 'markerWidth', '4'); 32 | marker.setAttributeNS(null, 'markerHeight', '8'); 33 | marker.setAttributeNS(null, 'refX', '2.05'); 34 | marker.setAttributeNS(null, 'refY', '2.01'); 35 | marker.insertAdjacentElement('beforeend', path); 36 | 37 | return marker; 38 | } 39 | 40 | /// Returns the id of the mask if there is a piece to make a mask out of 41 | export function createMask(key: string, flip: boolean, prefix: string, board: Element, defs: SVGDefsElement): string { 42 | const imageUrl = getPieceImageUrl(key, flip, board); 43 | if (!imageUrl) return; 44 | defs.insertAdjacentElement('afterbegin', createFilter(prefix)); 45 | const mask = document.createElementNS('http://www.w3.org/2000/svg', 'mask'); 46 | mask.setAttributeNS(null, 'maskUnits', 'userSpaceOnUse'); 47 | mask.setAttributeNS(null, 'x', '-0.5'); 48 | mask.setAttributeNS(null, 'y', '-0.5'); 49 | mask.setAttributeNS(null, 'width', '8'); 50 | mask.setAttributeNS(null, 'height', '8'); 51 | mask.id = prefix + key; 52 | mask.insertAdjacentElement('beforeend', createGround()); 53 | mask.insertAdjacentElement('beforeend', createImage(imageUrl, key, flip, prefix)); 54 | defs.insertAdjacentElement('afterbegin', mask); 55 | return prefix + key; 56 | } 57 | 58 | /// Make sure to strip the url('...') because this is going into href="...", not into mask="...". 59 | function getPieceImageUrl(key: string, flip: boolean, board: Element): string | undefined { 60 | const width = board.getBoundingClientRect().width; 61 | const piece: HTMLElement = board.querySelector(`piece[style="${createPxTransformChrome(key, flip, width)}"]`) 62 | || board.querySelector(`piece[style="${createPxTransformFirefox(key, flip, width)}"]`); 63 | if (!piece) return; 64 | const backgroundImage = getComputedStyle(piece).backgroundImage; 65 | const split = backgroundImage.split(/['"]/g); 66 | if (split.length < 2) return; 67 | return split[1]; 68 | } 69 | 70 | const toBlackMatrix = ` 71 | 0 0 0 0 0 72 | 0 0 0 0 0 73 | 0 0 0 0 0 74 | 0 0 0 1 0`; 75 | 76 | /// Filter piece images so they are all black 77 | function createFilter(prefix: string): SVGFilterElement { 78 | const filter = document.createElementNS('http://www.w3.org/2000/svg', 'filter'); 79 | filter.setAttributeNS(null, 'id', prefix + 'toBlack'); 80 | const matrixFilter = document.createElementNS('http://www.w3.org/2000/svg', 'feColorMatrix'); 81 | matrixFilter.setAttributeNS(null, 'values', toBlackMatrix); 82 | matrixFilter.setAttributeNS(null, 'type', 'matrix'); 83 | filter.insertAdjacentElement('beforeend', matrixFilter); 84 | return filter; 85 | } 86 | 87 | /// To make a mask that shows everything except a piece, we need a white backdrop 88 | /// that covers the entire viewport 89 | function createGround(): SVGRectElement { 90 | const ground = document.createElementNS('http://www.w3.org/2000/svg', 'rect'); 91 | ground.setAttributeNS(null, 'fill', '#fff'); 92 | ground.setAttributeNS(null, 'x', '-0.5'); 93 | ground.setAttributeNS(null, 'y', '-0.5'); 94 | ground.setAttributeNS(null, 'width', '8'); 95 | ground.setAttributeNS(null, 'height', '8'); 96 | return ground; 97 | } 98 | 99 | function createImage(url: string, key: string, flip: boolean, prefix: string): SVGImageElement { 100 | const { x, y } = keyToXY(key, flip); 101 | const image = document.createElementNS('http://www.w3.org/2000/svg', 'image'); 102 | image.setAttributeNS(null, 'href', url); 103 | image.setAttributeNS(null, 'width', '1'); 104 | image.setAttributeNS(null, 'height', '1'); 105 | image.setAttributeNS(null, 'filter', `url(#${prefix}toBlack)`); 106 | // subtract 0.5 so that the corner of the image is in the corner and not 107 | // in the center of the square 108 | image.setAttributeNS(null, 'x', `${x - 0.5}`); 109 | image.setAttributeNS(null, 'y', `${y - 0.5}`); 110 | return image; 111 | } 112 | 113 | // Chrome always uses x and y coordinates even if y is 0. 114 | function createPxTransformChrome(key: string, flip: boolean, boardSize: number): string { 115 | let { x, y } = keyToXY(key, flip); 116 | x *= boardSize / 8; 117 | y *= boardSize / 8; 118 | return `transform: translate(${x}px, ${y}px);`; 119 | } 120 | 121 | // Firefox omits the y coordinate if it is 0. 122 | function createPxTransformFirefox(key: string, flip: boolean, boardSize: number): string { 123 | let { x, y } = keyToXY(key, flip); 124 | x *= boardSize / 8; 125 | y *= boardSize / 8; 126 | if (!y) return `transform: translate(${x}px);`; 127 | else return `transform: translate(${x}px, ${y}px);`; 128 | } 129 | -------------------------------------------------------------------------------- /src/render/arrows/render.ts: -------------------------------------------------------------------------------- 1 | import { getColorNum, Num } from '../../defaults'; 2 | import { getColor, getOpacity } from '../../state'; 3 | import { keyToXY } from '../common'; 4 | import { createDefs, createMask, getCap } from './defs/render'; 5 | 6 | export function updateArrows(shapes: Element, board: Element, prefix: string): void { 7 | const svg = board.querySelector('svg') || createNewSvg(board); 8 | svg.innerHTML = ''; 9 | svg.insertAdjacentElement('afterbegin', createDefs(prefix)); 10 | const arrows = shapes.querySelectorAll('g[cgHash]'); // also includes circles which later get filtered out 11 | const flip = !!board.closest('.orientation-black'); 12 | for (let i = 0; i < arrows.length; i++) { 13 | const arrowElement = arrows[i].firstElementChild; 14 | if (!arrowElement || arrowElement.tagName.toUpperCase() != 'LINE') continue; 15 | const cgHash = arrows[i].getAttribute('cgHash'); 16 | // cgHash format for arrows is number,number,square,square,color 17 | // where square is algebraic like e4 18 | // and color is yellow, red, blue, or green 19 | // Except for arrows which are actively being dragged, in which case the 20 | // format appears to be number,number,true,square,square,color 21 | // And, when multiple arrows are pointing to the same square, 22 | // cgHash has an additional ,- at the end 23 | const cgHashParts = cgHash.split(',').filter(val => val != 'true'); 24 | const uci = cgHashParts[2] + cgHashParts[3]; 25 | const colorNum = getColorNum(cgHashParts[4]); 26 | const coords = uciToCoords(uci, flip); 27 | const maskId = createMask(uci.slice(0, 2), flip, prefix, board, svg); 28 | const arrow = createArrow( 29 | shortenTip(coords), 30 | svg, 31 | getCap(prefix, colorNum), 32 | colorNum, 33 | arrowElement.getAttribute('opacity'), 34 | getArrowWidth(arrowElement), 35 | ); 36 | if (maskId) { 37 | arrow.setAttributeNS(null, 'mask', `url(#${maskId})`); 38 | } 39 | } 40 | } 41 | 42 | export function updateArrowColor(board: Element, colorNum: Num, newColor: string): void { 43 | const arrows = board.getElementsByTagNameNS('http://www.w3.org/2000/svg', 'line'); 44 | for (let i = 0; i < arrows.length; i++) { 45 | const arrow = arrows[i]; 46 | if (arrow.dataset.colorNum === `${colorNum}`) { 47 | arrow.setAttributeNS(null, 'stroke', newColor); 48 | } 49 | } 50 | // arrow heads 51 | const paths = board.getElementsByTagNameNS('http://www.w3.org/2000/svg', 'path'); 52 | for (let i = 0; i < paths.length; i++) { 53 | const path = paths[i]; 54 | if (path.dataset.colorNum === `${colorNum}`) { 55 | path.setAttributeNS(null, 'fill', newColor); 56 | } 57 | } 58 | } 59 | 60 | export function updateArrowColorAll(board: Element): void { 61 | const arrows = board.getElementsByTagNameNS('http://www.w3.org/2000/svg', 'line'); 62 | for (let i = 0; i < arrows.length; i++) { 63 | const arrow = arrows[i]; 64 | const colorNum = Number(arrow.dataset.colorNum) as Num; 65 | arrow.setAttributeNS(null, 'stroke', getColor('arrow', colorNum)); 66 | } 67 | // arrow heads 68 | const paths = board.getElementsByTagNameNS('http://www.w3.org/2000/svg', 'path'); 69 | for (let i = 0; i < paths.length; i++) { 70 | const path = paths[i]; 71 | const colorNum = Number(path.dataset.colorNum) as Num; 72 | path.setAttributeNS(null, 'fill', getColor('arrow', colorNum)); 73 | } 74 | } 75 | 76 | export function updateArrowOpacity(board: Element): void { 77 | const svgs = board.getElementsByTagName('svg'); 78 | if (svgs.length === 0) return; 79 | svgs[0].style.opacity = getOpacity('arrow'); 80 | } 81 | 82 | function getArrowWidth(arrow: Element): number | undefined { 83 | const widthStr = arrow.getAttribute('stroke-width'); 84 | if (!widthStr) return; 85 | const width = Number(widthStr); 86 | if (Number.isNaN(width)) return; 87 | // Unadjust chessground's current arrow effect 88 | else if (width === 0.1328125) return 0.15625; 89 | else return width; 90 | } 91 | 92 | function createNewSvg(board: Element): SVGSVGElement { 93 | const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg'); 94 | svg.classList.add('fancyground-arrows'); 95 | svg.setAttribute('viewBox', '-0.5 -0.5 8 8'); 96 | svg.style.opacity = getOpacity('arrow'); 97 | board.insertAdjacentElement('beforeend', svg); 98 | return svg; 99 | } 100 | 101 | function createArrow( 102 | coords: Coords, 103 | svg: Element, 104 | cap: string, 105 | colorNum: Num | 0, 106 | originalOpacity: string, 107 | width: number, 108 | ): SVGLineElement { 109 | const arrow = document.createElementNS('http://www.w3.org/2000/svg','line'); 110 | const color = getColor('arrow', colorNum); 111 | arrow.setAttributeNS(null, 'x1', `${coords.x1}`); 112 | arrow.setAttributeNS(null, 'y1', `${coords.y1}`); 113 | arrow.setAttributeNS(null, 'x2', `${coords.x2}`); 114 | arrow.setAttributeNS(null, 'y2', `${coords.y2}`); 115 | arrow.setAttributeNS(null, 'marker-end', cap); 116 | arrow.setAttributeNS(null, 'stroke', color); 117 | if (width) arrow.setAttributeNS(null, 'stroke-width', `${width}`); 118 | arrow.setAttributeNS(null, 'opacity', originalOpacity); 119 | arrow.dataset.colorNum = `${colorNum}`; 120 | svg.insertAdjacentElement('beforeend', arrow); 121 | return arrow; 122 | } 123 | 124 | type Coords = { 125 | x1: number; 126 | y1: number; 127 | x2: number; 128 | y2: number; 129 | }; 130 | 131 | function uciToCoords(uci: string, flip: boolean): Coords { 132 | const { 'x': x1, 'y': y1 } = keyToXY(uci, flip); 133 | const { 'x': x2, 'y': y2 } = keyToXY(uci.slice(2), flip); 134 | return { x1, y1, x2, y2 }; 135 | } 136 | 137 | /// Trim the tip of a coords object so that the arrow doesn't reach 138 | /// all the way to the center of the square. We do this so that multiple 139 | /// arrows pointing to the same square don't overlap in an ugly way. 140 | /// In regular chessground, the trim amount is half as much if an arrow 141 | /// points to a square that no other arrow points to. But here we choose 142 | /// to use this amount of trim for all arrows so that drawing new arrows 143 | /// can't shorten existing arrows. 144 | function shortenTip({ x1, y1, x2, y2 }: Coords): Coords { 145 | // Treat coords as a vector from tail to tip 146 | const dx = x2 - x1; 147 | const dy = y2 - y1; 148 | const magnitude = Math.sqrt(dx * dx + dy * dy); 149 | const scale = (magnitude - 160 / 512) / magnitude; 150 | return { 151 | x1, 152 | y1, 153 | x2: x1 + dx * scale, 154 | y2: y1 + dy * scale, 155 | }; 156 | } 157 | -------------------------------------------------------------------------------- /src/options/color-picker.ts: -------------------------------------------------------------------------------- 1 | type Hsv = { 2 | /** hue [0, 360] */ 3 | h: number; 4 | /** saturation [0, 1] */ 5 | s: number; 6 | /** value [0, 1] */ 7 | v: number; 8 | }; 9 | 10 | type Rgb = { 11 | /** red [0, 1] */ 12 | r: number; 13 | /** green [0, 1] */ 14 | g: number; 15 | /** blue [0, 1] */ 16 | b: number; 17 | } 18 | 19 | function hsvToRgb({ h, s, v}: Hsv): Rgb { 20 | // Adjust hue to ramp sinusoidally instead of linearly 21 | h /= 60; // [0, 6] 22 | const sextantHue = h % 1; 23 | h += sinEase(sextantHue) - sextantHue; 24 | 25 | // from https://en.wikipedia.org/wiki/HSL_and_HSV#HSV_to_RGB_alternative 26 | function f(n: 1 | 3 | 5) { 27 | const k = (n + h) % 6; 28 | return v - v * s * Math.max(0, Math.min(k, 4 - k, 1)); 29 | } 30 | 31 | return { 32 | r: f(5), 33 | g: f(3), 34 | b: f(1), 35 | }; 36 | } 37 | 38 | function rgbToHsv({ r, g, b }: Rgb): Hsv { 39 | const v = Math.max(r, g, b); 40 | const chroma = v - Math.min(r, g, b); 41 | let s = 0; 42 | if (v > 0) s = chroma / v; 43 | let h = hue({ r, g, b }, v, chroma); 44 | const sextantHue = h % 1; 45 | h += invSinEase(sextantHue) - sextantHue; 46 | h *= 60; 47 | return { h, s, v }; 48 | } 49 | 50 | // Returned hue is in the range [0, 6] 51 | function hue({ r, g, b }: Rgb, v: number, chroma: number): number { 52 | let h = 0; 53 | if (chroma === 0) h = 0; 54 | else if (v === r) h = (g - b) / chroma; 55 | else if (v === g) h = 2 + (b - r) / chroma; 56 | // else v === b 57 | else if (v === b) h = 4 + (r - g) / chroma; 58 | // h can be slightly too small/large here 59 | h = (h + 6) % 6; 60 | return h; 61 | } 62 | 63 | // Input and output both range in [0, 1] 64 | function sinEase(n: number): number { 65 | return 0.5 - Math.cos(n * Math.PI) / 2; 66 | } 67 | 68 | // Input and output both range in [0, 1] 69 | function invSinEase(n: number): number { 70 | return Math.acos(1 - 2 * n) / Math.PI; 71 | } 72 | 73 | const size = 256; 74 | const buffer = new ArrayBuffer(size * size * 4); 75 | 76 | function renderSlice(hue: number, ctx: CanvasRenderingContext2D): void { 77 | const pixels = new Int32Array(buffer); 78 | 79 | for (let row = 0; row < size; row++) { 80 | for (let col = 0; col < size; col++) { 81 | const index = row * size + col; 82 | const hsv = { 83 | h: hue, 84 | s: col / (size - 1), 85 | v: 1 - row / (size - 1), 86 | }; 87 | const rgb = hsvToRgb(hsv); 88 | pixels[index] = packRgba(rgb); 89 | } 90 | } 91 | 92 | const bytes = new Uint8ClampedArray(buffer); 93 | ctx.putImageData(new ImageData(bytes, size, size), 0, 0); 94 | } 95 | 96 | /** 97 | * Represent an rgb color as four bytes in rgba order (a is always 0xff). 98 | * 99 | * Accounts for native endianness. 100 | */ 101 | const packRgba = (function (): (rgb: Rgb) => number { 102 | const buffer = new ArrayBuffer(4); 103 | const bytes = new Uint8Array(buffer); 104 | const int = new Uint32Array(buffer); 105 | int[0] = 0xff; 106 | const isLittleEndian = bytes[0] === 0xff; 107 | if (isLittleEndian) { 108 | return (rgb: Rgb): number => (rgb.r * 0xff << 0) | (rgb.g * 0xff << 8) | (rgb.b * 0xff << 16) | 0xff000000; 109 | } else { 110 | return (rgb: Rgb): number => (rgb.r * 0xff << 24) | (rgb.g * 0xff << 16) | (rgb.b * 0xff << 8) | 0x000000ff; 111 | } 112 | })(); 113 | 114 | const colorPunctuation = /[)(,]/g; 115 | 116 | // Turn "rgb(r, g, b)" or "rgba(r, g, b, a)" into an Rgb object 117 | function parseRgb(rgbStr: string): Rgb { 118 | // eslint-disable-next-line @typescript-eslint/no-unused-vars 119 | const [_, r, g, b] = rgbStr.split(colorPunctuation); 120 | return { 121 | r: Number(r) / 255, 122 | g: Number(g) / 255, 123 | b: Number(b) / 255, 124 | }; 125 | } 126 | 127 | function rgbToString(rgb: Rgb): string { 128 | const r = Math.round(rgb.r * 255); 129 | const g = Math.round(rgb.g * 255); 130 | const b = Math.round(rgb.b * 255); 131 | return `rgb(${r}, ${g}, ${b})`; 132 | } 133 | 134 | export class Picker { 135 | private readonly ctx: CanvasRenderingContext2D; 136 | /** thumb for hue */ 137 | private readonly hThumb: HTMLElement; 138 | /** thumb for saturation/value */ 139 | private readonly svThumb: HTMLElement; 140 | private hsv: Hsv = { 141 | h: 0, 142 | s: 1, 143 | v: 1, 144 | }; 145 | 146 | onRender?: (colorStr: string) => void; 147 | saveColor?: (colorStr: string) => void; 148 | 149 | constructor( 150 | canvas: HTMLCanvasElement, 151 | svThumb: HTMLElement, 152 | slider: HTMLElement, 153 | hThumb: HTMLElement, 154 | ) { 155 | this.ctx = canvas.getContext('2d'); 156 | this.hThumb = hThumb; 157 | this.svThumb = svThumb; 158 | 159 | // event handling for hue slider 160 | 161 | const readHueFromMouse = ({ clientY }: MouseEvent) => { 162 | const { height, top } = slider.getBoundingClientRect(); 163 | let y = (clientY - top) / height; 164 | if (y < 0) y = 0; 165 | if (y > 1) y = 1; 166 | this.hsv.h = y * 360; 167 | this.render(true); 168 | }; 169 | 170 | let draggingHue = false; 171 | 172 | slider.addEventListener('mousedown', event => { 173 | draggingHue = true; 174 | readHueFromMouse(event); 175 | }); 176 | 177 | window.addEventListener('mousemove', event => { 178 | if (!draggingHue) return; 179 | readHueFromMouse(event); 180 | }); 181 | 182 | window.addEventListener('mouseup', () => { 183 | if (draggingHue && this.saveColor) this.saveColor(rgbToString(hsvToRgb(this.hsv))); 184 | draggingHue = false; 185 | }); 186 | 187 | // event handling for 2d color slice 188 | 189 | const readSVFromMouse = ({ clientX, clientY }: MouseEvent) => { 190 | const { width, height, top, left } = canvas.getBoundingClientRect(); 191 | let x = (clientX - left) / width; 192 | let y = (clientY - top) / height; 193 | if (x < 0) x = 0; 194 | if (x > 1) x = 1; 195 | if (y < 0) y = 0; 196 | if (y > 1) y = 1; 197 | this.hsv.s = x; 198 | this.hsv.v = 1 - y; 199 | this.render(true); 200 | }; 201 | 202 | let draggingSlice = false; 203 | 204 | // Attach to the parent so that events get caught from the canvas and the thumb 205 | canvas.parentElement.addEventListener('mousedown', event => { 206 | draggingSlice = true; 207 | readSVFromMouse(event); 208 | }); 209 | 210 | window.addEventListener('mousemove', event => { 211 | if (!draggingSlice) return; 212 | readSVFromMouse(event); 213 | }); 214 | 215 | window.addEventListener('mouseup', () => { 216 | if (draggingSlice && this.saveColor) this.saveColor(rgbToString(hsvToRgb(this.hsv))); 217 | draggingSlice = false; 218 | }); 219 | } 220 | 221 | setColorRgbStr(rgbStr: string): void { 222 | const hsv = rgbToHsv(parseRgb(rgbStr)); 223 | this.hsv = hsv; 224 | this.render(); 225 | } 226 | 227 | private render(propagate?: true): void { 228 | this.hThumb.style.top = `${-12 + this.hsv.h * 256 / 360}px`; 229 | renderSlice(this.hsv.h, this.ctx); 230 | 231 | this.svThumb.style.top = `${(1 - this.hsv.v) * 256}px`; 232 | this.svThumb.style.left = `${this.hsv.s * 256}px`; 233 | 234 | const color = rgbToString(hsvToRgb(this.hsv)); 235 | this.svThumb.style.background = color; 236 | if (this.hsv.s + (1 - this.hsv.v) < 0.25) { 237 | this.svThumb.style.borderColor = '#000'; 238 | } else { 239 | this.svThumb.style.borderColor = '#fff'; 240 | } 241 | 242 | if (this.onRender && propagate) { 243 | this.onRender(color); 244 | } 245 | } 246 | } 247 | -------------------------------------------------------------------------------- /src/dependency-graph.svg: -------------------------------------------------------------------------------- 1 | 2 | 4 | 6 | 7 | 9 | 10 | G 11 | 12 | 13 | 14 | defaults.ts 15 | 16 | defaults.ts 17 | 18 | 19 | 20 | index.ts 21 | 22 | index.ts 23 | 24 | 25 | 26 | index.ts->defaults.ts 27 | 28 | 29 | 30 | 31 | 32 | message.ts 33 | 34 | message.ts 35 | 36 | 37 | 38 | index.ts->message.ts 39 | 40 | 41 | 42 | 43 | 44 | render/arrows/render.ts 45 | 46 | render/arrows/render.ts 47 | 48 | 49 | 50 | index.ts->render/arrows/render.ts 51 | 52 | 53 | 54 | 55 | 56 | render/highlights/render.ts 57 | 58 | render/highlights/render.ts 59 | 60 | 61 | 62 | index.ts->render/highlights/render.ts 63 | 64 | 65 | 66 | 67 | 68 | state.ts 69 | 70 | state.ts 71 | 72 | 73 | 74 | index.ts->state.ts 75 | 76 | 77 | 78 | 79 | 80 | message.ts->defaults.ts 81 | 82 | 83 | 84 | 85 | 86 | render/arrows/render.ts->defaults.ts 87 | 88 | 89 | 90 | 91 | 92 | render/arrows/render.ts->state.ts 93 | 94 | 95 | 96 | 97 | 98 | render/arrows/defs/render.ts 99 | 100 | render/arrows/defs/render.ts 101 | 102 | 103 | 104 | render/arrows/render.ts->render/arrows/defs/render.ts 105 | 106 | 107 | 108 | 109 | 110 | render/common.ts 111 | 112 | render/common.ts 113 | 114 | 115 | 116 | render/arrows/render.ts->render/common.ts 117 | 118 | 119 | 120 | 121 | 122 | render/highlights/render.ts->defaults.ts 123 | 124 | 125 | 126 | 127 | 128 | render/highlights/render.ts->state.ts 129 | 130 | 131 | 132 | 133 | 134 | render/highlights/render.ts->render/common.ts 135 | 136 | 137 | 138 | 139 | 140 | state.ts->defaults.ts 141 | 142 | 143 | 144 | 145 | 146 | options.ts 147 | 148 | options.ts 149 | 150 | 151 | 152 | options.ts->defaults.ts 153 | 154 | 155 | 156 | 157 | 158 | options.ts->message.ts 159 | 160 | 161 | 162 | 163 | 164 | options/color-picker.ts 165 | 166 | options/color-picker.ts 167 | 168 | 169 | 170 | options.ts->options/color-picker.ts 171 | 172 | 173 | 174 | 175 | 176 | options/swatches.ts 177 | 178 | options/swatches.ts 179 | 180 | 181 | 182 | options.ts->options/swatches.ts 183 | 184 | 185 | 186 | 187 | 188 | options/swatches.ts->defaults.ts 189 | 190 | 191 | 192 | 193 | 194 | render/arrows/defs/render.ts->defaults.ts 195 | 196 | 197 | 198 | 199 | 200 | render/arrows/defs/render.ts->state.ts 201 | 202 | 203 | 204 | 205 | 206 | render/arrows/defs/render.ts->render/common.ts 207 | 208 | 209 | 210 | 211 | 212 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------