Skip to content

Commit

Permalink
feat: redesign getting-started/literature.md (#226)
Browse files Browse the repository at this point in the history
* feat: initial redesign to `getting-started/literature.md`

- Use Retype description lists for sources and applications

* feat: add mpv-manga-reader

add mpv-manga-reader and instructions on the best setup for it

* fix: clean up `literature.md`

* feat: add custom script installation guide to `mpv.md`

- Amended grammatical/formatting errors

* Re-add searching tips

* fix: use GitHub instead of Imgur

* fix: more clean up to `literature.md`

- Added AnimeBytes download source in Manga
- Added aggregator quality notice
- Move all images in `literature.md` to repo
- Amended grammatical errors

* fix: correct terminology

* fix(literature): minor fixes

---------

Co-authored-by: RainingTerror <[email protected]>
Co-authored-by: Raventric <[email protected]>
  • Loading branch information
3 people authored Jan 11, 2024
1 parent 6f2282f commit d620f21
Show file tree
Hide file tree
Showing 12 changed files with 169 additions and 105 deletions.
217 changes: 135 additions & 82 deletions docs/getting-started/literature.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/sourcing/public-trackers.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Torrents on [Nyaa](https://nyaa.si) are sorted by category. These can be changed

To search for releases in English, use the `- English-translated` option under the various categories.

#### Regex
#### Search Operators

Below is a list of useful regex that can help narrow down your search when looking for torrents:
Below is a list of useful operators that can help narrow down your search when looking for torrents:

Regex | Meaning | Example Usage
------|--------------------------------------------------|----------------------------------------------------------------
Expand Down
Binary file added docs/static/literature/cdisplayex-auto-colors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/cdisplayex-dpi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/cdisplayex-scaling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/cdisplayex-scaling2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/correct-black-levels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/gesturesign-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/incorrect-black-levels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/kujou.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/literature/perfect-viewer-scaling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 32 additions & 21 deletions docs/tutorials/mpv.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ This folder cannot be changed after installation. If you wish to change it in th

[!embed text="Installing mpv on Windows"](/static/playback/mpv/installation-windows.mp4)

==- 🍨 Installing mpv via scoop
==- 🍨 Installing mpv via Scoop

[Scoop](https://scoop.sh) is a command line package manager for Windows. We can use it to install and manage mpv. Scoop downloads and manages packages in a portable way, keeping them neatly isolated in `%userprofile%/scoop` and automatically adds them to your PATH.
[Scoop](https://scoop.sh) is a command line package manager for Windows. Unlike other installation methods, Scoop downloads and manages packages in a portable way, keeping them neatly isolated in `%userprofile%/scoop` and automatically adding them to your PATH.

+++ Installing scoop
Scoop can be installed using their install script in a PowerShell window:

```powershell
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex
```

+++ Installing mpv
Then, install mpv using `scoop`:

```powershell
scoop bucket add extras
Expand Down Expand Up @@ -66,10 +66,10 @@ scoop uninstall mpv-git

==- 📦 Installing a pre-configured build

If you don't want to setup mpv yourself, a portable build of mpv is available below. This is pre-configured to have the settings described in the [Basic Config](#basic-config) and [Advanced Config](#advanced-config) and is updated daily. You can also just grab the `portable_config` folder and add it to your existing mpv installation.
If you don't want to setup mpv yourself, a portable build of mpv is available below. This is pre-configured to have the settings described in the [Basic Config](#basic-config) and [Advanced Config](#advanced-config) and is automatically updated daily. The `portable_config` folder can also be downloaded separately if you wish to add it to your existing mpv installation.

[!file text="mpv" icon="play"](https://github.com/Snaacky/thewiki/releases/tag/mpv)
[!file text="portable_config" icon="package"](https://github.com/Snaacky/thewiki/releases/tag/mpv)
[!file text="portable_config" icon="package"](https://github.com/Snaacky/thewiki/releases/download/mpv/portable_config.7z)

===

Expand Down Expand Up @@ -108,18 +108,20 @@ brew install mpv

### Linux

Distributions usually package outdated, unmaintained, and unsupported versions of mpv. This is especially true for popular distros like Debian and Ubuntu. You are recommended to use mpv-build or third-party packages instead.
!!!warning
Distributions usually package outdated, unmaintained, and/or unsupported versions of mpv. We recommend using mpv-build or third-party packages instead.
!!!

==- 🔧 Installing on various distributions
==- 🔧 Installing mpv with unofficial packages

All of these packages are unofficial:
The following packages are unofficial:

- [Arch (official package)](https://archlinux.org/packages/extra/x86_64/mpv/)
- [Gentoo (official package)](https://packages.gentoo.org/packages/media-video/mpv)
- [Arch (AUR, git package)](https://aur.archlinux.org/packages/mpv-git/)
- [Arch (AUR, mpv-build package)](https://aur.archlinux.org/packages/mpv-build-git/)
- [Debian multimedia](https://deb-multimedia.org/dists/testing/main/binary-amd64/package/mpv)
- [Ubuntu and Debian (apt repository)](https://fruit.je/apt)
- [Arch](https://archlinux.org/packages/extra/x86_64/mpv/) [!badge variant="primary" text="Official"]
- [Gentoo](https://packages.gentoo.org/packages/media-video/mpv) [!badge variant="primary" text="Official"]
- [Arch](https://aur.archlinux.org/packages/mpv-git/) [!badge variant="secondary" text="AUR"] [!badge variant="secondary" text="git"]
- [Arch](https://aur.archlinux.org/packages/mpv-build-git/) [!badge variant="secondary" text="AUR"] [!badge variant="secondary" text="mpv-build"]
- [Debian](https://deb-multimedia.org/dists/testing/main/binary-amd64/package/mpv)
- [Ubuntu/Debian](https://fruit.je/apt) [!badge variant="secondary" text="APT"]

==-

Expand Down Expand Up @@ -154,11 +156,10 @@ By default, mpv's config can be found under `%APPDATA%/mpv/`. However, a folder
└── mpv.conf
```

+++ Scoop (`%userprofile%/scoop/persist/mpv-git/portable_config`)
+++ Scoop (`%userprofile%/scoop/persist/mpv-git`)

```properties

%userprofile%/scoop/persist/mpv-git/
.
└── portable_config/
├── fonts/
├── script-opts/
Expand Down Expand Up @@ -291,7 +292,7 @@ To use the profile, add the following to the top of your `mpv.conf`:
:::code source="/static/tutorials/mpv/portable_config/mpv.conf" range="1-10" language="properties":::

!!!warning
`dither-depth` should be set to match your monitor's bit depth to prevent [banding](#debanding).
`dither-depth` should match your monitor's bit depth to prevent [banding](#debanding).
!!!

This is included in the [Basic Config](#basic-config).
Expand Down Expand Up @@ -355,10 +356,10 @@ sub-ass-style-overrides=Kerning=yes
![Cabin F](/static/tutorials/mpv/cabin-f-cropped.png)

!!!
This is a modified version of Cabin made by **@astolfo69 (RaptoR)** in the [SeaDex discord server](https://discord.com/invite/jPeeZewWRn)
This is a modified version of Cabin made by *@astolfo69 (RaptoR)* in the [SeaDex Discord server](https://discord.com/invite/jPeeZewWRn).
!!!

[!button icon="download" variant="primary" text="Cabin"](/static/playback/fonts/cabin-f.zip)
[!button icon="download" variant="primary" text="Cabin F"](/static/playback/fonts/cabin-f.zip)

Run the `.ttf` font file to install it system-wide or put it in your `fonts` folder. Add the following to your `mpv.conf`:

Expand Down Expand Up @@ -412,6 +413,16 @@ Below is a list of some popular scripts:
- [thumbfast](https://github.com/po5/thumbfast) - Display thumbnails when scrubbing video (may be needed for some [Skins](#skins))
- [trackselect](https://github.com/po5/trackselect) - Select tracks based on their title

==- :icon-gear: Installation

1. Navigate to your mpv [config directory](#config-overview)
2. Locate the `scripts` folder. *You may need to create this folder if it doesn't exist*
3. Drag your script file(s) (e.g. `.lua`) into the folder

Your scripts are automatically loaded when you launch mpv. *If mpv is currently open, you will need to relaunch it in order for your script(s) to take effect.*

==-

### Skins

You can customize how mpv looks using skins. These are subject to personal preference, so find what works best for you.
Expand Down

0 comments on commit d620f21

Please sign in to comment.