azurice / ice

A minecraft cli helper

Ice

一个 mineraft 命令行助手，可以根据 toml 配置文件进行 mod 管理、server 管理等功能。

由 MCSH --> ACH --> Ice 一路演进而来。

安装 & 更新

Windows - Scoop

Windows 用户推荐使用 ScoopInstaller/Scoop: A command-line installer for Windows. (github.com) 进行安装。

安装

scoop bucket add ice https://github.com/azurice/ice
scoop install ice/ice

更新

如果提示错误可以 scoop bucket rm ice 后重新添加 bucket，再更新/安装。

scoop update
scoop update ice

Windows & Linux & MacOS - Cargo

或者使用 Cargo 进行安装/更新：

cargo install --git https://github.com/AzurIce/ice.git --locked

使用方式

Usage: ice.exe <COMMAND>

Commands:
  modrinth  Modrinth related commands
  server    Server related commands
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

mod

Usage: ice.exe modrinth <COMMAND>

Commands:
  init    Initialize a mods.toml
  sync    Sync mods
  update  Update mods
  add     Add mod
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

ice modrinth 命令可以使用当前目录的 mods.toml 来管理当前目录的 mod，目前所有的 mod 均通过 Modrinth API 获取。

可用的命令如下：

• init：创建一个新的 mods.toml 文件

  可以通过 -v 和 -l 指定 version 和 loader，默认 version 为最新正式版，loader 为 quilt。

  下面是一个 mods.toml 文件的例子：

  version = "1.21"
  loader = "quilt"
  
  [mods]
  fabric-language-kotlin = "1.11.0+kotlin.2.0.0"
  appleskin = "3.0.2+mc1.21"
  sodium = "mc1.21-0.5.11"
  indium = "1.0.34+mc1.21"
  continuity = "3.0.0-beta.5+1.21"
  iris = "1.7.3+1.21"
  voxelmap-updated = "1.21-1.13.1"
  modmenu = "11.0.1"
  sodium-extra = "mc1.21-0.5.7"
  libipn = "fabric-1.21-rc1-6.0.0"
  fabric-api = "0.100.7+1.21"

  • version：游戏版本

  • loader：使用的加载器

  • mods：定义的 mod 列表

    是一系列 slug - version_number 的键值对，slug 即 Modrinth 网站 mod 页面 url 内的 mod 名称。

• ice modrinth sync：根据 mods.toml 中的定义下载缺失的 mod、移除多余的 mod（只会移除存在于 Modrinth 上的 Mod）、更新版本不对的 mod。

• ice modrinth update：下载当前目录所有 mod 符合 version 和 loader 的最新版本，删除老版本，并更新到 mods.toml 中。

• ice modrinth add <slug>: 下载符合 version 和 loader 的最新版本 mod，并更新到 mods.toml 中

server

Usage: ice.exe server <COMMAND>

Commands:
  new
  init
  install
  run
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

ice server 用于管理服务器，以及使用 ice 内核启动服务器（提供备份等功能的支持）。

• new / init：创建新目录/在当前目录初始化一个 Ice.toml

  下面是一个示例的 Ice.toml：

  name = "Survival"
  version = "1.21"
  loader = "quilt"
  jvm_options = ""
  
  [properties]
  motd = "AzurCraft Survival"
  server-ip = "0.0.0.0"
  view-distance = "16"
  
  [mods]
  appleskin = "3.0.2+mc1.21"
  

• install：根据当前目录下的 Ice.toml 安装服务器

• run：使用 ice 内核启动服务器

Ice 内核

就是以前的 MCSH / ACH。

---

ACH

基于对 minecraft 服务端输入输出进行重定向实现的服务器 Helper，可以完成多个服务器备份管理等功能，并带有后台页面。

AzurCraftHelper

构建

首先，需要 Go 语言的环境。

1. 安装 statik

本项目使用 statik 将静态文件打包入可执行文件中

go get github.com/rakyll/statik
go install github.com/rakyll/statik

2. 构建前端

git submodule update
cd assets
yarn
yarn build

3. 修改并运行 build.bat

使用

一、备份

在网页的 Backups 栏可以看到所有服务器的备份（WIP）。

快照 与 归档

备份分为两种：快照（snapshot） 与 归档（archive），前者有槽位限制，旧的快照会随着新的快照的创建而被替换，后者为永久存储。

1. 快照

快照保存目录：{backupDir}/snapshots

快照槽位机制：有10个槽位，若槽位占满，会替换掉最老的一个槽位。

• 创建快照：#bksnap make[<name>]

  可以选择输入快照名称，会将 world 目录以 <ServerName> - 2022-07-19 17-11-07[ <name>] 为名称存储到 快照保存目录。

• 查看快照列表：#bksnap list

  会列出所有的 快照 及其 id

• 加载快照：#bksnap load <id>

  关闭服务器后，使用 id 为 <id> 的快照替换掉 world 目录，再启动服务器。

2. 备份（旧的备份）

备份保存目录：storedBackup/snapshots

#backup make[ <name>] 同 bksnap

#backup list[ <page>] 显示第 <page> 页备份（不填则只显示第一页，一页10个）

#backup load <id>

2. 归档（WIP）

归档目录

#bkarch make <name> 归档必须有名字。

#bkarch list[ <page>] 显示第 <page> 页快照（不填则只显示第一页，一页10个）

#bkarch load <id>

---

以下内容已经过时，是旧版 MCSH 的内容

• command_prefix

  This is what MCSH will look for while you enter something into it.

  If any input contains it at the beginning, it will be considered as a MCSH Command

  check more in MCSH Commands

• servers It contains the information of all your server need to be managed with ACH. For each server, the key should be a custom name for it.

  • execOptions

    e.g. -Xms4G -Xmx4G.

  • execPath

    The path to the .jar file of your server.

    • When doing bacnup jobs, MCSH will use the dir of this path to locate world/ folder.
    • Server will be using command java execOptions -jar execPath --nogui to start.

IO for each server

• input: Write xxx to serverName with serverName | xxx.
  Otherwise, MCSHGo will write the input to every server.

• output: It will present output from each server like this:

  YYYY-MM-DD HH:MM:SS [serverName/INFO]: ......
  YYYY-MM-DD HH:MM:SS [serverName/WARN]: ......
  

MCSH Commands

A MCSH Commands is recognized with the prefix # for normal, you can configure it in config.yml .\

If you do #xxx abc defgh ijk \

xxx abc defgh ijk will be recognized as a MCSH Command \

You can also use serverName|#xxx to run MCSH Command in specified server, or it will execute for every server.

• backup [mode] [arg]

  • enter ``(empty) as [mode]

  Show the backup list, Not developed yet.

  • enter make as [mode]

  arg is comment , optional.\

  MCSH will copy your server's serverRoot/world to Backups/ folder with a changed name in servername - yyyy-mm-dd hh-mm-ss[ comment] format

  • enter restore as [mode]

  stop the server, backup your server with comment Restore2<backupName> , Not developed yet.

• run

  • After you stoped some server, you can use this command to run it again.

ice's Issues

mod sync downloads wrong version

Some mods have same version number for different Version, so we can't use version number as the unique key.

Or add extra filter to sync according to game_version and loader