Skip to content
This repository has been archived by the owner on Mar 2, 2024. It is now read-only.

Commit

Permalink
docs: Update README.md and README_zh-cn.md
Browse files Browse the repository at this point in the history
  • Loading branch information
smartcmd committed Jun 22, 2023
1 parent 5c94bca commit 191c894
Show file tree
Hide file tree
Showing 4 changed files with 169 additions and 4 deletions.
86 changes: 83 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,85 @@
# ReplayNK
# ReplayNK - MCBE PowerNukkitX camera plugin

Still under development
![ReplayNK](https://socialify.git.ci/PowerNukkitX/ReplayNK/image?description=1&descriptionEditable=ReplayMod%20for%20MCBE!&font=Inter&forks=1&issues=1&language=1&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Light)

If you find any bug, please open an issue here :)
##### English | [简体中文](README_zh-cn.md)

`ReplayNK` is a camera plugin developed for the Bedrock Edition server software `PowerNukkitX`, based on the latest Camera API of MCBE 1.20.0

`Replay NK` has made a lot of optimizations for camera movement, making its camera movement smoother and smoother than the traditional `/teleport`command plus command block to achieve camera movement

`ReplayNK` perfectly supports all available parameters of the original `/camera` command, and adds a series of smoothing algorithms for path smoothing, such as Bézier curves.

`Replay NK` is simple and intuitive to use, with full visual operation, and most of the functions can be activated with one click of a button. At the same time, the plugin supports Chinese and English dual languages, and will automatically switch according to the user's language settings.

## Simple tutorial

### 1. Install plugin

Download the latest plugin jar package from Github Release, put it into the plugin folder of PowerNukkitX, and restart the server. The resource packs required by the plugin are built into the plugin, and you don't need to install additional resource packs.

After startup, the plugin will generate `plugins/ReplayNK/trails` directory and save trail files in this directory

### 2. Commands

The list of available commands for the plugin is as follows, you can also enter `help replaynk` to get command help

`/replaynk create <name>` - Create a new trail preset

`/replaynk remove <name>` - Delete a new trail preset

`/replaynk operate <name>` - Start operating a trail preset

`/replaynk list` - List all trail presets

### 3. Operation Guide

Here are some things that will appear in your inventory after entering the operation mode (`/replay operate`), we will introduce from left to right

![tools.png](img%2Ftools.png)

`Add Marker` - Add a marker

Add a marker, the marker is the basic unit of the track, you can set the camera position, orientation, camera speed and other parameters on the marker. The newly created marker will inherit the player's position and orientation

`Remove Marker` - Remove a marker

Use this tool to click on a marker to delete the marker point. After deleting a marker, the numbers of all subsequent markers will be reduced by one

`Edit Marker` - Edit a marker

Use this tool to click a marker to edit the parameters of this marker

`Marker Picker` - Pick up a marker

This tool is used to move markers quickly. Left click to select a marker and move to a new position right click, the marker you selected will be moved to your new position

`Play` - Play the trail

Right click to play the trail

`Pause` - Stop playing

Right click on this tool while playing to stop playing

`Setting` - Trail settings

Click this tool to open the trail setting interface, where you can set the smoothing type of the trail, the default camera speed, playback speed and other parameters

`Exit` - Exit edit mode

Right click this tool to exit the edit mode

## Troubleshooting

Q: Why do I feel that the camera is still stuck?

A: Due to the limitation of the client, when the speed of the mirror is too high and the distance between the markers is too small, there will be a freeze phenomenon. We have optimized it as much as possible. You can improve this problem by reducing the camera speed or increasing the marker spacing

Q: Why doesn't my camera reset after playback ends?

A: This may be caused by sending packets too fast. You can fix this by using the command `camera @s clear`

## Related projects

- [PowerNukkitX](https://github.com/PowerNukkitX/PowerNukkitX)
85 changes: 85 additions & 0 deletions README_zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# ReplayNK - MCBE PowerNukkitX平台 平滑镜头插件

![ReplayNK](https://socialify.git.ci/PowerNukkitX/ReplayNK/image?description=1&descriptionEditable=ReplayMod%20for%20MCBE!&font=Inter&forks=1&issues=1&language=1&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Light)

##### [English](README.md) | 简体中文

`ReplayNK`是为基岩版`PowerNukkitX`平台开发的平滑镜头模组,基于MCBE 1.20.0最新的Camera API开发

`ReplayNK`针对镜头运动进行了大量的优化,使得其运镜的流畅度和平滑度远高于通过传统的`/teleport`指令加命令方块实现的镜头运动

`ReplayNK`完美支持原版`/camera`命令的所有可用参数,并针对路径平滑添加了一系列平滑算法,例如贝塞尔曲线。

`ReplayNK`使用上手简单直观,全可视化操作,大部分功能只需要点击一下按钮就能启用。同时,插件支持中文/英文双语言,会根据用户的语言设置自动切换。

## 简单使用教程

### 1. 安装插件

在Github Release下载最新的插件jar包,放入PowerNukkitX的插件文件夹内,重启服务器即可。插件所需资源包已内置到插件中,你不需要额外安装资源包。

启动后,插件将生成`plugins/ReplayNK/trails`目录并在此目录下保存轨迹文件

### 2. 命令

插件可用命令列表如下,你也可以输入`/help replaynk`来获取命令帮助

`/replaynk create <name>` - 创建一个新的轨迹预设

`/replaynk remove <name>` - 删除一个新的轨迹预设

`/replaynk operate <name>` - 开始操作一个轨迹预设

`/replaynk list` - 列出所有的轨迹预设

### 3. 操作指南

以下是进入操作模式(`/replay operate`)后你的物品栏将会出现的一些东西,我们将从左往右介绍

![tools.png](img%2Ftools.png)

`Add Marker` - 添加标记点

添加一个标记点,标记点是轨迹的基本组成单位,你可以在标记点上设置镜头的位置、朝向、镜头速度等参数。刚创建的标记点会继承玩家的位置和朝向

`Remove Marker` - 删除标记点

使用此工具点击一个标记点,可以删除这个标记点。删除标记点后,其后的所有标记点的编号将会减一

`Edit Marker` - 编辑标记点

使用此工具点击一个标记点,可以编辑这个标记点的参数

`Marker Picker` - 选取标记点

此工具用于快速移动标记点。左键选取标记点并移动到新位置右键,你选取的标记点将会被移动到你所处的新位置

`Play` - 播放

右键开始播放轨迹

`Pause` - 停止播放

在播放时右键此工具可停止播放

`Setting` - 轨迹设置

点击此工具可打开轨迹设置界面,你可以在此界面设置轨迹的平滑类型,默认镜头速度,播放倍速等参数

`Exit` - 退出操作模式

右键此工具可退出编辑模式

## 疑难解答

Q: 为什么我感觉运镜还是很卡顿?

A: 由于客户端限制,在运镜速度过高/标记点间距过小的情况下会出现卡顿现象,我们已经尽量优化了。你可以通过减小镜头速度或者增大标记点间距来改善这个问题

Q: 为什么播放结束了我的镜头却没有复位?

A: 这可能是由于发包过快导致的。你可以通过使用命令`/camera @s clear`来解决此问题

## 相关项目

- [PowerNukkitX](https://github.com/PowerNukkitX/PowerNukkitX)
Binary file added img/tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<dependency>
<groupId>cn.powernukkitx</groupId>
<artifactId>powernukkitx</artifactId>
<version>1.20.0-r1</version>
<version>1.20.0-r2</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
Expand Down

0 comments on commit 191c894

Please sign in to comment.