lib-fchat v1.3.3

Lib-fchat

Lib-fchat is a node js library for creating f-chat clients and making requests to f-list api endpoints. F-list is an adult-themed creative writing and roleplaying website. To learn more about f-list in general, you can visit their wiki, or if you'd like to use their APIs to develop third party clients or other applications, be sure to thoroughly read through their developer resources before implementing this library in your projects. Lib-fchat abstracts away the need to directly manage f-list tickets and authentication, WebSocket connections, and RESTful API requests, allowing developers to concentrate on application-specific code while still providing a high level of customization.

Installation

Note: Before installing, ensure you have the latest version of node installed and that the root of your node project is the current working directory in your cli.

$ npm install --save lib-fchat

Example

Using a config file and credentials stored in a .env file, this example simply connects to f-chat and logs output to the console when the websocket is connected and when identification with the server is complete

require("dotenv").config();

const Fchat = require("lib-fchat/lib/Fchat");
const config = require("./config");

var fchat = new Fchat(config);
fchat.connect(process.env.ACCOUNT, process.env.PASSWORD, process.env.CHARACTER);

fchat.onOpen(ticket => {
  console.log(`Websocket connection opened. Identifying with ticket: ${ticket}`);
});

fchat.on("IDN", () => {
  console.log(`Identification as ${fchat.user.character} Successful!`);
});