pi-im/README.md

<center>
<img width="100" height="100" src="https://github.com/sunglocto/pi/blob/255bc3749c089e3945871ddf19dd17d14a83f9ff/pi.png">
</center>
<img alt="Pi screenshot" src="https://github.com/user-attachments/assets/9e2d9209-6ad5-4f22-94d0-4cc18c835372" />


## the XMPP client from hell
> it's 10% code. 20% ai

Experimental and extremely weird XMPP client written in Go. No solicitors.

pi is currently pre-pre-pre-pre alpha software which you should not use as your primary XMPP client.

pi uses [Fyne](https://fyne.io) for the frontend and uses the [Oasis SDK](https://github.com/jjj333-p/oasis-sdk) by [Joseph Winkie](https://pain.agency) for XMPP functionality.

pi is an extremely opinionated client. It aims to have as little extra windows as possible, instead using alt-menus to perform many of the actions you'd see in a typical client.


## διαμόρφωση
(configuration)

When you launch pi, you will be greeted with a create account screen. You will then be able to enter your XMPP account details and then relaunch the application to log in.

If you want to add MUCs or DMs, you must configure the program by editing the pi.xml file. Here is an example configuration:

```xml
<piConfig>
	<Login>
		<Host>example.com:5222</Host>
		<User>user@example.com</User>
		<Password>123456789</Password>
		<DisplayName>sunglocto</DisplayName>
		<TLSoff>false</TLSoff>
		<StartTLS>true</StartTLS>
		<MucsToJoin>room1@muc.example.com</MucsToJoin>
		<MucsToJoin>room2@muc.example.com</MucsToJoin>
	</Login>
	<Notifications>true</Notifications>
	<DMs>person1@example.com</DMs>
</piConfig>
```

The file is usually located at, on GNU/Linux systems:
```
~/.config/fyne/pi-im/Documents/pi.xml
```
This will be changed eventually, likely before a 3b release.

Currently joining and saving DM tabs is not supported, nor is getting avatars, reactions or encryption.

As of writing, pi supports basic message sending and receiving, replies, file upload and corrections.


## να χτίσω 
(building)

To build pi, you will need the latest version of Go, at least 1.21. You can grab it [here](https://go.dev).

The build instructions are very simple. Simply clone the repo, fetch the repositories and build the program.

Here is a summary of the commands you would need to use:
```bash
git clone https://forge.sunglocto.net/sunglocto/pi-im
cd pi-im
go mod tidy
go build .
./pi-im
```
> Uh, Windows???

The commands above should be virtually identical, aside from changing `./pi-im` to `pi-im.exe`. If you compile it, it will most likely work with no issues:
<img alt="image" src="https://github.com/user-attachments/assets/5a6c188f-e890-4398-856c-e88f5804e9d2" />


Static executable snapshots are also provided for GNU/Linux systems on every new version, and CI runs on every commit, producing a binary on every successful build, for Linux, Windows and MacOS.

You're welcome.

## Wayland
On BSD and Linux systems, you may want to build an executable for Wayland only, meaning it will not run through XWayland. This will increase performance and also allow drag-on-drop functionality. Most Wayland setups can run X11 apps, but no X11 setup can run Wayland apps. Because of this, all executables are shipped for use with X11. This may change in the future, but if you want to build for Wayland, it's as simple as the commands above, but just adding a `wayland` tag to the build command.

A Wayland-only executable will also substantially decrease the level of screen tearing and lag.

```bash
git clone https://forge.sunglocto.net/sunglocto/pi-im
cd pi-im
go mod tidy
go build -tags wayland .
./pi-im
```

## εγκατάσταση
(installation)

Pi currently has no consolidated way of installing it. There is an [Arch User Repository package available](https://aur.archlinux.org/pi-im), which is maintained by [snit](https://isekai.rocks/~snit).

## υποστήριξη
(support)

You can file an issue and explain the problem you are having.

If you would like a more instant method of communication, join the [pi XMPP room.](xmpp:pi@room.sunglocto.net?join)


## αρμονία
(compatibility)

Pi has guaranteed support for the following operating systems:
- Windows 10 and up
- Most modern GNU/Linux installations
- FreeBSD

Pi has experimental support for the following operating system:
- Android [1]

Pi has not been tested on, but has been built on, the following operating systems:
- MacOS

Pi most likely does **not** have support for the following operating systems:
- Other BSDs
- 32-bit systems
- iOS
- ARM systems


If you use Pi on a specific operating system and it does not work, file an issue and describe the problem you have having.

## μαρτυρίες
(testimonials)
From fellow insane and schizophrenic XMPP users:

> anyways this is your "just IM" client things ig.

> this looks like shit

> fyne is the best UI toolkit (sarcastic)

> i am going to explode you

> pi devstream when

<img width="361" height="66" alt="image" src="https://github.com/user-attachments/assets/5a926f6b-1005-4795-a6ef-4e0538bb4d5a" />
<img width="316" height="73" alt="image" src="https://github.com/user-attachments/assets/52309c60-8110-43eb-9c45-56c9cfd82cc4" />


## επιπλέον
(extra)

Pi version numbers are the digits of Pi followed by a letter indicating the phase of development the program is in.

For example, the version string:

`3.14a`

Is the third version produced in the alpha phase.

The digits of Pi will reset back to `3` when moving to a new phase.

If the number gets too long, it will reset to one digit of 2π. Once that gets too long, it will be digits of 3π and etc.

Named after [Psi](https://github.com/psi-im/psi).

[1] Android is not a supported platform, however it's possible to compile and run Pi for it. If you want to become suicidal, you can go for it, but Pi is a primarily PC-oriented client. There are multiple mobile clients that already exist which will give you a substantially better experience.