Skip to content

Commit

Permalink
Update readme, change log and version
Browse files Browse the repository at this point in the history
  • Loading branch information
mchorse committed Jul 1, 2021
1 parent c3230f6 commit 91f9739
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 33 deletions.
31 changes: 29 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
## Aperture 1.6

This update is focused on adding Undo/Redo and limitations for non-OP users.

**Compatible** with McLib `2.3` and Minema `3.5` (optionally). It doesn't mean that future versions of McLib (or Minema) would be incompatible, but older versions are most likely incompatible.

<a href="https://youtu.be/F6b_ScRB3gc"><img src="https://img.youtube.com/vi/F6b_ScRB3gc/0.jpg"></a>

* Added limiting of editing Aperture data (and opening camera editor) on the server to OP only
* Added circular interpolation to path fixture
* Added an option to display everything in seconds (suggested by zoombie)
* Added playback of the scene possible with an empty camera profile
* Added proper handling of fixtures during cutting (suggested by Andruxioid)
* Added alphabetical sorting to camera profile list
* Added **Undo/Redo** (`Ctrl + Z`/`Ctrl + Y`) to camera editor on per camera profile basis
* Added loop region selection (suggested by Chunk7) controlled with:
* `[` (start) and `]` (end) keys
* Ctrl + left click to control left end point, Ctrl + right click to control right end point, and Ctrl + middle click to reset loop selection
* Added a keybind to toggle keyframe editor visibility
* Added periodic auto-save option
* Changed `/aperture play` command's syntax to `/aperture play <camera_profile> [target]`
* Changed `v` velocity variable to take in effect modifiers effects as well
* Fixed `/camera step` and `/camera rotate` not accepting relative `~` values
* Fixed timeline scaling issues
* Fixed drag modifier jumping from 0,0,0 when toggling XYZ toggles
* Fixed camera profiles are not checked when duplicating with existing camera profile name (reported by Andruxioid and Chunk7)

## Aperture 1.5.2

This patch update fixes a couple of bugs.

**Compatible** with McLib `2.2.1` and Minema `3.5` (optionally). It doesn't mean that future versions of McLib (or Minema) would be incompatible, but older versions are most likely incompatible.

* Fix tick markers looking chaotic upon first load (reported by Ник)
* Fix duration of playback defined upon start of playback, which disallows resizing last fixture during playback (reported by Ник and Andruxioid)
* Fixed tick markers looking chaotic upon first load (reported by Ник)
* Fixed duration of playback defined upon start of playback, which disallows resizing last fixture during playback (reported by Ник and Andruxioid)

## Aperture 1.5.1

Expand Down
51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,47 @@
**ATTENTION**: This mod is **no longer being developed**, and it's maintained (bugs and crash fixes) until August/September of 2021. If you wish to continue the mod, feel free to check out the [source code](https://github.com/mchorse/aperture).

