ASCIIMO 技术文档

1. 安装指南

ASCIIMO 是一个基于 JavaScript 的 ASCII 艺术生成器，可以在 Node.js 环境和浏览器中使用。以下是安装步骤：

Node.js 环境：

1. 使用 npm（Node.js 包管理器）安装 ASCIIMO：

   npm install asciimo
   

2. 确保已经安装了 FIGlet 字体文件。可以从 FIGlet 官网 下载。

浏览器环境：

1. 将 ASCIIMO 的 JavaScript 文件 <script type="text/javascript" src="./lib/asciimo.js"></script> 和字体列表文件 <script type="text/javascript" src="./lib/fonts.js"></script> 引入到 HTML 文件中。

2. 可以选择性地引入 jQuery 库，以简化 DOM 操作。

2. 项目的使用说明

命令行使用：

在命令行中，可以直接调用 ASCIIMO 来生成 ASCII 艺术：

asciimo "文本" 字体名称

Node.js 使用：

在 Node.js 中，通过引入 ASCIIMO 模块，并调用 write 方法来生成 ASCII 艺术：

var asciimo = require('./lib/asciimo').Figlet;
var colors = require('./lib/colors'); // 引入颜色模块（可选）

// 设置字体文件和要转换的文本
var font = 'banner';
var text = "hello, i am asciimo";

// 异步生成 ASCII 艺术并打印
asciimo.write(text, font, function(art){
  console.log(art.magenta); // 使用颜色打印（可选）
});

浏览器使用：

在浏览器中，通过引入 ASCIIMO 的 JavaScript 库，并使用 jQuery 事件监听器来动态更改字体和显示 ASCII 艺术：

<script type="text/javascript">
  $(document).ready(function(){
    // 为字体选择框添加字体名称
    for(var i = 0; i<Figlet.fontList.length; i++){
      var fontTitle = Figlet.fontList[i].replace('.flf','').replace('.aol','');
      $('#fontSelector').append('<option value = "'+Figlet.fontList[i]+'">'+fontTitle+'</option>');
    }

    // 绑定事件以响应字体更改和 ASCII 艺术的渲染
    // ...（具体事件绑定代码省略，参考示例中的代码）
  });
</script>

3. 项目 API 使用文档

Figlet.write(text, font, callback)

• text：（字符串）要转换成 ASCII 艺术的文本。
• font：（字符串）字体文件名称（不含路径和扩展名）。
• callback：（函数）一个回调函数，用于处理生成的 ASCII 艺术字符串。

Figlet.loadFont(fontName, callback)

• fontName：（字符串）字体文件名称。
• callback：（函数）字体加载完成后的回调函数。

4. 项目安装方式

ASCIIMO 可以通过 npm 安装到 Node.js 项目中，或者直接将 JavaScript 文件下载到项目中，并在浏览器中引用。

通过 npm 安装：

npm install asciimo

手动安装：

1. 下载 ASCIIMO 的源代码。
2. 将 lib/asciimo.js 和 lib/fonts.js 文件放到项目的相应目录下。
3. 在 HTML 文件中引用这些 JavaScript 文件。