https://github.com/codef53/webpackxbr

A utility for automatic application of the XBR scaling algorithm to game textures, specifically designed for Minecraft resource packs.
https://github.com/codef53/webpackxbr

xbrz

Last synced: 25 days ago
JSON representation

A utility for automatic application of the XBR scaling algorithm to game textures, specifically designed for Minecraft resource packs.

• Host: GitHub
• URL: https://github.com/codef53/webpackxbr
• Owner: CodeF53
• Created: 2023-04-26T23:17:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-09T17:18:38.000Z (10 months ago)
• Last Synced: 2024-01-09T18:38:38.501Z (10 months ago)
• Topics: xbrz
• Language: Vue
• Homepage: https://packxbr.f53.dev/
• Size: 893 KB
• Stars: 7
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PackXBR

A utility for automatic application of the XBR scaling algorithm to a collection of game textures, specifically designed for Minecraft resource packs.

## Usage

1. Go to [packxbr.f53.dev](https://packxbr.f53.dev/)

2. Choose a `.zip` file containing `.png` images you want to scale.

3. Select Scale Factor and Auto/Manual

4. (Manual Only), choose options to scale each image.

5. The scaled `.zip` will be saved once all images have been processed.

## Terminology

### Edge Handling

Depending on what what a texture looks like, you will want the edges of it to be handled differently. Here are a couple of examples covering all the wrap modes, and where they would be used:

![Example of edge options you may choose for a ladder](https://cdn.discordapp.com/attachments/821452669771972608/977375979297181696/Ladder.png)

![Example of edge options you may choose for foliage](https://cdn.discordapp.com/attachments/821452669771972608/977375979934728192/Acacia_Sapling.png)

![Example of edge options you may choose for grass-like blocks](https://cdn.discordapp.com/attachments/821452669771972608/977375980928765973/Warped_Nylium_Side.png)

### Relayer

Normally, xBRZ rounds off the edges of textures, which can lead to holes in the corners of models! Relayer is an option designed to correct this flaw. It basically un-rounds corners by underlaying a Nearest Neighbor upscale of the original texture beneath the result from xBRZ.

!["demo" of relayer](https://cdn.discordapp.com/attachments/1082142594567516160/1115407857114951700/image.png)

## Auto vs Manual

Now, you may be thinking:

> If there is a mode to automatically scale everything, why would I ever use manual mode?

Because the tool has no idea what each image given to it is, the best it can do for how to handle scaling it is guess based on the directory it's inside of.

Heres the logic Auto mode uses:

1. By default, all images have relayer off and use void for all their edges.

2. Inside `block/`, all edges are treated with wrap

3. Inside `model/` and `entity/`, relayer is used

4. Inside `painting/`, all edges are treated with extend

5. Inside `font/` and `colormap/`, images aren't scaled at all

While this logic leads to a half-decent result, it's not perfect. So if you have the time, I highly recommend using manual.

## Misc

If you have any questions or suggestions, please contact me via [the VanillaXBR Discord server](https://discord.com/invite/8N4xzej)!