![Aperture](https://i.imgur.com/Wras78u.png)

[Planet Minecraft page](https://www.planetminecraft.com/mod/aperture-3978432/)[CurseForge page](https://www.curseforge.com/minecraft/mc-mods/aperture)[GitHub](https://github.com/mchorse/aperture)[Wiki](https://github.com/mchorse/aperture/wiki)

**Disclaimer**: this mod has nothing to do with Aperture Science from Portal games. See the article on what is [Aperture](https://en.wikipedia.org/wiki/Aperture) actually is.

**Aperture** is a Minecraft mod which allows you to create advanced camera movement (for cinematics or machinimas) using camera editor GUI. It works with Forge for Minecraft 1.12.2 (past versions available for 1.10.2 and 1.11.2).

## Features
**Aperture** is a Minecraft mod which allows you to create advanced camera movement (for cinematics or machinimas) using camera editor GUI. It works with Forge for Minecraft 1.12.2 (past versions are available for 1.10.2 and 1.11.2).

**Aperture** mod provides a lot of features for flexible camera editing.
Aperture is also available in Chinese language thanks to [ycwei982](https://www.youtube.com/channel/UCfUDMSGlXUblXimkvNl_7Ww), Chunk7, H2SO4GepaoAX and KuenYo, and Russian language thanks to [Andruxioid](https://www.youtube.com/channel/UCnHOceBjwMyqCR5oYOoNqhQ)!

* **Loadable and saveable camera profiles**. You don't need to worry about losing your camera setup. With Aperture's camera profiles, you can save your camera setup on the server (if the Aperture is installed on the server) or on the client (in `config/aperture/cameras` folder).
* **Duration is measured in ticks**. A tick is basically an update in game's logic. Minecraft's logic loop running at 20 ticks per second. Why ticks? They're static, while frames depend on framerate, and can be easily converted into seconds (while not depending on real-time).
* **Flexible camera setup with multiple camera fixtures within a camera profile**. Other camera mods usually gives you an ability to setup only one path at the time. Aperture allows you to have as much camera paths (and not only) as you need to within same camera profile. There are few types of camera fixtures in Aperture:
* Idle fixture – holds camera in given position and angle.
* Circular fixture – circulate around the center point and facing at it.
* Path fixture – animates the camera through a set of given points using one of the three interpolations: linear, cubic or hermite. Also supports keyframeable velocity control and per point durations.
* Keyframe fixture – allows you create a flexible camera behavior using keyframes (which can have different interpolations, including bézier, and easing).
* Null fixture – a placeholder fixture, which mimics next fixture's first position or previous fixture's last position.
* Manual fixture — allows you to record completely custom movement.
* **More camera flexibility with camera modifiers**. Camera modifiers are modular blocks which post-process camera fixture's output. With these modifiers, you can add camera shake, apply math equation, make a GoPro-like behavior, look at some entity while traveling a path, and much more combined. See [wiki](https://github.com/mchorse/aperture/wiki) for more information.
* **Provides a smooth camera** as a Minema-friendly alternative of vanilla cinematic camera.
* **Compatible with [Minema](https://github.com/daipenger/minema/releases)**, if want to record smooth videos on your Potato PC, install [Minema](https://github.com/daipenger/minema/releases) mod and record smooth videos!
## Install

## Videos
Install [Minecraft Forge](http://files.minecraftforge.net/), download the latest stable version of jar file for available Minecraft version. Also install following mods: [McLib](https://www.curseforge.com/minecraft/mc-mods/mchorses-mclib). Put it in minecraft's `mods` folder, and launch the game.

This playlist is a **tutorial series**. It should teach you how to use Aperture mod from scratch. It bases of Aperture `1.3.4`. Once you watch these videos and learn how to use it, feel free to watch the change log videos for more information about new features.
After that, Aperture mod should be installed and will appear in Minecraft's mods menu. If Aperture didn't appear in the mods menu, then something went wrong.

<a href="https://youtu.be/_KLU8VnMiCQ?list=PLLnllO8nnzE8MGDb6QzE2kt4-KVC1dRRl"><img src="https://img.youtube.com/vi/_KLU8VnMiCQ/0.jpg"></a>
## For whom is this mod for?

Meanwhile, this playlist contains a list of videos about **Aperture's updates**. These are so-called **change log** videos, which showcase new changes added to Aperture mod.
If you want to setup cameras for a Minecraft machinima/roleplay, and you already use [Blockbuster mod](https://www.curseforge.com/minecraft/mc-mods/blockbuster) in **singleplayer**, then this is a mod for you!

<a href="https://youtu.be/nitZlB_kG2w?list=PL6UPd2Tj65nFLGMBqKaeKOPNp2HOO86Uw"><img src="https://img.youtube.com/vi/nitZlB_kG2w/0.jpg"></a>
Aperture mod provides a ton of features to improve your camera (in comparison to other camera):

## Install
* Camera profiles that lets you load and save camera work.
* Camera fixtures are building blocks within camera profile which lets you flexibly setup different camera movement depending on the type of fixture it is.
* Camera modifiers allow to post process movement to apply certain effects on top of camera fixtures.
* Works with [Minema](https://github.com/daipenger/minema/releases).
* And so much more...

Install [Minecraft Forge](http://files.minecraftforge.net/), download the latest stable version of jar file for available Minecraft version. Also install following mods: [McLib](https://www.curseforge.com/minecraft/mc-mods/mchorses-mclib) (version **2.0**). Put it in minecraft's `mods` folder, and launch the game.
Although Aperture has partial support to work on servers, it's not recommended to use on the servers **as these mechanisms are poorly designed**!

After that, Aperture mod should be installed and will appear in Minecraft's mods menu. If Aperture didn't appear in the mods menu, then something went wrong.
## Videos

If you're interested in this project, you might as well follow me on any of social media accounts listed below:
This playlist is a **tutorial series**. It should teach you how to use Aperture mod from scratch. It bases of Aperture `1.3.4`. Once you watch these videos and learn how to use it, feel free to watch the change log videos for more information about new features.

[![YouTube](http://i.imgur.com/yA4qam9.png)](https://www.youtube.com/channel/UCSLuDXxxql4EVK_Ktd6PNbw) [![Discord](http://i.imgur.com/gI6JEpJ.png)](https://discord.gg/qfxrqUF) [![Twitter](http://i.imgur.com/6b8vHcX.png)](https://twitter.com/McHorsy) [![GitHub](http://i.imgur.com/DmTn1f1.png)](https://github.com/mchorse)
<a href="https://youtu.be/_KLU8VnMiCQ?list=PLLnllO8nnzE8MGDb6QzE2kt4-KVC1dRRl"><img src="https://img.youtube.com/vi/_KLU8VnMiCQ/0.jpg"></a>

Also, I would really appreciate if you will support me on Patreon!
Meanwhile, this playlist contains a list of videos about **Aperture's updates**. These are so-called **change log** videos, which showcase new changes added to Aperture mod.

[![Become my Patron](https://i.imgur.com/4pQZ2xW.png)](https://www.patreon.com/McHorse)
<a href="https://youtu.be/F6b_ScRB3gc?list=PL6UPd2Tj65nFLGMBqKaeKOPNp2HOO86Uw"><img src="https://img.youtube.com/vi/F6b_ScRB3gc/0.jpg"></a>

## Bug reports

If you found a bug, or this mod crashed your game, make sure to check this [compatibility table and incompatible mod list](https://github.com/mchorse/mclib/wiki/Compatibility-table-of-McHorse%27s-mods) page. The most frequent issue people encounter is that they didn't install the compatible versions of my mods. Or updated only one mod while using older version of my other mods.

If the versions of the mod are correct, then you can report a bug or a crash to me either on [issue tracker](https://github.com/mchorse/aperture/issues/), or on my [Discord server](https://discord.gg/qfxrqUF). Please, make sure to attach a crash log ([pastebin](http://pastebin.com) please) and description of a bug or crash and the way to reproduce it. Thanks!
If the versions of the mod are correct, then you can report a bug or a crash to me either on [issue tracker](https://github.com/mchorse/aperture/issues/), or on my [Discord server](https://discord.gg/qfxrqUF). Please, make sure to attach a crash log ([pastebin](http://pastebin.com) please) and description of a bug or crash, and the way to reproduce it. Thanks!
5 changes: 3 additions & 2 deletions version.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"homepage": "https://www.curseforge.com/minecraft/mc-mods/aperture",
"1.12.2": {
"1.6": "This update is focused on adding Undo/Redo and limitations for non-OP users.",
"1.5.2": "This patch update fixes a couple of bugs.",
"1.5.1": "This decent patch update adds a couple of neat quality of life camera tweaks.",
"1.5": "This update adds a couple of QoL tweaks and two new awesome features involving keyframes and modifiers.",
Expand Down Expand Up @@ -49,8 +50,8 @@
"1.0": "First release of Aperture mod. This release has everything Blockbuster cameras had but more. It includes its own camera editor, and stuff that other camera mods has. Its all features are frame based, meaning this camera mod would work perfectly with Minema mod and without it."
},
"promos": {
"1.12.2-latest": "1.5.2",
"1.12.2-recommended": "1.5.2",
"1.12.2-latest": "1.6",
"1.12.2-recommended": "1.6",
"1.11.2-latest": "1.3.6",
"1.11.2-recommended": "1.3.6",
"1.10.2-latest": "1.3.6",
Expand Down

0 comments on commit 91f9739

Please sign in to comment.