Sv443 4769d139bc feat: allow building with linked pkgs in the bundle 1 anno fa
..
icons 80b54bdf19 feat: experimental adornment 1 anno fa
images 7146383d9f ref: you like css don't you 🥺 1 anno fa
style b53ee4a1bd fix: fixSpacing now works in all sections in the search results 1 anno fa
translations c083011074 feat: translations 1 anno fa
README.md 4769d139bc feat: allow building with linked pkgs in the bundle 1 anno fa
locales.json 986b31c06f fix: wrong language name 1 anno fa
plugins.json 5d52d42ec2 fix: gen-readme works now 1 anno fa
require.json 4769d139bc feat: allow building with linked pkgs in the bundle 1 anno fa
resources.json 80b54bdf19 feat: experimental adornment 1 anno fa

README.md

Asset formats explained


Images:

  • PNG images and external assets are stored in assets/images
  • SVG images are stored in assets/icons
  • CSS files in assets/style
  • Translations are in assets/translations


JSON file formats:

[!NOTE]
Note: If a property is wrapped with square brackets ([name]), it means that the property is optional


locales.json

This file contains a definition of the available locales and translations.
The keys of the object are the locale codes, and the values are the locale objects, with the following properties:

Property Type Description
name string The name of the locale in the locale's language
nameEnglish string The name of the locale in English
emoji string The flag emoji of the locale
userscriptDesc string The description of the userscript in the locale's language
authors string[] The authors of the translations


plugins.json

(Not implemented yet)


require.json

This file contains the npm libraries that are loaded into the runtime through the @require userscript directive.
It's an array of objects, which each have the following properties:

Property Type Description
pkgName string The name of the npm package, as in npm i <pkgName>
path string The path to the file that should be loaded, relative to the library root dir
global string The name of the global variable that the library exports
[link] boolean Whether npm link is active and the library should instead be included in the bundle