Barrier 开源项目使用教程

Barrier 开源项目使用教程

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

Barrier 是一个开源的 KVM（键盘、视频、鼠标）软件，允许用户使用单个键盘和鼠标控制多台计算机。以下是项目的目录结构及简要介绍：

barrier/
├── .github/                    # GitHub 相关配置文件
├── azure-pipelines/            # Azure 管道 CI/CD 配置
├── cmake/                      # CMake 构建系统文件
├── debian/                     # Debian 包相关文件
├── dist/                       # 分发目录
├── doc/                        # 文档目录
├── ext/                        # 外部库和模块
├── res/                        # 资源文件
├── snap/                       # Snap 包相关文件
├── src/                        # 源代码目录
├── .editorconfig               # 编辑器配置文件
├── .gitignore                  # Git 忽略文件
├── .gitmodules                 # Git 子模块配置文件
├── Build.properties            # 构建属性文件
├── CMakeLists.txt              # CMake 项目文件
├── ChangeLog                   # 更改日志
├── LICENSE                     # 许可证文件
├── README.md                   # 项目介绍文件
├── RELEASING.md                # 发布说明文件
├── _config.yml                 # 配置文件
├── azure-pipelines.yml         # Azure 管道配置文件
├── build_installer.bat          # Windows 安装脚本
├── clean_build.bat             # Windows 清理构建脚本
├── clean_build.sh              # Linux 清理构建脚本
├── osx_environment.sh          # macOS 环境设置脚本
├── pre-build.bat               # Windows 预构建脚本
└── towncrier.toml              # 通知配置文件

2. 项目的启动文件介绍

Barrier 的启动文件主要位于 src/ 目录下，以下是几个关键的启动文件：

• barrier.cpp：主程序文件，包含了主要的程序逻辑。
• main.cpp：程序的入口点，负责初始化程序并启动服务。

要启动 Barrier，通常需要在具有键盘和鼠标的计算机上运行服务器端的程序，同时在其他计算机上运行客户端程序。

3. 项目的配置文件介绍

Barrier 的配置文件通常为 config.yml，位于项目根目录。以下是配置文件的基本结构：

# Barrier 配置文件示例

# 服务器设置
server:
  # 服务器监听地址
  host: 0.0.0.0
  # 服务器监听端口
  port: 24800

# 客户机设置
clients:
  - name: client1
    # 客户机连接的服务器地址
    host: 192.168.1.1
    # 客户机连接的服务器端口
    port: 24800

在配置文件中，您需要指定服务器和客户端的相关设置，包括监听地址、端口以及客户端的名称和连接信息。确保每个客户端的名称在配置中是唯一的，并且与实际运行的客户端计算机上的名称相匹配。

在配置完成后，您需要将配置文件传递给 Barrier 程序，通常通过命令行参数 --config <path_to_saved_configuration> 来指定配置文件的路径。