elcord 项目使用教程

1. 项目目录结构及介绍

elcord 项目是一个为 Emacs 编辑器提供 Discord Rich Presence 支持的开源项目。项目的目录结构如下：

elcord/
├── .gitignore         # git 忽略文件列表
├── LICENSE            # 项目许可证文件
├── README.md          # 项目说明文件
├── elcord.el          # elcord 主程序文件
├── stdpipe.ps1        # Windows 平台下用于与 Discord 通信的 PowerShell 脚本
└── ...                # 其他可能存在的文件或目录

• .gitignore：指定了 Git 应该忽略的文件和目录，以避免将不必要的文件提交到版本控制中。
• LICENSE：包含了项目的许可证信息，本项目采用 MIT 许可证。
• README.md：项目的说明文档，其中包含了项目的简介、安装方法、使用方式和配置选项等信息。
• elcord.el：elcord 的主程序文件，包含了所有必要的 Emacs Lisp 代码。
• stdpipe.ps1：一个 PowerShell 脚本，用于 Windows 系统上与 Discord 的 IPC 机制进行通信。

2. 项目的启动文件介绍

项目的启动文件是 elcord.el。在 Emacs 中使用 elcord，您需要先安装它，然后通过以下方式启动：

(require 'elcord)
(elcord-mode)

在您的 Emacs 配置文件（通常是 .emacs 或 init.el）中添加上述代码，可以自动加载并激活 elcord。

3. 项目的配置文件介绍

elcord 的配置主要通过 Emacs 的 Customize 功能进行。要访问 elcord 的配置选项，请在 Emacs 中执行以下命令：

M-x customize-group RET elcord RET

这将打开一个界面，允许您自定义 elcord 的行为，包括但不限于：

• elcord-client-id：您的 Discord 应用程序的客户端 ID。
• elcord-mode-icon-alist：定义了不同模式下要显示的 Discord 状态图标。

请注意，如果您要使用自己的 Discord 应用程序，您需要在 Discord 的应用程序页面创建一个新应用程序，并获取其客户端 ID。然后，在 Emacs 中更新 elcord-client-id 的值，并根据需要配置图标列表。

确保在配置完成后保存设置，并重启 Emacs 以使更改生效。