Skip to content

ChoHee15/cuphone

Repository files navigation

Cuphone

Cuphone是一个基于 NAT穿透 + TUN虚拟网卡 的虚拟局域网工具。支持 Ipv6,支持 Linux 和 Windows。

可用于局域网联机,已在 Minecraft、CS1.6 经过测试。

快速开始

1. 配置设置

# 复制配置文件模板
cp cuphone-config/cuphone.yaml.example cuphone.yaml

# 编辑配置文件,将 YOUR_WEBSOCKET_URL_HERE 替换为你的实际服务器地址
vim cuphone.yaml

2. 运行程序

# 编译并运行
cargo run --release

配置说明

  • 仅支持 YAML 格式配置文件
  • 配置文件模板位于 cuphone-config/cuphone.yaml.example
  • 程序会根据运行环境自动选择配置文件位置:
    • cargo run 时:优先读取工作目录下的配置文件
    • 可执行文件运行时:优先读取可执行文件同目录的配置文件
  • 详细的配置说明请参考 QUICKSTART.md

项目结构

  • cuphone/ - 主程序
  • cuphone-core/ - 核心类型定义
  • cuphone-net/ - 网络相关功能
  • cuphone-coordinator/ - 协调器客户端
  • cuphone-tun/ - TUN 接口实现
  • cuphone-config/ - 配置管理模块

About

A p2p virtual LAN tool based on NAT traversal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages