Skip to content

Install and usage

RetroTxt employs an open-sourced GNU LGPLv3 license with the code available on GitHub.

This page instructs how to use the source in Chrome-based and Firefox web browsers.

Visual Studio Code is used to create RetroTxt, and so it has some .vscode conveniences included in the package, such as workspace settings and extension recommendations.

There are also Node.js with pnpm packages for the programming and build tools.

The source code gets lint with ESLint and stylized using Prettier opinionated formatting.

Clone the repo

Run the following Git or gh command in a terminal.

git clone https://github.com/bengarrett/RetroTxt.git
gh repo clone bengarrett/RetroTxt

Install the packages

Use the pnpm package manager.

Install packages
cd RetroTxt
pnpm install

Use package dependencies

Use Task, the task runner/build tool.

Update packages
cd RetroTxt
pnpm update
task depends

Run the source code

Use on Chrome, Edge, Brave, and Vivaldi

I suggest that you create a new user profile and edit the Extension.

Open a new tab with the address of the Extensions feature.

Extensions Details address
chrome://extensions
  1. In the Extensions tab, toggle Developer mode
  2. Click the Load unpacked button
  3. Navigate to the local directory containing the RetroTxt source code and select OK

Chrome extensions developer mode

Open a new tab with in the address of the Extensions feature.

Extensions Details address
edge://extensions
  1. In the Extensions tab, toggle Developer mode
  2. Click the Load unpacked button
  3. Navigate to the local directory containing the RetroTxt source code and select OK

Edge extensions developer mode

Open a new tab with in the address of the Extensions feature.

Extensions Details address
brave://extensions
  1. In the Extensions tab, toggle Developer mode
  2. Click the Load unpacked button
  3. Navigate to the local directory containing the RetroTxt source code and select OK
Extension Details address
vivaldi://extensions/
  1. In the Extensions tab, toggle Developer mode
  2. Click the Load unpacked button
  3. Navigate to the local directory containing the RetroTxt source code and select OK

RetroTxt should load. The Options link behind the Details button allows you to configure RetroTxt styling and behavior.