textmode-browser-extension - GitLite

KO | EN

gitlite — search

#proxy #claude #generative-ai #devops #data-science #machine-learning #developer-tools #security #postgresql #vue

textmode-browser-extension

(★ 10)

Turn <canvas> and <video> elements into live ASCII art.

File Explorer

ZIP Download

- - config.yml
- - preview1.png
  - preview2.png
  - preview3.png
- - ci.yml
- CODEOWNERS
- dependabot.yml
- FUNDING.yml
- media-picker-overlay-refactor-plan.md
- - atascii.ttf
  - Bescii-Mono.ttf
  - cpc464.ttf
  - UrsaFont.ttf
- - icon-128.png
  - icon-16.png
  - icon-32.png
  - icon-48.png
  - icon-64.png
- check-boundaries.mjs
- - background.ts
  - content-runtime.ts
  - overlay-host.ts
- vite-env.d.ts
- - extension.spec.ts
- - media-page.html
- - iframe-compatibility.md
- - browser-api.test.ts
  - context-menu-controller.test.ts
  - control-panel.test.ts
  - dependency-guard.test.ts
  - element-picker.test.ts
  - frame-agent.test.ts
  - frame-router.test.ts
  - glyph-ramp-registry.test.ts
  - manifest.test.ts
  - messages.test.ts
  - overlay-export-service.test.ts
  - overlay-instance-adapter.test.ts
  - overlay-manager.test.ts
  - overlay-renderer.test.ts
  - overlay-settings.test.ts
  - page-state.test.ts
  - panel-placement-store.test.ts
  - panel-placement.test.ts
  - post-fx-runtime.test.ts
  - product-manifest.test.ts
  - runtime-injection.test.ts
  - site-preset-store.test.ts
  - site-preset.test.ts
  - store-links.test.ts
  - test-helpers.ts
  - top-frame-coordinator.test.ts
.env.example
.gitignore
.npmrc
.prettierignore
CODE_OF_CONDUCT.md
components.json
CONTRIBUTING.md
eslint.config.js
LICENSE
package-lock.json
package.json
playwright.config.ts
product-manifest.json
README.md
tsconfig.json
vitest.config.ts
wxt.config.ts

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

<table>
  <tr>
    <td><img src=".github/media/preview1.png" alt="Preview 1" /></td>
    <td><img src=".github/media/preview2.png" alt="Preview 2" /></td>
    <td><img src=".github/media/preview3.png" alt="Preview 3" /></td>
  </tr>
</table>

<p align="center">
  <a href="https://www.typescriptlang.org/"><img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" /></a><a href="https://wxt.dev/"><img alt="WXT" src="https://img.shields.io/badge/WXT-000000?logo=webcomponents.org&logoColor=white" /></a><a href="https://vite.dev/"><img alt="Vite" src="https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white" /></a>
  &nbsp;&nbsp;
  <img alt="Chrome MV3" src="https://img.shields.io/badge/Chrome-MV3-4285F4?logo=googlechrome&logoColor=white" /><img alt="Edge MV3" src="https://img.shields.io/badge/Edge-MV3-0078D7?logo=microsoftedge&logoColor=white" /><img alt="Firefox MV3" src="https://img.shields.io/badge/Firefox-MV3-FF7139?logo=firefoxbrowser&logoColor=white" /><img alt="Safari MV2" src="https://img.shields.io/badge/Safari-MV2-006CFF?logo=safari&logoColor=white" />
  &nbsp;&nbsp;
  <a href="https://ko-fi.com/V7V8JG2FY"><img alt="Ko-fi" src="https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi" /></a><a href="https://github.com/sponsors/humanbydefinition"><img alt="GitHub Sponsors" src="https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=%23EA4AAA" /></a>
</p>

</div>

