pascallj / mineshot-revived-fabric

A revived version of Mineshot: "A revamped version of Notch's huge screenshot function" (and now for Fabric)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mineshot Revived (Fabric mod for Minecraft)

Mineshot Revived is a mod for Minecraft (using Fabric) for creating high-resolution screenshots, optionally using the orthographic camera.

This can be useful for a variety of scenarios:

  • High quality wallpapers
  • Poster images
  • Map overviews
  • Mob and block images for the Minecraft Wiki

The majority of the code is based on the original Mineshot by Barracuda. So, many thanks to the original creator. Unfortunately that project seems dead, probably because of the big changes which were introduced.

The main purpose of this project is to keep Mineshot alive by updating for newer Minecraft/Fabric versions. I previously ported a version for Minecraft Forge as well, but during the development I discovered that I prefer Fabric much more. Especially the fast updates for new Minecraft versions. I'll keep the old project around for now, but I am not sure if there will be any future updates.

There is support for Minecraft 1.19, while old versions are available for 1.18.x, 1.17 and 1.16.x.

Requirements

Both the Fabric API and Mod Menu are required for this mod to function.

Usage

The controls are slightly different compared to the original Mineshot:

  • F9: Take screenshot
  • Numpad 4: Rotate left
  • Numpad 6: Rotate right
  • Numpad 8: Rotate up
  • Numpad 2: Rotate down
  • Numpad 7: Top view
  • Numpad 1: Front view
  • Numpad 3: Side view
  • Numpad 5: Switch between perspective and orthograpic projection
  • MOD-key (Left Alt) + Numpad 5: Switch between fixed and free camera
  • MOD-key (Left Alt) + Numpad 2/4/6/8: Step through angles at a fixed rate
  • Plus: Zoom in
  • Minus: Zoom out
  • Multiply: Turn clipping off
  • Divide: Render full 360 degrees around player
  • Demical dot: Change the background color between sky, red and white

The key-bindings can be changed in the Minecraft Controls menu.

The configuration menu can be accessed via Mod Menu options. In here you can change the resolution of the screenshot and if you want to be notified of new development versions (you will always be notified on the title screen of new stable versions).

Please note that the screenshots created will be huge (4K is already 23,7 MB), so choose your resolution carefully. The screenshot will be a Targa image file and will therefore be limited to 65535 by 65535 pixels.

Known limitations

There are several features which aren't working (yet) in Mineshot Revived:

  • Tiled rendering: only off-screen framebuffer rendering for now

Download

Depending on the Minecraft version you want to use Mineshot on, you need different versions as can be seen in the tables below:

Minecraft Version Mineshot version
1.19.3–1.19.4 5.1.0
1.19–1.19.2 4.0.0

Discontinued

Minecraft Version Mineshot version
1.18 3.1.2
1.17 2.0.0
1.16 1.0.0

Compiled jars are available on the releases page.

Development

If you want to help develop this mod, feel free to open issues and/or pull requests. A feature request can also be opened as an issue. Please provide as much details as you can when opening issues or pull requests.

A PR should target the master branch if it targets the latest stable Minecraft release, the next branch if it targets the next development version of Minecraft and the branch with the corresponding version number (e.g., 1.19) when it targets a backport bug/issue.

About

A revived version of Mineshot: "A revamped version of Notch's huge screenshot function" (and now for Fabric)

License:GNU General Public License v3.0


Languages

Language:Java 100.0%