bannerlord-helper

v0.2.2

A collection of useful tools dedicated to making i18n works easier for Mount & Blade II: Bannerlord mod creators For more information about how to use this package see README

Latest version published 2 months ago

License: MIT

NPM

GitHub

Package Health Score

54 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.2.2	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (3)

GitHub Stars: 4
Forks: 0
Contributors: 1

Direct Usage Popularity

The npm package bannerlord-helper receives a total of 3 downloads a week. As such, we scored bannerlord-helper popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package bannerlord-helper, we found that it has been starred 4 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like bannerlord-helper is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of bannerlord-helper based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that bannerlord-helper demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18

Age: 3 months
Dependencies: 28 Direct
Versions: 7
Install Size: 326 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: No

bannerlord-helper has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

English | 简体中文 | Türkçe

> [!IMPORTANT] > > 仅支持 Windows。 > 详细信息请查阅 node-steam-library > 和 winreg.

📖 简介

Node.js 的实用终端工具集，致力于让《Mount & Blade II: Bannerlord》模组创作者能够更轻松地进行国际化工作。

⚙️ 安装

首先确保电脑确保安装了 Node 程序，并且安装路径存在于操作系统或用户环境变量中
在任意终端（cmd/bash/powershell/...）通过 NPM 安装本程序。
```
npm install bannerlord-helper --global
```

(如果安装成功则跳过此步) 如果安装失败，首先确保 Node 正确安装。

# 打印版本号即正确安装，如：10.7.0
# 出现 npm: command not found 则表示 Node 未正确安装，或路径不存在于用户环境变量
npm -v

(如果安装成功则跳过此步) 如果 Node 未正常安装，检查或新增安装路径和用户环境变量。

> 如果不会操作的话可以查看这张引导图片 Node 环境变量，或直接安装 Node > 官方提供的预构建安装程序。

中国大陆地区，某些特殊日期可能会因为网络问题导致 npm install 执行失败，使用 VPN 或执行命令将 NPM 源设置为淘宝技术团队的镜像。

# 等同于我们向淘宝发送要求下载某个程序的消息，淘宝的服务器下载完后，我们再从淘宝的静态资源服务器安装 NPM 上的程序
npm config set registry https://registry.npmmirror.com
# 然后再次执行 NPM install
npm install bannerlord-helper --global

运行帮助命令检查命令行是否安装成功。
```
bh -h
```

🚀 使用

Bilingual Screenshot

bh &lt;命令&gt; [选项]

命令：
  bh search [keywords]      在 Nexusmod 上搜寻模组                   [aliases: browse]
  bh info                   检索本地模组详情和更新信息                       [aliases: query]
  bh identifier             填充和修复本地模组的翻译标识                      [aliases: ident]
  bh generate               生成本地模组的翻译模板文件                         [aliases: gen]
  bh translate              翻译本地模组的翻译模板文件                       [aliases: trans]
  bh external               翻译本地模组到外挂式翻译模组                        [aliases: ext]
  bh language [codeOrName]  显示受支持的语言列表                           [aliases: lang]
  bh completion             generate completion script

选项：
      --engine   翻译引擎 (Default by microsoft)
                 [字符串] [可选值: "microsoft", "google", "deeplx"] [默认值: "microsoft"]
  -h, --help     显示帮助信息                                                     [布尔]
  -v, --version  显示版本号                                                      [布尔]

示例：
  $ bh -h                         查看命令行帮助信息
  $ bh language -h                查看 language 命令的帮助信息
  $ bh [command] -h               查看指定 command 的帮助信息
  $ bh [command] --engine google  使用 Google 翻译引擎
  $ bh [command] --engine deeplx  使用 Deeplx 翻译

🕹️ 命令

环境变量

名称	默认值	描述
DEEPLX_PORT	1188	DeepLX 本地服务端口
DEEPLX_TOKEN	-	用于保护 API 的访问令牌

公共选项

名称	类型	缩写	必需	Choices	默认值	描述
engine	字符串	-	否	"microsoft", "google", "deeplx"	"microsoft"	翻译引擎 (默认使用 Microsoft)
help	布尔	h	否	-	-	显示帮助信息
version	布尔	v	否	-	-	显示版本号

