Barotrauma Character Viewer

Barotrauma Wearable Editor

A react based Barotrauma Wearable Editor. (Currently is more like a viewer). Built with Electron, the application can run on windows pc.

Github: https://github.com/ToumanLin/hack_react_proj Actually this repo is my summer class final proj, so maybe in the future i'll switch to another repo

Features

- [b]Visual Character Display[/b]: See a live-updating preview of your character as you make changes.
- [b]Gender, Head Attachment Changing[/b]: Load and view sprites for the character's body, head, and attachments. You can switch genders.
- [b]Advanced Clothing Editor[/b]:
  - Select any piece of clothing from the game's files.
  - View clothing sprite sheets directly in the application.
  - Enable [u]Edit Mode[/u] to visually select and modify individual clothing sprites.
  - [b]Sprite Editor Panel[/b] allows you to change:
    - `sourceRect`: The position and dimensions of the sprite on the sheet.
    - `origin`: The visual center of the sprite.
    - `calcualted scale`: The size of the sprite. [b] important:[/b] the scale here is the calculated final value based on limb scale, texture scale, ragdoll scale, so it is not the pure value you entered into xml.
- [b]Interactive UI Panels[/b]: All tools are housed in draggable and collapsible panels, allowing you to customize your workspace.
  - [b]Limb Panel[/b]: change the position, rotation, and depth of limb
  - [b]Gender Panel[/b]: switch gender and vars loaded from human.xml
  - [b]Head Panel[/b]: change head, hair, beard, etc.
  - [b]Clothing Manager[/b]: Search and select clothing items.
  - [b]Sheet Viewer[/b]: View sprite sheets and access the editor.
  - [b]Joints Panel[/b]: View and construct character joints.

How to Use (For Users)

1. Download: subscribe to this mod and unzip.
2. Prepare Assets: You will need to place your mod into the assets folder. The application use Human.xml and HumanDefaultRagdoll.xml to create human character.

• if your mod have Human.xml and HumanDefaultRagdoll.xml, just delete everything existed in the assets folder and put your mod into it
• if your mod don't have Human.xml and HumanDefaultRagdoll.xml, you need a base human character mod, such as Vanilla, my EAHI. Integrate your mod into the base mod, for example:

Base mod's filelist.xml
<contentpackage name="**" .../>
  <!-- Add your mod paths --!>
  <item path="%ModDir%/..." />
  <!-- existing paths --!>
  <character path="%ModDir%/../../Human.xml" />
  ...
<contentpackage />

Your folder structure should look like this:

    /Mod/
    |-- Barotrauma Character Editor-portable.exe
    |-- /assets/ <-- Treat it as %ModDir%
        |-- filelist.xml <-- Make sure filelist.xml is in this position
        |-- (You mod content)

The application workflow:
1. read the filelist.xml to locate Human.xml to get genders, hairs, etc.
2. Use Human.xml to locate HumanDefaultRagdoll.xml to create limbs.
3. use filelist.xml to get all item.xml, filter those with `wearable` elements and list them into the clothManager panel.

3. Launch: Run the .exe file.

潜渊症服装编辑器

一个基于 React 的潜渊症服装编辑器。（目前更像是一个查看器）。该应用程序使用 Electron 构建，可以在 Windows 电脑上运行。

Github: https://github.com/ToumanLin/hack_react_proj 实际上这个仓库是我的暑期课程期末项目，所以未来我可能会换到另一个仓库。

功能

- [b]可视化角色显示[/b]：在进行更改时，可以实时预览角色的更新。
- [b]性别、头部附属物更换[/b]：加载并查看角色的身体、头部和附属物的精灵图。你可以切换性别。
- [b]高级服装编辑器[/b]：
  - 从游戏文件中选择任何一件服装。
  - 直接在应用程序中查看服装精灵图纸。
  - 启用[u]edit[/u]以可视化地选择和修改单个服装精灵图。
  - [b]精灵图编辑器面板[/b]允许你更改：
    - `sourceRect`：精灵图在图纸上的位置和尺寸。
    - `origin`：精灵图的视觉中心。
    - `calcualted scale`：精灵图的大小。[b]重要提示：[/b]此处的缩放是基于肢体缩放、纹理缩放、布娃娃缩放等计算出的最终值，因此它不是您在 xml 中输入的原始值。
- [b]交互式用户界面面板[/b]：所有工具都放置在可拖动和可折叠的面板中，让您可以自定义工作区。
  - [b]肢体面板[/b]：更改肢体的位置、旋转和深度。
  - [b]性别面板[/b]：切换性别以及从 human.xml 加载的变量。
  - [b]头部面板[/b]：更改头部、头发、胡须等。
  - [b]服装管理器[/b]：搜索并选择服装物品。
  - [b]图纸查看器[/b]：查看精灵图纸并访问编辑器。
  - [b]关节面板[/b]：查看和构建角色关节。

如何使用（面向用户）

1. 下载：订阅此模组并解压缩。
2. 准备资源：这个软件从assets文件夹读取文件. 它使用Human.xml和HumanDefaultRagdoll来构建角色

• 如果你的mod有Human.xml 和 HumanDefaultRagdoll.xml, 直接把assets内的东西删掉然后把你的mod放进去就行.
• 如果你的mod没有Human.xml 和 HumanDefaultRagdoll.xml, 你需要一个基础人物mod, 比如原版, 或者比如木萌, 然后把你的mod放进这个基础人物mod, 如:

基础人物mod的filelist.xml
<contentpackage name="**" .../>
  <!-- 你的mod的item路径 --!>
  <item path="%ModDir%/..." />
  <!-- 基础人物mod的路径 --!>
  <character path="%ModDir%/../../Human.xml" />
  ...
<contentpackage />

您的文件夹结构应如下所示：

    /Mod/
    |-- Barotrauma Character Editor-portable.exe
    |-- /assets/ <-- 将其视为 %ModDir%
        |-- filelist.xml <-- 确保 filelist.xml 在此位置
        |-- (您的模组内容)

这个软件的工作流:
1. 读取filelist.xml以获得human.xml, 获取性别, 头发等
2. 使用Human.xml以获取HumanDefaultRagdoll, 构建人类角色布娃娃, 肢体
3. 使用filelist.xml获取item.xml, 读取其中含有wearable的item, 把它们列到服装管理器上

3. 启动：运行 .exe 文件。