Mira Screenshare 项目使用教程

1. 项目的目录结构及介绍

Mira Screenshare 是一个用 Rust 编写的高性能屏幕共享/远程协作软件。项目目录结构如下：

mira-screen-share/
├── .cargo/               # Cargo构建系统的配置文件
├── .idea/                # IntelliJ IDEA项目配置文件
├── configs/              # 配置文件示例
├── resources/            # 资源文件
├── src/                  # 源代码
├── .gitignore            # Git忽略文件列表
├── Cargo.lock            # Cargo.lock文件，记录项目依赖的具体版本
├── Cargo.toml            # Cargo配置文件，描述项目信息和依赖
├── LICENSE.txt           # 项目许可证信息
├── Makefile              # Makefile构建脚本
├── README.md             # 项目自述文件
├── build.rs              # 构建脚本
├── mira-manifest.rc       # Windows清单文件
└── mira_sharer.exe.manifest # Windows可执行文件清单

• src/：存放项目的 Rust 源代码。
• configs/：包含项目的配置文件示例。
• resources/：包含项目所需的资源文件。
• Cargo.toml：定义项目元数据和依赖。
• README.md：项目说明文件，提供项目概述和使用说明。

2. 项目的启动文件介绍

项目的启动主要通过 Cargo.toml 文件中的 main 函数定义的入口点进行。以下是启动项目的基本步骤：

1. 确保已经安装了 Rust 开发环境和 Cargo。
2. 克隆项目仓库到本地：

   git clone https://github.com/mira-screen-share/sharer.git
   

3. 进入项目目录：

   cd mira-screen-share
   

4. 构建并运行项目：

   cargo run --release
   

3. 项目的配置文件介绍

Mira Screenshare 的配置文件为 config.toml，通常位于用户的主目录下，例如在 macOS 系统中位于 ~/Library/Application Support/Mira-Sharer/config.toml。

配置文件示例内容如下：

# Mira Screenshare 配置文件

[encoding]
# 编码设置
codec = "x264"
quality = "high"
speed = "fast"

[server]
# 服务器设置
turn_server = "your_turn_server"
turn_port = "3478"
turn_user = "your_turn_user"
turn_password = "your_turn_password"

• [encoding]：这部分设置编码器相关的配置，如编码器类型、画质和编码速度等。
• [server]：这部分设置 TURN 服务器的相关信息，用于在无法直接建立 P2P 连接时中继数据。

根据实际需求，用户可以修改这些配置以适应不同的使用场景。在修改配置后，需要重启项目以使配置生效。