Cool_Tools/upscayl
1
0
Fork 0
mirror of https://github.com/upscayl/upscayl.git synced 2024-11-23 15:11:04 +01:00
Code Releases Wiki Activity
🆙 Upscayl - Free and Open Source AI Image Upscaler for Linux, MacOS and Windows built with Linux-First philosophy.
1,017 Commits 14 Branches 34 Tags 645 MiB
TypeScript 89.9%
JavaScript 3.4%
CSS 3.2%
Python 2.8%
Shell 0.7%
main
Go to file
Abhishek Gaonkar c5f4a7eedb
#885 Paste Image from Clipboard (#995) 
This feature fix does the following:

1. modifies handlePaste function to save the image present in clipboard
into the user selected output folder and process it.
2. names the image with hh-mm-ss timestamp and gives output file in
provided folder.

Here is an example with nothing in the clipboard showing an invalid
image error:


![image](https://github.com/user-attachments/assets/c8596354-90d9-497f-9e08-b95ebf955b81)

Here is an example with an image in the clipboard saving in user
selected folder:


![image](https://github.com/user-attachments/assets/3c7e5f84-7fe1-4baa-a282-6b921641b9af)


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Release Notes

- **New Features**
- Users can now paste images directly from the clipboard using the
shortcut Ctrl + V or Cmd + V.
- Enhanced error messages provide clearer guidance when no image is
found in the clipboard or when an output folder is not selected.
- New instructions for pasting images have been added to localization
files in multiple languages.

- **Bug Fixes**
- Improved handling of pasted images with better error notifications for
invalid formats.

- **Documentation**
- Updated localization files for multiple languages, enhancing user
instructions and error descriptions related to image handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-11-17 11:53:40 +05:30
.github attempt to dissuade bug-reporting with the docs template further 2024-11-01 11:20:00 -04:00
build Update icns 2023-10-14 07:07:03 +05:30
common Merge with upstream/main 2024-11-17 11:52:19 +05:30
docs Update API 2024-11-15 12:26:13 +05:30
electron FIX: types issue during runtime 2024-11-10 14:57:04 +05:30
export/build Fix build 2023-10-25 17:14:22 +05:30
flatpak Update flatpak 2023-10-28 14:00:53 +05:30
models Added scale 2023-04-12 18:55:24 +05:30
renderer Merge with upstream/main 2024-11-17 11:52:19 +05:30
resources Fix models 2024-10-30 19:03:41 +05:30
scripts Fix notarize 2023-10-27 18:07:48 +05:30
ups Fixed for v1.5 release 2022-09-19 05:24:45 +05:30
.gitignore Fix notarize 2023-10-27 18:07:48 +05:30
.prettierignore Update plist 2023-10-14 13:21:52 +05:30
.prettierrc Fix lens and update errors. 2024-02-07 06:53:19 +05:30
1080p_banner.jpg Updated flatpak details 2023-06-04 14:09:50 +05:30
1080p_explainer.jpg Updated flatpak details 2023-06-04 14:09:50 +05:30
COMPARISONS.MD Update COMPARISONS.MD 2023-05-10 09:27:18 +05:30
components.json Add shadcn and sidebar options 2024-04-17 21:48:45 +05:30
deno.lock Add deno 2024-11-10 10:24:45 +05:30
download.jpg Updated readme 2022-12-22 17:40:23 +05:30
LICENSE Create LICENSE 2022-08-24 10:18:39 +05:30
mas-dev.json Update mas 2023-11-04 15:32:44 +05:30
mas.json Update buuldversion 2024-06-01 16:23:53 +05:30
news.md Set default show 2023-11-26 13:54:03 +05:30
next.config.js Add Language Switcher (#950) 2024-09-05 21:35:45 -04:00
notarize.js Fix notarize 2023-10-27 18:07:48 +05:30
package-lock.json New models selection menu 2024-10-06 12:45:44 +05:30
package.json New models selection menu 2024-10-06 12:45:44 +05:30
postcss.config.js next and electron template 2022-08-15 10:23:14 +05:30
README.md Update README.md 2024-05-24 18:13:26 +05:30
Real-ESRGAN_LICENSE.txt Add files via upload 2022-08-24 16:23:22 +05:30
screen1.png Updated readme 2022-12-22 17:40:23 +05:30
tailwind.config.js Fix pane 2024-04-20 16:41:03 +05:30
to_upscale.jpeg Added upscaling functionality 2022-08-16 07:47:27 +05:30
tsconfig.json Refactor Renderer Code (#987) 2024-10-04 14:45:54 +05:30
update_upscayl_ncnn_binaries.sh Update binary script 2024-02-09 17:29:41 +05:30
upscayl.mp4 Added mp4 2022-08-24 10:25:15 +05:30

README.md

v2.11 is out! 🥳 Download v2.11! ⬇️

Frame 111



🆙 Upscayl

Free and Open Source AI Image Upscaler

Upscayl lets you enlarge and enhance low-resolution images using advanced AI algorithms. Enlarge images without losing quality. It's almost like magic! 🎩🪄

https://upscayl.org

Contents

👨‍💻 Installation

Important

You'll need a Vulkan compatible GPU (Graphics Card) to upscale images. Many iGPUs (integrated graphics) do not work but, no harm in trying :)

🐧 Linux

Upscayl should be available on the software listings of most Linux operating systems. Your distro's Store app might also support the Flatpak or Snap version.

💼 Portable Method

  1. Go to releases section or our official website.
  2. Download the upscayl-x.x.x-linux.AppImage file.
  3. Right Click AppImage -> Go to Permissions tab -> Check 'allow file to execute' and then double click the file to run Upscayl.

You can also choose to install using other formats like RPM (Fedora), DEB (Debian/Ubuntu based), and ZIP (Any x86 Linux OS).

🍎 macOS

(MacOS 12 and later)

  1. Go to releases section or our official website.
  2. Download the upscayl-x.x.x-mac.dmg file.
  3. Double click dmg, drag Upscayl icon into Applications folder.
  4. Open Finder, click 'Applications' tab in the left sidebar. Find Upscayl and right click on it. Select 'Open'.
  5. In the window that appears, press 'Open' yet again.

🍺 Homebrew

brew install --cask upscayl

🐌 Windows

(Windows 10 and later)

  1. Go to releases section or our official website.
  2. Download the upscayl-x.x.x-win.exe file.
  3. Double click exe file to launch.
  4. If you get a SmartScreen warning - click 'More Info' and then 'Run Anyway' OR press 'YES' on the unverified publisher dialog.
  5. Follow the installation steps.
  6. Profit!

👨‍🏫 Documentation - Tutorials and Guides

Check out our Documentation here.

⚖️ Results

Check out Upscayl before/after comparisons here.

🤫 Roadmap

You can track all the progress here: https://github.com/orgs/upscayl/projects/1

  • Fix bugs
  • Make the whole world use FOSS (WIP 🚧)

🛠 Development

I recommend using Volta: https://volta.sh for installing Node.js. Download and install volta, then do: volta install node.

🏃 Running

Note

If you are not willing to install git, you can skip the first line, download the source zip and extract it to upscayl instead and carry on with the rest of the instructions.

git clone https://github.com/upscayl/upscayl
cd upscayl

# INSTALL DEPENDENCIES
npm install

# RUN THE DEVELOPMENT SERVER LOCALLY
## YOUR LOGS WILL NOW APPEAR IN THE TERMINAL
npm run start

🏗️ Building

# INSTALL DEPENDENCIES
npm install

# PACKAGE THE APP
npm run dist

# PUBLISH THE APP, MAKE SURE TO ADD GH_TOKEN= IN SHELL
# ONLY DO THIS IF YOU'RE A MAINTAINER
npm run publish-app

🤓 FAQ

  • How does Upscayl work?
    • Upscayl uses AI models to enhance your images by guessing what the details could be. It uses Real-ESRGAN and Vulkan architecture to achieve this. Our backend is fully open-source under the AGPLv3 license.
  • I don't see a drastic change in my upscaled image. Why is that?
    • Upscayl can enhance low resolution images and images that are pixelated but it cannot de-blur or do focus adjustment on your image. If your image is out-of-focus or totally blurred, Upscayl is not the right tool for it. Please use images that are similar to the examples we've given here.
  • Is there a CLI available?
  • Do I need a GPU for this to work?
    • Yes, unfortunately. NCNN Vulkan requires a Vulkan-compatible GPU. Upscayl won't work with most iGPUs or CPUs. But hey, no harm in trying ;)
      • @Wyrdgirn has contributed a workaround for Windows and Linux in #390! Nobody knows how to manipulate the macOS and Haiku frameworks...
  • I stopped the magic Batch Upscayl and my images haven't been processed, compressed, or are in the wrong scale!
    • When a model doesn't support an action, Upscayl will finish upscayling all the images first before post-processing them. What this means is that you should simply wait for the process to finish.
  • How can I contribute?
    • You can report issues, fix code and add features by submitting PRs, or donate! 😊
  • What's the GPU ID for?
    • It is for selecting which GPU to use. The specific procedure is detailed in the Wiki.
      • Note that for Windows systems, if Upscayl is not set to performance mode, the system may override this setting.
  • Where do I find more models?

🎁 Donate

❤ Credits

Copyright © 2023 - Upscayl
By Nayam Amarshe and TGS963
Made with 🖱 & ⌨