Home

Awesome

<p align="center"> <a href="https://nekocap.com/" target="_blank" rel="noopener"> <img src="https://user-images.githubusercontent.com/314281/102780389-cc03ed00-43d0-11eb-87c3-6d50a2ab5752.png" width="100" alt="NekoCap logo"> </a> </p> <div align="center"><sub>Logo by <a href="https://twitter.com/Iceikory" target="_blank" rel="noopener">@Iceikory</a></sub></div> <h1 align="center">NekoCap</h1> <div align="center">

Editor

ASS captions

</div> <div align="center">A browser extension for creating, uploading and viewing community created captions on video sharing sites such as YouTube, Vimeo and niconico. <br/> Get the extension: <a href="https://chrome.google.com/webstore/detail/nekocap/gmopgnhbhiniibbiilmbjilcmgaocokj" target="_blank" rel="noopener"> Chrome / Edge </a> | <a href="https://addons.mozilla.org/en-US/firefox/addon/nekocap/" target="_blank" rel="noopener"> Firefox </a> <br/> Website: <a href="https://nekocap.com/" target="_blank" rel="noopener"> NekoCap.com </a> </div> <br/> <div align="center"><font size="3">Join the Discord here:</font></div> <div align="center">

Discord Chat

</div>

Features

Extension

Website

Supported sites

Setup for local development

  1. Ensure you are using Node 16 (does not work with later versions yet)
  2. Run npm install
  3. Copy the contents of .env.sample to .env and fill in the details.
    • Firebase variables are used for auth
  4. Run npm run watch to start the webpack dev server for both the extension and the NekoCap website
  5. Go to chrome://extensions in Chrome and load the unpacked extension from the dist/extension folder
  6. 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.
  2. Add woff2 webfonts that you want to serve from the website into that folder
  3. Modify src/common/substation-fonts.ts to assign font names to the corresponding woff2 files in that folder.
  4. 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.
  2. 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
  3. 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

If you want to build the NekoCap website Docker image

  1. Follow step 1 in Creating a production build
  2. Copy the contents of Dockerfile.sample to Dockerfile and change whatever is necessary.
  3. Copy the nginx template docker/default.conf.template to docker/default.conf and change the configuration to suit your needs.
  4. Run docker build with your desired options.

Environment variables

Refer to the list of environment variables here.

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:

Translations: