PiXel ScaLer Knowledge Bundle
Bundle OKF 0.2 · 10 conceitos · irokaru/pixel-scaler
Open source Repository Open in the app JSON README (API)
About
# PiXel ScaLer Knowledge Bundle
* [Pixel Scaling Algorithms](algorithms/scaling-guide.md) - xBR vs Nearest vs GIF, trade-offs and gotchas
* [Scale Parameters & Limits](algorithms/scale-parameters.md) - ScaleSizePercent / OriginalPixelSize / XbrMaxPercent limits
* [Entry & Convert Lifecycle](lifecycle/entry-convert-lifecycle.md) - input → scaled → download/zip flow
* [Error Handling Model](lifecycle/error-model.md) - error kinds, flow, recoverable vs fatal semantics
* [Error Code → i18n Key Catalog](lifecycle/error-code-catalog.md) - every error code mapped to its i18n key
* [Theme Contribution Playbook](contributing/theme-playbook.md) - how to add a theme
* [i18n Contribution Playbook](contributing/i18n-playbook.md) - how to add a locale
* [Build Targets & Environment Matrix](contributing/build-targets.md) - PWA / Tauri / standalone env matrix
* [Project Architecture](project/architecture.md) - layer model, dependency direction, src/core boundary, key directories
* [Engineering Conven
Details
- Kind
- OKF bundles
- Topic
- Developer tools
- Publisher
- irokaru
- Origin
- okf_github
- Category
- dados
- Version
- 0.2
- Stars
- 250
- Forks
- 27
- Open pull requests
- 1
- Last push
- 2026-09-08T11:50:23Z
- Repository state
- ativo
- Language
- TypeScript
- License
- MIT
- Added
- 2026-09-08 22:07:22
- Updated
- 2026-09-08 22:07:22
- Origin id
irokaru/pixel-scaler:docs/index.md
README
<div align="center">
<a href="https://irokaru.github.io/pixel-scaler/">
<img src="./public/logo.png" width="33%" alt="Pixel Scaler Logo"/>
</a>
<p><b>A pixel art upscaling tool</b></p>
<!-- Badges -->
<p>
<a href="https://github.com/irokaru/pixel-scaler/releases/latest"><img src="https://img.shields.io/github/v/release/irokaru/pixel-scaler.svg?style=for-the-badge" alt="Latest Release"/></a>
<img src="https://img.shields.io/github/downloads/irokaru/pixel-scaler/total?style=for-the-badge" alt="Downloads"/>
<a href="https://app.codecov.io/gh/irokaru/pixel-scaler/tree/main"><img src="https://img.shields.io/codecov/c/github/irokaru/pixel-scaler?style=for-the-badge" alt="Coverage"/></a>
<a href="https://x.com/IroKaru"><img src="https://img.shields.io/twitter/follow/irokaru?style=for-the-badge" alt="Follow on X"/></a>
<a href="https://ko-fi.com/B0B81Z3389"><img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Ko-fi"/></a>
</p>
</div>
## Development Environment
* bun (>= 1.1.0)
* rust (>=1.85.0)
* (required for Tauri development)
## Setup for Development (WSL)
If you use mise, you can set up the development environment with the following command:
```sh
mise install
```
Install dependencies:
```sh
bun install
```
(Optional) If you want to use Tauri:
```sh
cargo install tauri-cli
# NOTE: https://v2.tauri.app/start/prerequisites/
sudo apt install -y libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev
```
## Available Commands
| Command | Description |
|--------------------------|-------------------------------------------------------------|
| `bun run dev` | Start development server with Vite |
| `bun run dev:tauri` | Start Tauri development server |
| `bun run build` | Build the project for production |
| `bun run build:tauri` | Build the project with tauri |
| `bun run preview` | Preview the built project (requires `bun run build` first) |
| `bun run test` | Run tests |
| `bun run test:watch` | Run tests in watch mode |
| `bun run test:coverage` | Run tests with coverage |
| `bun run test:e2e` | Run tests by playwright |
| `bun run clean` | Remove generated files |
| `bun run lint-staged` | Run linting on staged files |
| `bun run prepare` | Set up Husky for Git hooks |
## Scaling Library
* xBRjs (Copyright 2020 Josep del Rio)
* https://github.com/joseprio/xBRjs