Skip to content

Commit

Permalink
Updated GLSL Instructions (#190)
Browse files Browse the repository at this point in the history
* Update README.md

* Create GLSL_Instructions_Mac.md

* Create GLSL_Instructions_Plex.md

* Update GLSL_Instructions_Plex.md

* Create GLSL_Instructions.md

* Update README.md

* Update GLSL_Instructions.md

* Update GLSL_Instructions_Plex.md

* Update GLSL_Instructions_Windows.md

* Update GLSL_Instructions.md

* Rename GLSL_Instructions_Plex.md to GLSL_Instructions_Mac_Plex.md

* Create GLSL_Instructions_Mac_IINA.md

* Create GLSL_Instructions_Windows_Plex.md

* Rename GLSL_Instructions_Mac.md to GLSL_Instructions_Mac_MPV.md

* Rename GLSL_Instructions_Windows.md to GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update GLSL_Instructions_Mac_MPV.md

* Add files via upload

* Delete Config.png

* Delete Go to Folder.png

* Update GLSL_Instructions_Mac_MPV.md

* Add files via upload

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Add files via upload

* Add files via upload

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_IINA.md

* Add files via upload

* Add files via upload

* Add files via upload

* Delete Config.png

* Delete Go to mpv.png

* Delete mpv config.png

* Delete Setting.png

* Delete Go to Plex HTPC.png

* Delete Go to Plex.png

* Delete Plex HTPC.png

* Delete Plex.png

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Delete GLSL_Mac_Linux_High-end.zip

* Delete GLSL_Mac_Linux_Low-end.zip

* Delete GLSL_Windows_High-end.zip

* Delete GLSL_Windows_Low-end.zip

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_IINA.md

* Update GLSL_Instructions_Mac_Plex.md

* Add files via upload

* Delete config.png

* Add files via upload

* Delete config.png

* Add files via upload

* Add files via upload

* Delete config.png

* Add files via upload

* Update GLSL_Instructions_Mac_MPV.md

* Delete config.png

* Add files via upload

* Delete config.PNG

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_IINA.md

* Add files via upload

* Add files via upload

* Delete location.png

* Add files via upload

* Add files via upload

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Mac_Plex.md

* Update README.md

* Update GLSL_Instructions_Mac_Plex.md

* Update GLSL_Instructions_Mac_MPV.md

* Update GLSL_Instructions_Linux.md

* Update GLSL_Instructions_Windows_MPV.md

* Update GLSL_Instructions_Windows_Plex.md

---------

Co-authored-by: bloc97 <[email protected]>
  • Loading branch information
Tama47 and bloc97 authored May 27, 2023
1 parent 4ba94b1 commit 8e39551
Show file tree
Hide file tree
Showing 32 changed files with 392 additions and 107 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,19 @@ What Anime4K does provide is a way to upscale, in real time, 1080p anime for 4K

Currently, research is being done on better real-time upscaling for lower resolution or older content.

## **Installation Instructions**
### [Windows (GLSL/MPV)](md/GLSL_Instructions_Windows.md)
### [Linux (GLSL/MPV)](md/GLSL_Instructions_Linux.md)
### [Mac (GLSL/MPV)](md/GLSL_Instructions_Mac.md)
### [Plex (GLSL/MPV)](md/GLSL_Instructions_Plex.md)
## **Installation Instructions**

### Windows
- [(GLSL/MPV)](md/GLSL_Instructions_Windows_MPV.md)
- [(GLSL/Plex)](md/GLSL_Instructions_Windows_Plex.md)

### Linux
- [(GLSL/MPV)](md/GLSL_Instructions_Linux.md)

### Mac
- [(GLSL/MPV)](md/GLSL_Instructions_Mac_MPV.md)
- [(GLSL/IINA)](md/GLSL_Instructions_Mac_IINA.md)
- [(GLSL/Plex)](md/GLSL_Instructions_Mac_Plex.md)

## v4.1 Low resolution experiment
Results from the [experimental SRGAN shaders](https://github.com/bloc97/Anime4K/commit/5f9294d847e724b67f941d1742e3565a0a106291) for 360p -> 4K: (zoom in to view details)
Expand All @@ -30,8 +38,6 @@ The images are sorted by algorithm speed, bicubic being the fastest. [FSRCNNX](h
![Comparison](results/Comparisons/Cropped_Screenshots/Magia_360p_4K.png?raw=true)
![Comparison](results/Comparisons/Cropped_Screenshots/Higurashi_360p_4K.png?raw=true)



## v4

We introduce a line reconstruction algorithm that aims to tackle the distribution shift problem seen in 1080p anime. In the wild anime exhibit a surprising amount of variance caused by low quality compositing due to budget and time constraints that traditional super-resolution algorithms cannot handle. GANs can implicitly encode this distribution shift but are slow to use and hard to train. Our algorithm explicitly corrects this distribution shift and allows traditional "MSE" SR algorithms to work with a wide variety of anime.
Expand Down Expand Up @@ -67,6 +73,7 @@ Counting since `2021-09-19T16:02:06Z` (ISO 8601)

## Projects that use Anime4K
- https://github.com/Blinue/Magpie (General-purpose real-time upscaler for any program/game running on Windows 10)
- https://github.com/imxieyi/Anime4KMetal (Anime4K for Apple platforms based on Metal)


*Note that the following might be using an outdated version of Anime4K. There have been significant quality improvements since v3.*
Expand Down
13 changes: 13 additions & 0 deletions md/GLSL_Instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## **Installation Instructions**

### Windows
- [(GLSL/MPV)](GLSL_Instructions_Windows_MPV.md)
- [(GLSL/Plex)](GLSL_Instructions_Windows_Plex.md)

### Linux
- [(GLSL/MPV)](GLSL_Instructions_Linux.md)

### Mac
- [(GLSL/MPV)](GLSL_Instructions_Mac_MPV.md)
- [(GLSL/IINA)](GLSL_Instructions_Mac_IINA.md)
- [(GLSL/Plex)](GLSL_Instructions_Mac_Plex.md)
87 changes: 39 additions & 48 deletions md/GLSL_Instructions_Linux.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage Instructions (GLSL / MPV) (v4.x)

## Installing and setting up Anime4K for Linux-based Distributions (and other Unix-like OS)
## Installing and Setting Up Anime4K for Linux-based Distributions (and other Unix-like OS)

1. Install `mpv` from repositories of your distribution, some of the common ones are mentioned here
### Fedora Silverblue
Expand All @@ -25,55 +25,46 @@
sudo emerge --ask media-video/mpv`

- Note: make sure to install a version of [**mpv**](https://mpv.io/) that was released after June 2021, older versions [might not work](https://github.com/bloc97/Anime4K/issues/134).

2. Clone the repo using `git clone https://github.com/bloc97/Anime4K.git` , or download the archive files in the [Releases](https://github.com/bloc97/Anime4K/releases)

3. Create a new `shaders` directory in `~/.config/mpv` and move the the `.glsl` shaders there
`mv path/to/glsl/stuff ~/.config/mpv/shaders`
2. Clone the repo using `git clone https://github.com/bloc97/Anime4K.git`, or download the template files and extract them.

- **Optimized shaders for lower-end GPU:**
*(Eg. GTX 980, GTX 1060, RX 570)*
- Download the template files [here](https://github.com/Tama47/Anime4K/releases/download/v4.0.1/GLSL_Mac_Linux_Low-end.zip).
- <details>
<summary>Or click here to install manually.</summary>
<ul>
<li>Copy & Paste the code from <a href="Template/GLSL_Mac_Linux_Low-end/input.conf">input.conf</a> and <a href="Template/GLSL_Mac_Linux_Low-end/mpv.conf">mpv.conf</a> in your <code>input.conf</code> and <code>mpv.conf</code> file.</li>
<li>Then download and extract the shaders from <a href="https://github.com/bloc97/Anime4K/releases">releases</a> and put them in the <code>shaders</code> folder.</li>
</ul>
</details>

- **Optimized shaders for higher-end GPU:**
*(Eg. GTX 1080, RTX 2070, RTX 3060, RX 590, Vega 56, 5700XT, 6600XT)*
- Download the template files [here](https://github.com/Tama47/Anime4K/releases/download/v4.0.1/GLSL_Mac_Linux_High-end.zip).
- <details>
<summary>Or click here to install manually.</summary>
<ul>
<li>Copy & Paste the code from <a href="Template/GLSL_Mac_Linux_High-end/input.conf">input.conf</a> and <a href="Template/GLSL_Mac_Linux_High-end/mpv.conf">mpv.conf</a> in your <code>input.conf</code> and <code>mpv.conf</code> file.</li>
<li>Then download and extract the shaders from <a href="https://github.com/bloc97/Anime4K/releases">releases</a> and put them in the <code>shaders</code> folder.</li>
</ul>
</details>

3. Navigate to `~/.config/mpv` and move the `input.conf`, `mpv.conf` and the `shaders` folder into the `mpv` directory.
`mv path/to/stuff ~/.config/mpv`

![image](https://user-images.githubusercontent.com/45941793/162597836-22de46b1-fd04-4054-a5ec-f83452ed4e13.png)


4. Create an `mpv.conf` file in `~/.config/mpv` if not already present (Follow [this guide](https://wiki.archlinux.org/title/mpv#General_settings) to optimize your configuration.)

5. Create an `input.conf` file in `~/.config/mpv` if not already present and paste one of the following code blocks inside the file:

----
#### **Optimized shaders for higher-end GPU:**
*(Eg. GTX 1080, RTX 2070, RTX 3060, RX 590, Vega 56, 5700XT, 6600XT)*
*If upscaling to resolutions smaller than 4K, lower end GPUs can be used.*
```
CTRL+1 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_VL.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode A (HQ)"
CTRL+2 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_Soft_VL.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode B (HQ)"
CTRL+3 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Upscale_Denoise_CNN_x2_VL.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode C (HQ)"
CTRL+4 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_VL.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl:~~/shaders/Anime4K_Restore_CNN_M.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode A+A (HQ)"
CTRL+5 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_Soft_VL.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Restore_CNN_Soft_M.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode B+B (HQ)"
CTRL+6 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Upscale_Denoise_CNN_x2_VL.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Restore_CNN_M.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode C+A (HQ)"
CTRL+0 no-osd change-list glsl-shaders clr ""; show-text "GLSL shaders cleared"
```
____
**Optimized shaders for lower-end GPU:**
*(Eg. GTX 980, GTX 1060, RX 570)
These specs are approximated (and overestimated just in case) using TFLOPS, community benchmarks are needed...*
*If upscaling to resolutions smaller than 4K, lower end GPUs can be used.*
```
CTRL+1 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_M.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_S.glsl"; show-text "Anime4K: Mode A (Fast)"
CTRL+2 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_Soft_M.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_S.glsl"; show-text "Anime4K: Mode B (Fast)"
CTRL+3 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Upscale_Denoise_CNN_x2_M.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_S.glsl"; show-text "Anime4K: Mode C (Fast)"
CTRL+4 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_M.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl:~~/shaders/Anime4K_Restore_CNN_S.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_S.glsl"; show-text "Anime4K: Mode A+A (Fast)"
CTRL+5 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Restore_CNN_Soft_M.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Restore_CNN_Soft_S.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_S.glsl"; show-text "Anime4K: Mode B+B (Fast)"
CTRL+6 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl:~~/shaders/Anime4K_Upscale_Denoise_CNN_x2_M.glsl:~~/shaders/Anime4K_AutoDownscalePre_x2.glsl:~~/shaders/Anime4K_AutoDownscalePre_x4.glsl:~~/shaders/Anime4K_Restore_CNN_S.glsl:~~/shaders/Anime4K_Upscale_CNN_x2_S.glsl"; show-text "Anime4K: Mode C+A (Fast)"
CTRL+0 no-osd change-list glsl-shaders clr ""; show-text "GLSL shaders cleared"
```
____
## Usage Instructions for Anime4K

1. For Anime4K v4.x, instead of activating a single shader, you should use a combination of shaders.<br/>Add one of the following code blocks to `input.conf` to allow enabling the shaders:

2. Anime4K v4.x has 3 major modes: A, B and C. To enable one of the modes, press CTRL+1 for mode A, CTRL+2 for B and so on. CTRL+0 will clear and disable all the shaders. Each mode is optimized for a different class of anime degradations, explanations are further down (soon in the wiki). For now you can just try each mode (starting from A) and use the one that looks the best.
3. To verify the installation was correctly done, enable one of the Anime4K modes and use the MPV profiler to check if there are a few shaders with the name Anime4K running. To access the profiler, press Shift+I and then 2 on the keyboard's top row.
This is what you should see (this example is from v2.0RC2, but also applies to newer versions):
![Profiler](../results/MPV_Profiler.png?raw=true)
4. For advanced usage and more customization options, see the [Advanced Usage Instructions](GLSL_Instructions_Advanced.md) page.
## Quick Usage Instructions

1. Anime4K has 3 major modes: A, B, and C. Each mode is optimized for a different class of anime degradations.
- Mode A is automatically enabled, if you use our template (this can be change in `mpv.conf`).

2. To enable each mode manually:
- Press **CTRL+1** to enable Mode A (Optimized for 1080p Anime).
- Press **CTRL+2** to enable Mode B (Optimized for 720p Anime).
- Press **CTRL+3** to enable Mode C (Optimized for 480p Anime).
- Press **CTRL+0** to clear all shaders (Disable Anime4K).

3. For more explanations and customization options, see the [Advanced Usage Instructions](GLSL_Instructions_Advanced.md#advanced-usage-instructions-glsl--mpv-v4x).
34 changes: 34 additions & 0 deletions md/GLSL_Instructions_Mac_IINA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Usage Instructions (GLSL / IINA) (v4.x)

## Installing and Setting Up Anime4K for IINA on Apple Silicon and Intel-based Mac

The easiest way to use Anime4K with IINA is to follow our `mpv` guide [**here**](GLSL_Instructions_Mac_MPV.md).
- *Note: you may need to create the `mpv` folder, if you did not install mpv.*

Then follow these steps:

1. Download the latest release of [IINA](https://iina.io/download/), if you haven't already.

2. Open IINA and click on `IINA` in the top menu bar. Then click on `Settings...` from the drop-down menu.

<img width="400" src="Screenshots/Mac/IINA/Settings.png">

3. In the `Settings`>`Advanced` window, click on `Enable advanced settings` and then select `Use config directory: ~/.config/mpv/`.

<img width="800" src="Screenshots/Mac/IINA/Advanced.png">

4. That's it! Anime4K is now ready to use with IINA.

____
## Quick Usage Instructions

1. Anime4K has 3 major modes: A, B, and C. Each mode is optimized for a different class of anime degradations.
- Mode A is automatically enabled, if you use our template (this can be change in `mpv.conf`).

2. To enable each mode manually:
- Press **CTRL+1** to enable Mode A (Optimized for 1080p Anime).
- Press **CTRL+2** to enable Mode B (Optimized for 720p Anime).
- Press **CTRL+3** to enable Mode C (Optimized for 480p Anime).
- Press **CTRL+0** to clear all shaders (Disable Anime4K).

3. For more explanations and customization options, see the [Advanced Usage Instructions](GLSL_Instructions_Advanced.md#advanced-usage-instructions-glsl--mpv-v4x).
71 changes: 71 additions & 0 deletions md/GLSL_Instructions_Mac_MPV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Usage Instructions (GLSL / MPV) (v4.x)

## Installing and Setting Up Anime4K for mpv on Apple Silicon and Intel-based Mac

*If you wish to use another media player, look at their documentation on how to install GLSL shaders and modify the shader accordingly if needed.*

1. Install mpv via [Homebrew](https://formulae.brew.sh/formula/mpv) or download the latest release [here](https://laboratory.stolendata.net/~djinn/mpv_osx/mpv-latest.tar.gz).
- **Note:** Only the Homebrew version is built for native Apple Silicon.
- <details>
<summary>Click Here for Homebrew Installation</summary>
<ol type="1">
<li>If Homebrew is not installed, follow the instructions at <a href="https://brew.sh">https://brew.sh</a> to install it.</li>
<li>Keep the terminal window open and follow the instructions under "Next steps" to add Homebrew to your PATH.</li>
<li>Follow the instructions at <a href="https://formulae.brew.sh/formula/mpv">https://formulae.brew.sh/formula/mpv</a> to install mpv.</li>
</ol>
</details>

2. Open mpv (this will create the mpv config file location for you).

3. Download the template files and extract them (open the `.zip` file).

- **Optimized shaders for lower-end GPU:**
*(Eg. M1, M2, Intel chips)*
- Download the template files [here](https://github.com/Tama47/Anime4K/releases/download/v4.0.1/GLSL_Mac_Linux_Low-end.zip).
- <details>
<summary>Or click here to install manually.</summary>
<ul>
<li>Copy & Paste the code from <a href="Template/GLSL_Mac_Linux_Low-end/input.conf">input.conf</a> and <a href="Template/GLSL_Mac_Linux_Low-end/mpv.conf">mpv.conf</a> in your <code>input.conf</code> and <code>mpv.conf</code> file.</li>
<li>Then download and extract the shaders from <a href="https://github.com/bloc97/Anime4K/releases">releases</a> and put them in the <code>shaders</code> folder.</li>
</ul>
</details>

- **Optimized shaders for higher-end GPU:**
*(Eg. M1 Pro, M1 Max, M1 Ultra, M2 Pro, M2 Max, Intel chips)*
(Untested, might still have performance issues)
- Download the template files [here](https://github.com/Tama47/Anime4K/releases/download/v4.0.1/GLSL_Mac_Linux_High-end.zip).
- <details>
<summary>Or click here to install manually.</summary>
<ul>
<li>Copy & Paste the code from <a href="Template/GLSL_Mac_Linux_High-end/input.conf">input.conf</a> and <a href="Template/GLSL_Mac_Linux_High-end/mpv.conf">mpv.conf</a> in your <code>input.conf</code> and <code>mpv.conf</code> file.</li>
<li>Then download and extract the shaders from <a href="https://github.com/bloc97/Anime4K/releases">releases</a> and put them in the <code>shaders</code> folder.</li>
</ul>
</details>

4. In the Finder on your Mac, choose `Go` > `Go to Folder...`

<img width="500" src="Screenshots/Mac/Finder.png">

5. Paste `~/.config/mpv/` and hit Enter.

<img width="500" src="Screenshots/Mac/mpv/location.png">

6. Move the `input.conf`, `mpv.conf`, and the `shaders` folder into the `mpv` folder.

<img width="800" src="Screenshots/Mac/mpv/config.png">

7. That's it! Anime4K is now installed and ready to use.

____
## Quick Usage Instructions

1. Anime4K has 3 major modes: A, B, and C. Each mode is optimized for a different class of anime degradations.
- Mode A is automatically enabled, if you use our template (this can be change in `mpv.conf`).

2. To enable each mode manually:
- Press **CTRL+1** to enable Mode A (Optimized for 1080p Anime).
- Press **CTRL+2** to enable Mode B (Optimized for 720p Anime).
- Press **CTRL+3** to enable Mode C (Optimized for 480p Anime).
- Press **CTRL+0** to clear all shaders (Disable Anime4K).

3. For more explanations and customization options, see the [Advanced Usage Instructions](GLSL_Instructions_Advanced.md#advanced-usage-instructions-glsl--mpv-v4x).
Loading

0 comments on commit 8e39551

Please sign in to comment.