`Textmode Overlay` is a free, open-source browser extension built with [textmode.js](https://github.com/humanbydefinition/textmode.js). It turns compatible `<canvas>` and `<video>` elements into live ASCII/textmode overlays that you can style, adjust, and export.

## Features

- **Live conversion**: Render a customizable ASCII grid over a compatible canvas or video.
- **Media picker**: Select visible media in the page, including supported same-origin and nested frames.
- **Visual controls**: Adjust brightness, contours, colors, glyph ramps, fonts, opacity, and post-processing effects.
- **Custom fonts**: Upload local `.ttf` or `.otf` fonts for your own character style.
- **Exports**: Save a frame as TXT, SVG, PNG, or JPG.

## Browser Support

| Browser                                               | Build                   | Output                     | Store                                                                                                          |
| ----------------------------------------------------- | ----------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------- |
| [Chrome](https://www.google.com/chrome/)              | `npm run build:chrome`  | `.output/chrome-mv3`       | [Chrome Web Store](https://chromewebstore.google.com/detail/textmode-overlay/nmepplnokndndgeldlhbffhkipimmaia) |
| [Opera](https://www.opera.com/download)               | `npm run build:opera`   | `.output/chrome-mv3-opera` | [Opera Add-ons](https://addons.opera.com/en/extensions/details/textmode-overlay/)                              |
| [Edge](https://www.microsoft.com/en-us/edge)          | `npm run build:edge`    | `.output/edge-mv3`         | [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/plmdfppaobnppibihdkfgoaeikehofjf)             |
| [Firefox](https://www.mozilla.org/en-US/firefox/new/) | `npm run build:firefox` | `.output/firefox-mv3`      | [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/textmode-overlay/)                            |
| [Safari](https://www.apple.com/safari/)               | `npm run build:safari`  | `.output/safari-mv2`       | —                                                                                                              |

## Quick Start

Requirements:

- [Node.js](https://nodejs.org/en/download) 20.8.1 or newer
- npm
- [Chrome](https://www.google.com/chrome/) or another [Chromium](https://www.chromium.org/getting-involved/download-chromium/) browser for local MV3 testing

Install dependencies:

```sh
npm install
```

Run the full verification pipeline:

```sh
npm run check
```

Build the unpacked Chrome extension:

```sh
npm run build:chrome
```

Load the extension in Chrome:

1. Open `chrome://extensions`.
2. Enable Developer mode.
3. Click **Load unpacked**.
4. Select `.output/chrome-mv3`.

## Custom fonts

Upload a local TrueType (`.ttf`) or OpenType (`.otf`) font from the in-page panel. Fonts stay in the current browser profile; they are not synced or uploaded. Files over 10 MB are rejected, and the extension supports up to 10 fonts and 50 MB of font data in total.

## Privacy

Textmode Overlay accesses a page only after you invoke it from the toolbar or context menu. Rendering, settings, fonts, and exports stay in your browser. The extension has no backend, account synchronization, analytics, advertising, or remote telemetry, and it does not transmit page content or exports.

The extension uses `activeTab`, `contextMenus`, `scripting`, `storage`, and `unlimitedStorage`. It does not request permanent host permissions.

See the [Imprint](https://legal.textmode.art/projects/extension.textmode.art/en/imprint) and [Privacy Policy](https://legal.textmode.art/projects/extension.textmode.art/en/privacy) for the complete disclosures covering the extension and [extension.textmode.art](https://extension.textmode.art/) landing page.

## Usage

1. Open a [page](https://www.youtube.com/watch?v=dQw4w9WgXcQ) with a visible canvas or video element.
2. Click the Textmode Overlay toolbar icon, or right-click the page and choose **Open Textmode Overlay**.
3. In the panel, choose **select media**, then click a highlighted canvas or video.
4. Adjust the effect or export a frame from the panel.

> [!NOTE]
> Some media cannot be sampled. Cross-origin, tainted, DRM-protected, or otherwise restricted media may fail when the browser blocks WebGL or canvas pixel access.

## Development

Development workflow, testing, architecture, and contribution guidelines live in
[CONTRIBUTING.md](CONTRIBUTING.md).

## License

`Textmode Overlay` is licensed under the [MIT License](LICENSE).