JFL - Java Flist Library

Overview

Note: JFL is still in development as of June 2016. Code will remain incomplete and will likely contain errors until this header is removed.

JFL is an open source third-party Java library for the online roleplaying website f-list.net, offering features for easy implementation of clients and bots for F-chat, and general access of API endpoint data.

##Code Example

The following code is a simple implementation of the FClient class that logs into F-chat and joins the specified private channel when login is successful.

public class Bot extends FClient {
    //Constructor calls super to access parent constructor
    public Bot(String clientName,String clientVersion) throws Exception {
        super(clientName,clientVersion);
    }

    //Gets called by the client when it received an IDN response command from the server
    @Override public void onLogin() throws Exception {
        joinChannel("ADH-491cbcdbbbe8039e87cb"); //Joins the specified channel
    }

    //Main method that creates an instance of the Bot class and logs in
    public static void main(String[] args) throws Exception {
        Bot myBot=new Bot(“client_name”,”version_number”); //Creates a bot (FClient) object
        myBot.login(“username”,”character_name”,”password”); //Logs in
    }
}

##Dependencies

JFL relies on org.java_websocket copyright (c) 2010-2012 Nathan Rajlich for websocket communication and org.json for JSON object manipulation. Both precompiled libraries have been included in the org package.

##Features

####Testing

• User can easily switch between operating on the public server and development server without needing to know their respective URLs or ports

####API access

• Handles all POST requests for API endpoints
• Automatically acquires f-chat tickets
• User can invoke methods for acquiring any needed character data, such as gender and kinks

####F-chat communication

• Handles all websocket communication
• Handles client-server JSON commands and formatting. Every command has a corresponding method or set of methods.
• User can implement methods that are called for incoming server commands
• User can invoke methods for any outgoing client commands

####F-chat data tracking

• Tracks server variables
• Tracks and logs PMs and channel messages
• Tracks data for all characters that enter f-chat including gender, status, status message, and any character information received from the server or requested from the API
• Tracks data for all channels that the client enters, including names/titles, chanops, channel settings, and a list of characters occupying each room

####Additional features

• Provides methods for retrieving information parsed from SYS commands, particularly those that are sent in response to client commands with no unique server response (RST, CIU, CBL, COL, and CUB).
• Handles server commands that come in batches by tracking their data as the commands are received and only calling the appropriate method(s) on the final 'end' command

##Additional Resources F-chat server commands

F-chat client commands

Error code reference

F-chat development basics

F-chat client and bot rules

Are you a Ruby developer? Check out LibFchat by Jippen Faddoul

##Contact Contact Seth Logan through an f-list note to his character found here