Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
xTracr committed Mar 11, 2024
1 parent bba7c5c commit 46df0ce
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 23 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,17 @@ Snapshots are [here](https://github.com/xTracr/RealCamera/actions/workflows/buil

## Features ##

* Bind the camera to a specific part of the body (support most mod models in theory).
* Bind the camera to a specific part of the body.
* Customize the position and rotation of the camera.
* Render player model in first-person perspective.
* Use F6 to toggle the feature on or off and other hotkeys to adjust the camera.
* Configure these features in the config screen (Cloth Config required).
* Theoretically, most mod models are supported, but need to be configured manually:
* First, set the key binding for `Open Model View GUI`.
* Open the model view gui and left click with left Alt held to select the corresponding face of the model, scroll with left Alt held to switch between the different layers of the model.
* By clicking the `Selecting` button on the left, switch between the three to select the `Forward Vector`, `Upward Vector`, and `Target Plane`.
* Enter the `Preview` section, where you can see the relative relationship between the camera and the model and make certain adjustments (you can also adjust through key bindings).
* Enter a name and save (if needed, other settings can be changed).

### Dependencies ###

Expand All @@ -40,8 +46,5 @@ Snapshots are [here](https://github.com/xTracr/RealCamera/actions/workflows/buil
* Compatible:
* most camera mods
* most player model mods
* Not Enough Animations[^1]

[^1]: It is suggested to disable the `Animation Smoothing` option in the config of *Not Enough Animations*.

## [Change Log](changelog.md#English) ##
13 changes: 8 additions & 5 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@

## 特性 ##

* 将摄像头绑定到身体的某个部位(理论上支持大多数模组模型)
* 将摄像头绑定到身体的特定部位
* 自定义摄像头的位置和旋转角度
* 在第一人称视角下渲染玩家模型
* 按下F6来开关,另外一些键来调整摄像头
* 在Config界面配置以上特性(需Cloth Config)
* 在配置界面配置以上特性(需Cloth Config)
* 理论上支持大多数模组模型,但需要手动进行配置:
* 首先设置`打开模型视图界面`的按键绑定
* 打开模型视图界面,左Alt+左键选择模型的对应的面,左Alt+滚轮可以在模型的不同层间切换
* 通过点击左侧的`选择`按钮,在三者间切换,选好`向前矢量``向上矢量``目标平面`
* 进入`预览`部分,在这里可以看到摄像头与模型的相对关系并进行一定的调整(也可以通过按键绑定调整)
* 输入名称并保存(如果需要,还有其他设置可以更改)

### 依赖项目 ###

Expand All @@ -37,8 +43,5 @@
* 兼容:
* 多数摄像头模组
* 多数模型模组
* Not Enough Animations[^1]

[^1]:建议在 *更多动画* 的配置内禁用`Animation Smoothing`选项。

## [更新日志](changelog.md#中文) ##
14 changes: 6 additions & 8 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,16 @@
### Test Versions ###

* 0.6:
* 0.6.0-alpha.1:
* 0.6.0-alpha:
* Added model view screen
* Allowed to select the model part you want to bind directly in the screen
* 0.6.0-alpha.2:
* Fixed #41, #46 and #48
* Fix minor grammar errors (#44)
* Optimized the GUI display and changed logic of selection button
* Changed the way to render player
* Added pause button and show cube button
* Allowed to disable rendering vertices based on depth relative to screen
* Added 'AutoBind' feature
* 0.6.0-alpha.3:
* Changed to bind based on UV coordinates and improved GUI
* Fixed #54
* Improved Gui and Fixed a bug that would cause crash
Expand All @@ -29,9 +27,10 @@
* Added 'preview' feature
* Removed commands
* Improved default configs and reformatted code
* 0.6.0-alpha.4:
* Removed deprecated code
* Added 'priority' to binding targets
* Fixed #59
* Fixed #60
* 0.6.0-beta:
* Optimized some codes

Expand Down Expand Up @@ -126,18 +125,16 @@
### 测试版 ###

* 0.6:
* 0.6.0-alpha.1:
* 0.6.0-alpha:
* 添加了模型视图界面
* 允许在界面中选择想要绑定的模型部位
* 0.6.0-alpha.2:
* 修复了#41#46#48
* 修复了一些语法问题(#44
* 优化了GUI显示效果以及修改了选择按钮的逻辑
* 修改了渲染玩家的方式
* 添加了暂停按钮和显示立方体按钮
* 允许根据相对于屏幕的距离禁用渲染部分顶点
* 添加了'自动绑定'功能
* 0.6.0-alpha.3:
* 改为基于UV坐标绑定并且改进了GUI
* 修复了#54
* 改进了GUI,修复了一个会导致崩溃的问题
Expand All @@ -148,9 +145,10 @@
* 添加了'预览'功能
* 移除了命令
* 改进了默认配置,重新格式化代码
* 0.6.0-alpha.4:
* 移除了已弃用的代码
* 为绑定目标添加了'优先级'
* 修复了#59
* 修复了#60
* 0.6.0-beta:
* 优化了部分代码

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ private void initLeftWidgets(final int category) {
textureIdField = createTextField(widgetWidth * 2 + 4, textureIdField);
textureIdField.setMaxLength(1024);
scaleField = createFloatField(widgetWidth, 1.0f, scaleField).setMax(64.0f);
depthField = createFloatField(widgetWidth, 0.2f, depthField).setMax(4.0f);
depthField = createFloatField(widgetWidth, 0.2f, depthField).setMax(16.0f);
if (category == 0) {
adder.add(entityPitchSlider, 2);
adder.add(entityYawSlider, 2);
Expand Down
4 changes: 2 additions & 2 deletions common/src/main/resources/assets/realcamera/lang/en_us.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"screen.widget.xtracr_realcamera.modelView_selectMode": "Selecting",
"screen.widget.xtracr_realcamera.modelView_forwardMode": "Forward Vector",
"screen.widget.xtracr_realcamera.modelView_upwardMode": "Upward Vector",
"screen.widget.xtracr_realcamera.modelView_posMode": "Plane",
"screen.widget.xtracr_realcamera.modelView_posMode": "Target Plane",
"screen.widget.xtracr_realcamera.modelView_save": "Save",
"screen.widget.xtracr_realcamera.modelView_settings": "Settings",
"screen.widget.xtracr_realcamera.modelView_preview": "Preview",
Expand All @@ -60,7 +60,7 @@
"screen.widget.xtracr_realcamera.modelView_pitch": "Pitch = %s",
"screen.widget.xtracr_realcamera.modelView_yaw": "Yaw = %s",
"screen.widget.xtracr_realcamera.modelView_roll": "Roll = %s",
"screen.tooltip.xtracr_realcamera.modelView_selectMode": "Hold left Alt and left click to get the UV coordinates at the mouse pointer\nThe three sets of UV coordinates below are, from top to bottom, the forward vector, the upward vector, and the UV coordinates of the plane's center\nNote: Scroll with left Alt held to switch between the different layers of model. Manually inputting UV coordinates allows you to bind more accurately to the target position",
"screen.tooltip.xtracr_realcamera.modelView_selectMode": "Hold left Alt and left click to get the UV coordinates at the mouse pointer\nThe three sets of UV coordinates below are, from top to bottom, the UV coordinates of the forward vector, the upward vector, and a point on the target plane\nNote: Scroll with left Alt held to switch between the different layers of the model. Manually inputting UV coordinates allows you to bind more accurately to the target position",
"screen.tooltip.xtracr_realcamera.modelView_textureId": "The texture id of the selected model (not necessary to be the full id), can be shortened when saving to make it easier to recognize.\nFor example, shorten minecraft:textures/entity/player/slim/alex.png to minecraft:textures/entity/player/.",
"screen.tooltip.xtracr_realcamera.modelView_bindButtons": "When disabled, the camera's relative relationship to the model will not change, but the camera's corresponding attributes will not be modified by this mod",
"screen.tooltip.xtracr_realcamera.modelView_scale": "Scale, which controls the size of the offsets",
Expand Down
4 changes: 2 additions & 2 deletions common/src/main/resources/assets/realcamera/lang/zh_cn.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"screen.widget.xtracr_realcamera.modelView_selectMode": "选择",
"screen.widget.xtracr_realcamera.modelView_forwardMode": "向前矢量",
"screen.widget.xtracr_realcamera.modelView_upwardMode": "向上矢量",
"screen.widget.xtracr_realcamera.modelView_posMode": "平面",
"screen.widget.xtracr_realcamera.modelView_posMode": "目标平面",
"screen.widget.xtracr_realcamera.modelView_save": "保存",
"screen.widget.xtracr_realcamera.modelView_settings": "设置",
"screen.widget.xtracr_realcamera.modelView_preview": "预览",
Expand All @@ -60,7 +60,7 @@
"screen.widget.xtracr_realcamera.modelView_pitch": "俯仰角 = %s",
"screen.widget.xtracr_realcamera.modelView_yaw": "偏航角 = %s",
"screen.widget.xtracr_realcamera.modelView_roll": "翻滚角 = %s",
"screen.tooltip.xtracr_realcamera.modelView_selectMode": "按住左Alt并左键可获取鼠标指针处的UV坐标\n下方三组UV坐标由上到下依次为向前矢量、向上矢量和平面中心的UV坐标\n注:按住左Alt键滚动可在模型的不同层间切换,手动输入UV坐标可以更加精确地绑定到目标位置",
"screen.tooltip.xtracr_realcamera.modelView_selectMode": "按住左Alt并左键可获取鼠标指针处的UV坐标\n下方三组UV坐标由上到下依次为向前矢量、向上矢量和目标平面上一个点的UV坐标\n注:按住左Alt键滚动可在模型的不同层间切换,手动输入UV坐标可以更加精确地绑定到目标位置",
"screen.tooltip.xtracr_realcamera.modelView_textureId": "被选中的模型的纹理的id(不是完整的id也可以识别),保存时可以缩短一部分以便于程序识别\n比如将minecraft:textures/entity/player/slim/alex.png缩短为minecraft:textures/entity/player/",
"screen.tooltip.xtracr_realcamera.modelView_bindButtons": "当禁用时,摄像头与模型的相对关系不会变化,但摄像头的对应属性不会被本模组修改",
"screen.tooltip.xtracr_realcamera.modelView_scale": "缩放比例,控制偏移量的大小",
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ forge_version=1.20.1-47.2.20
fabric_loader_version=0.15.7
yarn_mappings=1.20.1+build.10
# Mod Properties
mod_version=0.6.0-alpha.5
mod_version=0.6.0-beta
maven_group=com.xtracr.realcamera
archives_base_name=realcamera
# Dependencies
Expand Down

0 comments on commit 46df0ce

Please sign in to comment.