kiwiirc-plugin-asl's Introduction

Custom Startup for Kiwi IRC

This plugin creates a customised startup screen for age/sex/location based off Welcome.vue

It then display's this data in a customised userbox based off UserBox.vue

It also provides a nicklist style user list with search/filter for users to find other chatters

Dependencies

node (https://nodejs.org/)
yarn (https://yarnpkg.com/)

Building and installing

Build the plugin
```
$ yarn
$ yarn build
```
The plugin will then be created at dist/plugin-asl.js
Copy the plugin to your Kiwi webserver

The plugin file must be loadable from a webserver. Creating a plugins/ folder with your KiwiIRC files is a good place to put it.
Add the plugin to KiwiIRC

In your kiwi config.json file, find the plugins section and add:
```
{"name": "asl", "url": "/plugins/plugin-asl.js"}
```
To enable the startup screen, tell KiwiIRC to use the startup screen from the plugin. Set "startupScreen" to plugin-asl.

Configuration

More details on the wiki

note: the variables starting with _ are treated as translation keys

"plugin-asl" : {
    "localesPath": "/static/plugins/plugin-asl/locales",
    "gecosType": 1,
    "showRealname": false,
    "showUserBrowser": true,
    "userBrowserIcon": "fa-heart",
    "fallbackColour": "default",
    "singleLineUserbox": false,
    "singleLineString": {
        "age": "%a years",
        "sex": "%s",
        "location": "%l",
        "separator": " ",
    },
    "allowedAge": {
        "min": 18,
        "max": 99
    },
    "ageRanges": [
        { "name": "_all", "value": "all" },
        { "name": "< 25", "value": "<25" },
        { "name": "25 - 45", "value": "25-46" },
        { "name": "> 45", "value": ">45" },
    ],
    "sexes": [
        { "name": "_male", "chars": "M", "colour": "#00F" },
        { "name": "_female", "chars": "F", "colour": "#F0F" },
        { "name": "_other", "chars": "O", "colour": "#F00" },
    ],
    "queryKeys": {
        "age": "age",
        "sex": "sex",
        "location": "location",
        "realname": "realname",
    },
    "requiredFields": [
        "age",
        "sex",
        "location",
    ],
},