cmd

package
v1.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2025 License: BSD-3-Clause Imports: 9 Imported by: 0

README

English | 简体中文

English

MeidoSerialization CLI

MeidoSerialization CLI is a command-line interface for the MeidoSerialization library, allowing you to convert between COM3D2 MOD files and JSON formats directly from the command line.

For .tex files, it converts between common image formats and the .tex format.

You can also use COM3D2 MOD EDITOR V2 to open the converted json file or unconverted files.

After converting to JSON text, you can more conveniently use batch processing tools for tasks like keyword replacement.

Please note that the converted JSON does not contain newlines. You may need to use tools like Visual Studio Code to format it for readability.

You can use this simple GUI tool for batch processing like keyword replacement and renaming, which is useful for creating variations (Chinese only): https://github.com/90135/COM3D2_Tools_901

Download

Download in Release

Usage

The CLI provides six main commands:

convert2json

Convert MOD files to JSON format.

Does not support .tex conversion.

MeidoSerialization.exe convert2json [file/directory]

Examples:

MeidoSerialization.exe convert2json example.menu
MeidoSerialization.exe convert2json ./mods_directory
MeidoSerialization.exe convert2json --type menu ./mods_directory  # Only convert .menu files
convert2mod

Convert JSON files back to MOD format.

Does not support .tex.json conversion.

MeidoSerialization.exe convert2mod [file/directory]

Examples:

MeidoSerialization.exe convert2mod example.menu.json
MeidoSerialization.exe convert2mod ./json_directory
MeidoSerialization.exe convert2mod --type mate ./json_directory  # Only convert .mate.json files
convert2image

Convert .tex files to image format.

MeidoSerialization.exe convert2image [file/directory]

Examples:

MeidoSerialization.exe convert2image example.tex
MeidoSerialization.exe convert2image example.tex --format jpg  # Convert to JPG format
MeidoSerialization.exe convert2image ./textures_directory
MeidoSerialization.exe convert2image ./textures_directory --format webp # Convert to WebP format
convert2tex

Convert image files to .tex format.

MeidoSerialization.exe convert2tex [file/directory]

Examples:

MeidoSerialization.exe convert2tex example.png
MeidoSerialization.exe convert2tex example.jpg --compress # Use DXT compression
MeidoSerialization.exe convert2tex example.png --forcePng false
MeidoSerialization.exe convert2tex example.png --forcePng true # Force using PNG format (lossless) for the data part of the .tex file
MeidoSerialization.exe convert2tex ./images_directory
MeidoSerialization.exe convert2tex ./images_directory --compress --forcePng false
convert

Auto-detect and convert files between MOD and JSON formats.

Does not support .tex conversion.

MeidoSerialization.exe convert [file/directory]

Examples:

MeidoSerialization.exe convert example.menu
MeidoSerialization.exe convert example.menu.json
MeidoSerialization.exe convert ./mixed_directory
MeidoSerialization.exe convert --type pmat ./mixed_directory  # Only convert .pmat and .pmat.json files
determine

Determine the types of files in a directory or a single file.

MeidoSerialization.exe determine [file/directory]

Examples:

MeidoSerialization.exe determine example.menu
MeidoSerialization.exe determine --strict ./mods_directory
Global Flags
  • --strict or -s: Use strict mode for file type determination (based on content rather than file extension)
  • --type or -t: Filter by file type (menu, mate, pmat, col, phy, psk, tex, anm, model)

Supported File Types

see main README

Build

  1. Make sure you have Go installed (version 1.24 or higher)
  2. Clone the repository: 
    git clone https://github.com/MeidoPromotionAssociation/MeidoSerialization.git
  3. Build the CLI: 
    cd MeidoSerialization
go build -o MeidoSerialization.exe

简体中文

MeidoSerialization CLI

MeidoSerialization CLI 是 MeidoSerialization 库的命令行界面，允许您直接从命令行在 COM3D2 MOD 文件和 JSON 格式之间进行转换。

对于 .tex 文件，则是在普通图片格式和 .tex 格式之间进行转换。

您也可以使用 COM3D2 MOD EDITOR V2 打开转换后的 json 文件或是未转换的文件。

转换为 JSON 文本以后，您可以更为方便地使用一些批处理工具进行批量处理，例如关键词替换等。

