https://github.com/nopol10/nekocap
Browser extension for creating & uploading community captions for YouTube, niconico and other video sharing sites.
https://github.com/nopol10/nekocap
caption captions editor extension substation-alpha subtitle subtitles typescript
Last synced: 3 months ago
JSON representation
Browser extension for creating & uploading community captions for YouTube, niconico and other video sharing sites.
- Host: GitHub
- URL: https://github.com/nopol10/nekocap
- Owner: nopol10
- License: gpl-3.0
- Created: 2020-12-20T07:51:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-11-04T15:31:56.000Z (6 months ago)
- Last Synced: 2025-11-04T17:19:57.234Z (6 months ago)
- Topics: caption, captions, editor, extension, substation-alpha, subtitle, subtitles, typescript
- Language: JavaScript
- Homepage: https://nekocap.com
- Size: 13.9 MB
- Stars: 85
- Watchers: 4
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Logo by @Iceikory
NekoCap
A browser extension for creating, uploading and viewing community created captions on video sharing sites such as YouTube, Vimeo and niconico.
Get the extension:
Chrome / Edge
|
Firefox
Website:
NekoCap.com
Join the Discord here:
[](https://discord.gg/xZ9YEXY5pd)
## Features
### Extension
- Built in caption editor accessible directly from supported video sharing sites
- Custom caption positioning
- Support for hotkeys from various editing software
- Caption file export (SRT)
- More to come
- Caption file loading (SRT, VTT, SBV, SSA, ASS, TXT supported)
- Caption upload
- Caption viewing
- Advanced Substation Alpha (SSA/ASS) caption rendering
- Caption rating system
### Website
- Captioned video search
- Captioner profiles
- Caption review page
- Captioner moderation tools (verify, reject)
### Supported sites
- YouTube
- Vimeo
- bilibili
- niconico
- TVer
- Netflix (editor disabled)
## Setup for local development
### Tested build environment
1. Node 22.14.0
1. Windows 10
### Steps
1. Run `npm ci`
1. Copy the contents of `.env.sample` to `.env` and fill in the details.
- Firebase variables are used for auth
1. Run `npm run watch` to start the webpack dev server for both the extension
and the NekoCap website
1. Go to `chrome://extensions` in Chrome and load the unpacked extension from
the `dist/extension` folder
1. Go to `http://localhost:12341` to access the NekoCap website
### Adding fonts to be hosted from the NekoCap site for SSA/ASS rendering
1. Create a folder called `fonts` in the `public` folder.
1. Add woff2 webfonts that you want to serve from the website into that folder
1. Modify `src/common/substation-fonts.ts` to assign font names to the
corresponding woff2 files in that folder.
1. Run `npm run fontlist` to generate the `public/fontlist.json` file that will
be pulled by the extension and website to know which fonts are available. You
can serve this file and the fonts separately so that you don't have to
redeploy when new fonts are added.
### Creating a production build
1. Copy the contents of `.env.sample` to `.env.prod` and fill in the details.
1. Add `PRODUCTION=1` to the end of the file.
1. Run `npm run build` to build both the extension and the website
- Run `npm run build:ext` to build just the extension
- Run `npm run build:web` to build just the website
1. The output will be in `.next/` and `dist/extension`
1. License information of utilized packages will be in \*.licenses.txt next
to the output javascript
### Creating a Firefox extension build
1. Copy the contents of `.env.sample` to `.env.prod` and fill in the details.
1. Add `PRODUCTION=1` to the end of the file.
1. Run `npm run build` to build both the extension and the website
- Run `npm run build:ext:firefox` to build just the extension
1. The output will be `dist/extension`
### If you want to build the NekoCap website Docker image
1. Follow step 1 in [Creating a production build](#creating-a-production-build)
1. Copy the contents of `Dockerfile.sample` to `Dockerfile` and change whatever
is necessary.
1. Copy the nginx template `docker/default.conf.template` to
`docker/default.conf` and change the configuration to suit your needs.
1. Run `docker build` with your desired options.
## Environment variables
Refer to the list of environment variables
[here](./docs/environment-variables.md).
## Special thanks
Many great packages helped to bring this to life but extra kudos go to these
projects without which NekoCap would not have been the same:
- [SubtitleOctopus](https://github.com/Dador/JavascriptSubtitlesOctopus) - ASS
rendering
- [React Hotkeys](https://github.com/greena13/react-hotkeys) - Easy to use
hotkeys (use the latest Github build and not the outdated npm one)
- [subtitle.js](https://github.com/gsantiago/subtitle.js) - SRT and VTT parsing
- [ass-compiler](https://github.com/weizhenye/ass-compiler) - ASS parsing
Translations:
- Arabic: Adnamie
- French: Adnamie
- Japanese: rama_onehalf
- Persian: Pikhosh
- Vietnamese: Golđén