search

别名: browse

> 在 Nexusmod 上搜寻模组

参数	类型	缩写	必需	默认值	描述
keywords	字符串	k	是	-	模组名称关键字
language	字符串	l	否	"EN"	翻译 Nexusmod 模组列表名称的语言代码

Example

$ bh search "ButterLib": 在终端展示 Nexusmod 上 Butter Lib 模组的详细信息
$ bh search "改良驻军" --language="cns": 使用简体中文搜索模组并翻译搜索结果名称
$ bh search "Diplomacia" --language="sp" --engine="google": 过 Google 翻译并使用西班牙语查找和翻译模组
$ bh browse -k Diplomacy -l tr: 使用别名简化命令行

info

别名: query

> 检索本地模组详情和更新信息

参数	类型	缩写	必需	默认值	描述
language	字符串	l	否	"EN"	翻译本地模组列表名称的语言代码
reset	布尔	r	否	false	重新设置所选模组与 Nexusmod 链接的索引

Example

$ bh info --language="cns": 使用简体中文翻译搜索结果名称
$ bh view -l cns: 使用别名简化命令行

identifier

别名: ident

> 填充和修复本地模组的翻译标识

参数	类型	缩写	必需	默认值	描述
language	字符串	l	否	"EN"	翻译本地模组列表名称的语言代码

Example

$ bh identifier --language="cns": 使用简体中文翻译搜索结果名称
$ bh ident -l cns: 使用别名简化命令行

generate

别名: gen

> 生成本地模组的翻译模板文件

参数	类型	缩写	必需	默认值	描述
language	字符串	l	否	"EN"	翻译本地模组列表名称的语言代码
to	字符串	t	否	"EN"	目标语言代码 (源文件文本的语言)
force	布尔	-	否	false	清除已存在的文件并重新生成模板

Example

$ bh generate: 生成翻译英文模板, 并导出到 Languages 根目录
$ bh generate -to="tr": 生成翻译土耳其语模板, 并导出到 Languages/TR 目录
$ bh generate -to="chinese simplified": 生成翻译简体中文模板, 并导出到 Languages/CNs 目录
$ bh gen -t cns: 使用别名简化命令行

translate

别名: trans

> 翻译本地模组的翻译模板文件

参数	类型	缩写	必需	默认值	描述
to	字符串	t	是	-	目标语言代码
from	字符串	f	否	"EN"	源文本语言代码
prefix	字符串	p	否	-	为每项翻译文本添加前缀
force	布尔	-	否	false	清除已存在的文件并重新翻译

Example

$ bh translate --to="cns": 将 Languages 根目录的英文翻译模板翻译成简体中文, 并导出到 Languages/CNs 目录
$ bh translate --from="cns" --to="Japanese": 将 Languages/CNs 目录的简体中文模板翻译成日文, 并生成到 Languages/JP 根目录
$ bh translate --to="cns" --prefix="[CNS]": 将英文模板翻译成简体中文生成到 Languages/CNs 目录, 并为每项翻译文本添加 [CNS] 前缀
$ bh translate --to="cns" --force: 清空 Languages/CNs 目录并将英文模板翻译成简体中文, 并导出到 Languages/CNs 目录
$ bh trans -f en -t cns -p [CNS]: 使用别名简化命令行

external

别名: ext

> 翻译本地模组到外挂式翻译模组

参数	类型	缩写	必需	默认值	描述
to	字符串	t	是	-	目标语言代码
from	字符串	f	否	"EN"	源文本语言代码
prefix	字符串	p	否	-	为每项翻译文本添加前缀
force	字符串	-	否	false	清除已存在的文件并重新翻译

Example

$ bh external --to="cns": 将源文件翻译成简体中文模板, 并导出到 ../Module Name CNs/ModuleData 目录
$ bh external --to="cns" --prefix="[CNS]": 将源文件翻译成简体中文, 导出到 ../Module Name CNs/ModuleData 目录, 并为每项翻译文本添加 [CNS] 前缀
$ bh external --to="cns" --force: 清空 ../Module Name CNs/ModuleData 目录, 将源文件翻译成简体中文, 并生成到 Languages/CNs 目录
$ bh ext -f en -t cns -p [CNS]: 使用别名简化命令行

