https://github.com/enjarai/client-paintings

https://github.com/enjarai/client-paintings

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/enjarai/client-paintings
• Owner: enjarai
• License: lgpl-3.0
• Created: 2022-10-01T07:00:49.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-11T13:20:49.000Z (about 1 year ago)
• Last Synced: 2024-10-15T06:30:01.042Z (3 months ago)
• Language: Java
• Size: 1.61 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Client Paintings 

Client Paintings is a simple, *fully client-side* mod to add 

new paintings via resource packs while keeping the vanilla paintings intact.

It achieves this by looking at the UUID of the painting entity and

applying a pseudo-random algorithm to it to determine which painting to render.

This mod uses a custom resource pack format to add new paintings,

you can use the [Client Paintings Pack Generator](https://enjarai.dev/#/tools/client-paintings-generator) on my website

to generate such a pack easily. Alternatively, see the resource pack format section below for technical instructions.

### Features

- Add multiple new sets of paintings via resource packs

- Keep the vanilla paintings intact

- When a vanilla painting is shown, it will match the vanilla painting seen by players without the mod

- Custom paintings shown will match the custom paintings seen by other players with the mod

- Custom paintings are fully persistent between relogs and server restarts

### Caveats

- Custom paintings will only match up between players if they both use the exact same painting sets

- Painting sets have to be added via a custom resource pack format, see below for details

## Example

With the included default resource pack:



What vanilla players see:



## Resource pack format

The resource pack format is very simple. It consists of a single `client_paintings` folder

located in the root of your resource pack namespace (e.g. `assets//client_paintings`).

Inside this folder, you can place any number of json files, each representing a custom painting.

Each json file must have the following structure:

```json

{

  "texture": ":client_paintings/painting_texture",

  "back": ":client_paintings/painting_back_texture",

  "size": [2, 1]

}

```

- `texture` is the texture of the painting, it must be a png image with a ratio matching the `size` field, 

  with width and height both being a multiple of 16. The texture has to be located within 

  the `assets//textures/client_paintings` folder.

- `back` is the texture of the back of the painting, it must be a square png image with similarly, a width and height

  being a multiple of 16. (Optional, the vanilla back texture will be used if absent)

- `size` is the size of the painting in blocks, the first value is the width, the second value is the height.

  Do note only 1x1, 1x2, 2x1, 2x2, 4x2, 4x4, and 4x3 size paintings are supported due to the need to replace

  a vanilla painting.

An example resource pack structure would look as follows:

```text

pack.mcmeta

assets

└── namespace

    ├── textures

    │   └── client_paintings

    │       ├── painting1.png

    │       ├── painting2.png

    │       ├── painting3.png

    │       └── backs

    │           ├── back1.png

    │           └── back2.png

    └── client_paintings

        ├── painting1.json

        ├── painting2.json

        └── painting3.json

```

The source for the default included pack can be browsed 

[here](https://github.com/enjarai/client-paintings/tree/master/src/main/resources/resourcepacks/default).