ami/README.md

Ami

Chat client forked from the original Sock Chat client. Maintained for compatibility with Firefox 10+ and similar browsers.

Configuration

Configuration consists of a config.json file that contains the various URLs and a default chat title (the unified one is taken from whatever the remote common.json supplies). Make sure you create the file before building. An example is also supplied.

Building

Ami uses a build script written in Node.js; make sure you have NPM available and then run the following commands.

# Installs packages without updating package.json or package-lock.json
npm ci

# Runs the build process, make sure to run this after updates or changes as well
node build.js