History

Maxwell Jeffress a4b6721ebc Add web client, update CLI client		2024-11-05 20:35:10 +11:00
..
src/main/kotlin	Add web client, update CLI client	2024-11-05 20:35:10 +11:00
build.gradle.kts	Update both server and client for websocket support	2024-10-24 12:33:58 +11:00
README.md	Update client-cli/README.md	2024-10-21 09:02:34 +11:00
settings.gradle.kts	Initial commit	2024-10-20 13:37:03 +11:00

README.md

Chookpen Client (CLI)

This is the reference client for Chookpen. It is quite a basic client. This is a good starting point if you need an example, or are building a GUI Kotlin client.

Features

Profile file
Create account (buggy)
Log into existing account
Sync messages
Send message
Auto hash password
Configure whether HTTPS is used

Documentation

To run this client, do the following:

Install Java 17+ and Gradle.
git clone https://git.maxwellj.xyz/max/chookpen
In the client-cli directory of the git repo, run gradle installDist.
Inside build/install/bin, create a .chookpen.profile file that looks like this: name:password:server:port:0
Run the script in build/install/bin, or the bat file if you're a crazy weird guy who uses Windows (Make sure to use the command line otherwise it'll close instantly)
If you'd like to send a message, add that as your argument after specifying the script.

Note: The password in .chookpen.profile is hashed by the client. If you're just testing the server, set your password to dingus. The hash recognised by the server for that password is 750c63441033127dccaa91c16b21614e. Create an account with the method specified in the root README using that password.