Tutor 项目技术文档

本文档将详细介绍如何安装和使用 Tutor 项目，以及如何通过其 API 访问 Magic: The Gathering 卡牌信息。

1. 安装指南

在开始使用 Tutor 之前，你需要确保你的系统中已经安装了 Node.js。安装完成后，可以通过以下命令安装 Tutor：

npm install tutor

若希望全局使用 tutor 命令，可以使用以下命令：

npm install tutor --global

2. 项目的使用说明

Tutor 提供了多种方法来获取卡牌信息。以下是一些基本的使用示例：

获取单张卡牌信息

通过卡牌名称或 ID 获取单张卡牌的信息：

tutor.card 'Demonic Tutor', (err, card) ->
  console.log card.name
  # => "Demonic Tutor"
  console.log card.mana_cost
  # => "{1}{B}"
  console.log card.text
  # => "Search your library for a card, put that card into your hand, then shuffle your library."

获取指定套牌的卡牌信息

通过套牌名称获取该套牌中所有卡牌的信息：

tutor.set 'Homelands', (err, cards) ->
  console.log cards.length
  # => 套牌中卡牌数量
  console.log Object.keys(cards[0]).sort()
  # => 卡牌信息的属性列表

获取所有卡牌类型

获取游戏中所有卡牌类型的列表：

tutor.types (err, types) ->
  console.log types
  # => 所有卡牌类型的列表

3. 项目API使用文档

以下是 Tutor 提供的 API 方法的详细说明：

tutor.card

获取单张卡牌的信息。

• 参数:
  • id 或 name: 卡牌的 Gatherer ID 或名称。
  • callback: 回调函数，用于处理获取到的卡牌信息。

tutor.set

获取指定套牌中的所有卡牌信息。

• 参数:
  • name: 套牌的名称。
  • callback: 回调函数，用于处理获取到的卡牌信息列表。

tutor.formats

获取游戏中所有格式的名称。

• 参数:
  • callback: 回调函数，用于处理获取到的格式名称列表。

tutor.sets

获取游戏中所有套牌的名称。

• 参数:
  • callback: 回调函数，用于处理获取到的套牌名称列表。

tutor.types

获取游戏中所有卡牌类型的名称。

• 参数:
  • callback: 回调函数，用于处理获取到的卡牌类型名称列表。

4. 项目安装方式

Tutor 项目可以通过 npm 进行安装，如上所述。若需要全局安装，可以使用以下命令：

npm install tutor --global

这样，你就可以在任何位置使用 tutor 命令来获取卡牌信息了。