Skip to content

Commit

Permalink
Edit README and in game mod icon
Browse files Browse the repository at this point in the history
  • Loading branch information
UltimateBoomer committed Feb 15, 2021
1 parent 24747de commit f9bdc30
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 5 deletions.
Binary file removed GitHub/16kscrshot.png
Binary file not shown.
Binary file added GitHub/mainsettings.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 GitHub/screenshotsettings.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 removed GitHub/settings.png
Binary file not shown.
78 changes: 73 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,82 @@
<img width=256px src="GitHub/logo.png" />
</p>

# Resolution Control
# ResolutionControl+

Resolution Control allows you to render Minecraft's 3D portion (i.e. the main game, but not the HUD/GUIs/etc.) at a lower resolution, using nearest-neighbor upsampling. It even has a snazzy settings screen (open by pressing `P` by default) allowing you to adjust this as you go.
ResolutionControl+ is a fork of [Resolution Control](https://github.com/juliand665/Resolution-Control)
with additional functionality.

Download in [the releases section](https://github.com/juliand665/Resolution-Control/releases) or on [CurseForge](https://www.curseforge.com/minecraft/mc-mods/resolution-control).
## Features

![settings](GitHub/settings.png)
### Resolution Scaling

ResolutionControl+ allows you to change Minecraft's render resolution separately from the HUD elements.
If you have a good GPU, you can increase the multiplier for anti-aliasing.
Otherwise, you can lower the multiplier to improve performance or give Minecraft a retro style.
You can also set a custom multiplier value by pressing the `S` button.

Additionally, you can set the upscale/downscale algorithm used to scale the render to the viewport.
Linear is useful as an anti-aliasing filter,
and nearest neighbor generally looks better for lower than native resolutions.

![main](GitHub/mainsettings.png)

---

### Screenshots

ResolutionControl+ can be used to take larger than native resolution screenshots.
To do this, use the `Screenshot Framebuffer` keybind which is unbound by default.

Compared to *Fabrishot*, this implementation does not lock up the game until the screenshot is saved.
This makes taking large screenshots is much faster.
And while a screenshot is being processed, you can take another one without any problems.

Here is the time it takes to take a 16k screenshot, on an i7 4770 and GTX 1060:

```
Fabrishot: 12 seconds (pause)
ResolutionControl+: <1 second (initial pause) + 13 seconds (background processing)
```

[![screenshot](http://img.youtube.com/vi/Dghj0Ldeu0Q/0.jpg)](http://www.youtube.com/watch?v=Dghj0Ldeu0Q)

---

I created this mod mainly because Minecraft 1.13 made it render at full- rather than half-resolution on retina monitors, causing it to run really badly on my computer. Any way of downscaling I tried resulted in linear upsampling (rather than the nearest-neighbor upsampling Minecraft used to have), which looked blurry and terrible. Enter **Resolution Control**, the answer to your prayers!
## Settings

**Resolution Scaling**

- Render scale
- 0.0 - 8.0x (can be exceeded by manually setting the value)
- An estimate VRAM usage is displayed
- Upscale/downscale algorithm
- Linear, nearest

**Screenshots**

- Use set size
- Enabled: render screenshots at the specified resolution
- Note: can produce artifacts if the screenshot aspect ratio is significantly different
from the aspect ratio of the viewport
- Disabled: render at the scaled render resolution
- Always allocated
- Enabled: screenshot framebuffer is always allocated in memory
- May reduce screenshot pause times, at the cost of more VRAM usage during normal gameplay
- Disabled: screenshot framebuffer is allocated on-demand and freed immediately after
- Screenshot size
- Screenshot size if `use set size` is enabled
- An estimate VRAM usage is displayed

---

## Compatibility

Currently, ResolutionControl+ **does not work with Fabulous Graphics**.

**Sodium** - Compatible

**Canvas Renderer** - Mostly compatible, lower resolutions break HUD item rendering

**Optifine** - Compatible, stacks with its own render scale implementation

Binary file modified src/main/resources/assets/resolutioncontrol/icon.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 removed src/main/resources/assets/resolutioncontrol/icon.psd
Binary file not shown.

0 comments on commit f9bdc30

Please sign in to comment.