# LockStepFramework

**Repository Path**: Wnity/lock-step-framework

## Basic Information

- **Project Name**: LockStepFramework
- **Description**: No description available
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-22
- **Last Updated**: 2025-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LockStepFramework README

这是一个基于Unity的锁步框架，适用于多人游戏开发中的同步需求。

## 功能特性

- **锁步同步**：确保所有客户端在相同的时间步长下运行游戏逻辑，以保持同步。
- **网络通信**：通过WebSocket实现客户端与服务器之间的实时通信。
- **定时与协程支持**：支持在锁步环境中使用定时器和协程，以处理复杂的异步逻辑。
- **测试用例**：提供多个测试场景，帮助开发者快速上手和验证框架功能。

## 安装指南

1. **导入Unity项目**：将本仓库中的`Assets`文件夹导入到你的Unity项目中。
2. **配置网络**：确保服务器和客户端的网络设置正确，包括IP地址和端口号。
3. **设置测试场景**：根据需要配置测试场景，例如`TestTimerAndCoroutine.unity`。

## 使用示例

### 初始化锁步世界

在你的游戏初始化脚本中，使用`LockStepWorld`来启动锁步循环：

```csharp
LockStepWorld.current.SetHerz(60, 30); // 设置客户端和服务器的帧率
LockStepWorld.current.StartWorld(); // 启动锁步世界
```

### 处理网络消息

使用`NetManager`来处理客户端与服务器之间的消息传递：

```csharp
NetManager netManager = new NetManager();
netManager.login("user123", OnLoginResponse);
netManager.createRoom(OnCreateRoomResponse);
```

### 添加游戏逻辑

通过继承`LockStepBehaviour`或`LockStepBehaviourEx`来添加你的游戏逻辑：

```csharp
public class MyGameLogic : LockStepBehaviour
{
    protected override void Update_LS()
    {
        // 在这里添加你的锁步更新逻辑
    }
}
```

## 测试与调试

- **测试场景**：使用提供的测试场景如`TestTimerAndCoroutine.unity`来验证框架的功能。
- **调试工具**：利用`DebugDrawer`和`FpsCounter`来调试物理模拟和性能。

## 贡献指南

欢迎贡献代码和文档。请遵循以下步骤：

1. Fork本仓库。
2. 创建新分支。
3. 提交你的更改。
4. 创建Pull Request。

## 许可证

本项目使用MIT许可证。详情请查看`LICENSE`文件。