请注意转换后的 JSON 是没有换行符的，进行关键词替换时需要注意，您也可以使用 Visual Studio Code 等工具进行格式化。

您可以使用这里提供的简单 GUI 工具来进行简单的关键词替换，重命名等批处理，制作差分很有用（仅中文）：https://github.com/90135/COM3D2_Tools_901

下载

在 Release 中下载

使用方法

CLI 提供了六个主要命令：

convert2json

将 MOD 文件转换为 JSON 格式。

不支持 .tex 转换

MeidoSerialization.exe convert2json [文件/目录]

示例：

MeidoSerialization.exe convert2json example.menu
MeidoSerialization.exe convert2json ./mods_directory
MeidoSerialization.exe convert2json --type menu ./mods_directory  # 仅转换 .menu 文件
convert2mod

将 JSON 文件转换回 MOD 格式。

不支持 .tex.json 转换

MeidoSerialization.exe convert2mod [文件/目录]

示例：

MeidoSerialization.exe convert2mod example.menu.json
MeidoSerialization.exe convert2mod ./json_directory
MeidoSerialization.exe convert2mod --type mate ./json_directory  # 仅转换 .mate.json 文件
convert2image

将 .tex 文件转换为图片格式。

MeidoSerialization.exe convert2image [文件/目录]

示例：

MeidoSerialization.exe convert2image example.tex
MeidoSerialization.exe convert2image example.tex --format jpg  # 转换为 JPG 格式
MeidoSerialization.exe convert2image ./textures_directory
MeidoSerialization.exe convert2image ./textures_directory --format webp # 转换为 WebP 格式
convert2tex

将图片文件转换为 .tex 格式。

MeidoSerialization.exe convert2tex [文件/目录]

示例：

MeidoSerialization.exe convert2tex example.png
MeidoSerialization.exe convert2tex example.jpg --compress # 使用 DXT 压缩
MeidoSerialization.exe convert2tex example.png --forcePng false
MeidoSerialization.exe convert2tex example.png --forcePng true # 强制使用 PNG 格式（无损）进行 .tex 文件的数据部分
MeidoSerialization.exe convert2tex ./images_directory
MeidoSerialization.exe convert2tex ./images_directory --compress --forcePng false
convert

自动检测并在 MOD 和 JSON 格式之间转换文件。

不支持 .tex 转换

MeidoSerialization.exe convert [文件/目录]

示例：

MeidoSerialization.exe convert example.menu
MeidoSerialization.exe convert example.menu.json
MeidoSerialization.exe convert ./mixed_directory
MeidoSerialization.exe convert --type pmat ./mixed_directory  # 仅转换 .pmat 和 .pmat.json 文件
determine

确定目录中的文件或单个文件的类型。

MeidoSerialization.exe determine [文件/目录]

示例：

MeidoSerialization.exe determine example.menu
MeidoSerialization.exe determine --strict ./mods_directory
全局参数
  • --strict 或 -s：使用严格模式进行文件类型判断（基于内容而非文件扩展名）
  • --type 或 -t：按文件类型过滤（menu, mate, pmat, col, phy, psk, tex, anm, model）

支持的文件类型

见主 README

构建

  1. 确保已安装 Go（版本 1.24 或更高）
  2. 克隆仓库： 
    git clone https://github.com/MeidoPromotionAssociation/MeidoSerialization.git
  3. 构建 CLI： 
    cd MeidoSerialization
go build -o MeidoSerialization.exe

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var RootCmd = &cobra.Command{
	Use:   "MeidoSerialization",
	Short: "MeidoSerialization CLI tool",
	Long: `MeidoSerialization CLI tool for converting between COM3D2 MOD files and JSON.
This tool can convert MOD files to JSON, JSON files to MOD files, and determine file types.

Supported file types include: .menu, .mate, .pmat, .col, .phy, .psk, .tex, .anm, and .model

Github: https://github.com/MeidoPromotionAssociation/MeidoSerialization
`,
	Run: func(cmd *cobra.Command, args []string) {

		err := cmd.Help()
		if err != nil {
			return
		}
	},
}

RootCmd represents the base command when called without any subcommands

Functions

func Execute 

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the RootCmd.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.