pixelchat/README.md

# PixelChat

[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/NuGxJKtDKS)

A simple mod to share images in-game.

## Features

- Image Sharing: Drag and drop image files into the chat and share them in chat.

## Fabric Setup

1. Install Fabric: Ensure that you have Fabric installed.
2. Download PixelChat: Get the latest version from the [releases](https://git.1e99.eu/1e99/pixelchat/releases) tab.
3. Add to mods folder: Place the downloaded JAR file into your mods folder.

### Configuration

A configuration file can be found at

```json
{
  // Set where images will be uplaoded to
  // You must omit the '/' at the end of the URL
  // This must be a PixelChat server (See later on how to set one up yourself)
  "image_hosts": [
    "https://pc.1e99.eu"
  ]
}
```

## Server Setup

Setting up a PixelChat server can be done with docker compose or from source.

### Docker Compose

```yml
services:
  "pixelchat":
    build: "https://git.1e99.eu/1e99/pixelchat.git"
    ports:
      - "3000:3000"
```

### From Source
1. Install a JDK: Ensure that you have Java 21 installed.
2. Clone the git repository: `git clone https://git.1e99.eu/1e99/pixelchat.git`.
3. Change your working directory: `cd ./pixelchat`
4. Build the server JAR: `./gradlew :server:shadowJar`.
5. Run the server: `java -jar ./server/build/libs/server-*-all.jar`.