开源项目Relay的安装与配置指南

开源项目Relay的安装与配置指南

Relay Multiplayer Mode for Obsidian 项目地址: https://gitcode.com/gh_mirrors/relay28/Relay

1. 项目基础介绍

Relay是一个为Obsidian开发的多人协作插件，它能够使用冲突自由复制数据类型（CRDTs）技术，实现本地优先的实时和异步协作。通过Relay，用户可以在Obsidian中实时协作编辑文档，查看其他协作者的实时光标位置，并且支持离线编辑，再上线时自动同步更改。

本项目的主要编程语言为TypeScript，辅以Svelte和JavaScript。

2. 项目使用的关键技术和框架

• CRDTs（Conflict-Free Replicated Data Types）: 一种数据结构，允许在分布式系统中进行复制和更新，即使在不稳定或不同步的网络环境下也能保持数据的一致性。
• Obsidian插件系统: Obsidian是一款强大的知识库应用，本项目作为其插件，可以无缝集成到Obsidian的编辑环境中。
• yjs: 一个实现了CRDTs的JavaScript库，本项目使用它来处理文档的同步。

3. 项目安装和配置的准备工作及详细步骤

准备工作

• 确保您的计算机上已安装Node.js和npm。如果没有安装，您可以从nodejs.org下载并安装。
• 安装Obsidian应用。您可以从Obsidian's official website下载并安装。
• 准备一个文本编辑器，例如Visual Studio Code，用于编辑代码和配置文件。

安装步骤

1. 克隆项目到本地

   打开命令行工具，执行以下命令：

   git clone https://github.com/No-Instructions/Relay.git
   cd Relay
   

2. 安装项目依赖

   在项目根目录下执行：

   npm install
   

3. 构建项目

   执行以下命令来编译TypeScript代码：

   npm run build
   

4. 将插件安装到Obsidian

   • 打开Obsidian应用。
   • 点击左侧的设置图标（齿轮形状），选择“插件”。
   • 点击“浏览”按钮，找到Relay插件文件夹中的main.js文件，选择并打开。
   • Obsidian将提示您确认安装插件，点击“确定”。

5. 配置Relay插件

   • 在Obsidian的设置中找到Relay插件设置。
   • 创建新的Relay，并添加需要共享的文件夹。
   • 生成分享密钥，并将它分发给您的协作者。

现在，您和您的协作者应该能够在Obsidian中开始实时协作了。如果遇到任何问题，可以查看项目的README文件或加入项目的Discord社区寻求帮助。

Relay Multiplayer Mode for Obsidian 项目地址: https://gitcode.com/gh_mirrors/relay28/Relay