language

别名: lang

> 显示受支持的语言列表

参数	类型	缩写	必需	默认值	描述
code-or-name	字符串	-	否	-	语言代码或语言名称

Example

$ bh language: 在终端展示 Nexusmod 上 Butter Lib 模组的详细信息
$ bh language cns: 查看语言代码 CNs 的语言名称和本地化名称
$ bh lang: 使用别名简化命令行

♾️ 工作流程

Workflow Image

🌐 国际化

语言名称	本地名称	ISO-639-1	ISO-3166-1 (Alpha-2)	文件
English	-	en	US	src/locale/en-US.ts
German	Deutsch	de	DE	src/locale/de-DE.ts
Spanish	Español	es	ES	src/locale/es-ES.ts
French	Français	fr	FR	src/locale/fr-FR.ts
Italian	Italiano	it	IT	src/locale/it-IT.ts
Japanese	日本語	ja	JP	src/locale/ja-JP.ts
Korean	한국어	ko	KR	src/locale/ko-KR.ts
Polish	Polski	pl	PL	src/locale/pl-PL.ts
Portuguese	Português	pt	PT	src/locale/pt-PT.ts
Russian	Русский	ru	RU	src/locale/ru-RU.ts
Turkish	Türkçe	tr	TR	src/locale/tr-TR.ts
Chinese Simplified	简体中文	zh	CN	src/locale/zh-CN.ts
Chinese Traditional	繁體中文	zh	TW	src/locale/zh-TW.ts

📍 计划项

[x] 重构核心代码
[x] 优化 i18n 管理
[x] 实现细颗粒功能
[x] 支持 DeepLX
[x] 支持 xslt 文件
[x] 支持生成外挂式翻译模组
[x] 修复 {=!} 不应被翻译的问题
[x] 解决 Nexusmod 数据时间为 UTC 的问题
[x] 复用文本项的翻译标识
[x] 优化可配置的 XML 识别路径
[ ] 命令糖
[ ] 新增单文件处理特性
[ ] 支持语言文件与 XLSX 双向转译

🏅 致谢

node-steam-library - 通过 Windows 注册表获取 Steam 的安装目录和应用列表。
node-translate - 🦜 一个强大、安全且功能丰富的 API，通过 Google 翻译
micro-translate-api - 适用于 Node.js 的 Microsoft Translator 的简单、强大且免费的 API
node-translate-i18n - 🌏 用于将本地化文件翻译为其他语言的命令行界面工具。

🤝 贡献

欢迎通过 Pull Requests 或 Issues 来贡献你的想法和代码。

_{dontkillchicken}
✉️📝💬🔣

📄 许可

本项目采用 MIT 许可证。详情请见 LICENSE 文件。

bannerlord-helper development dependencies

@types/lodash.clonedeep @types/lodash.get @types/lodash.merge @types/lodash.set @types/lodash.template @types/lodash.uniqby @types/lodash.words @types/marked-terminal @types/node @types/sha1 @types/yargs husky rimraf ts-node tsup typescript xo

FAQs

What is bannerlord-helper?

A collection of useful tools dedicated to making i18n works easier for Mount & Blade II: Bannerlord mod creators. Visit Snyk Advisor to see a full health score report for bannerlord-helper, including popularity, security, maintenance & community analysis.

Is bannerlord-helper popular?

The npm package bannerlord-helper receives a total of 3 weekly downloads. As such, bannerlord-helper popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is bannerlord-helper well maintained?

We found indications that bannerlord-helper maintenance is sustainable demonstrating some project activity. We saw a total of 1 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is bannerlord-helper safe to use?

While scanning the latest version of bannerlord-helper, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 20 December-2024, at 23:17 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (3)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

📖 简介

⚙️ 安装

🚀 使用

🕹️ 命令

环境变量

公共选项

search

info

identifier

generate

translate

external

language

♾️ 工作流程

🌐 国际化

📍 计划项

🏅 致谢

🤝 贡献

📄 许可

bannerlord-helper dependencies

bannerlord-helper development dependencies

FAQs

What is bannerlord-helper?

Is bannerlord-helper popular?

Is bannerlord-helper well maintained?

Is bannerlord-helper safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues