Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installing Translator Plugins

Plugins come as a single .wasm file which surfer will search for in .surfer/translators the current working directory, as well as in the global configuration directory

OsPath
Linux~/.config/surfer/translators/
WindowsC:\Users\<Name>\AppData\Roaming\surfer-project\surfer\config\translators\
macOS/Users/<Name>/Library/Application Support/org.surfer-project.surfer/translators/

To install a translator, simply put the .wasm file in one of these locations, and it will be discovered automatically.

Translators execute arbitrary code, so some care should be taken before installing translators. However, they are sandboxed behind a web-assembly runtime that, unless there are security, does not allow any access to anything on the system that surfer does not allow.

Currently, the only system access surfer allows for plugins is

  • Reading the path of the current working directory
  • Reading arbitrary files