# CLEngine

**Repository Path**: hopefsharp/CLEngine

## Basic Information

- **Project Name**: CLEngine
- **Description**: 基于MonoGame开发的2D游戏引擎/编辑器
- **Primary Language**: C#
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: http://www.hyuan.org
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 30
- **Created**: 2019-11-16
- **Last Updated**: 2021-01-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CLEngine

### 项目介绍
该项目成立于2016年，基于MonoGame做的跨平台项目，目前暂时只支持Windows开发，许多库都是基于Windows制作的，该项目比不上unity也比不过cocos，成立之初是想快速开发，所以想在某一个领域做到极致，我不是专业的程序员，很多代码方面并不规范，也导致了开发过程中遇到了很多问题，庆幸的是这一切都能解决，希望大家能够一起完善这个项目。

官网: http://www.hyuan.org

### 引擎基本架构
- 图形库: `MonoGame`
    - OpenGL
    - DirectX
- 核心框架: `CLEngine`
- 网络库: `Lidgren.Network`
- UI库: `FairyGui`
- 动画: `DragonBones`
    - [x] 支持序列帧
    - [ ] 骨骼动画
- 音频: `NAudio`
- 物理引擎: `FarseerPhysics`

### 文件架构
- Game
    - 游戏（目前只有Windows，因为大多数的库都是基于windows制作的，发布到其他平台也是允许的，但是许多库就必须抛弃才能够运行）
- Engine.Core
    - 引擎核心（这里包括了许多游戏所需要的库，也包括公开给脚本引擎的一些API，这个库现在来说非常臃肿，希望有人能够帮助我拆分它们）
- Editor
    - 游戏编辑器（这也是一个庞大的东西，包括工程创建，代码编辑器，发布，编译）。
    - 脚本引擎（负责与Lua脚本交互）
    - 资源编译器
    - 场景设计器

### 未来支持
- 支持更多平台（编辑器仅支持在Windows上运行，游戏仅在Windows上测试成功。理论上游戏应该能在各个平台运行，不过需要作出一些调整）
- 支持骨骼动画（目前只支持龙骨导出的帧动画）
- 3D框架
- 更多的游戏模版

### 版本更新
我们承诺保证一周一次更新，默认周一进行`feature`分支合并进`master`，并将`feature`版本增加一个版本号，如果一个里程碑完成，则一次添加十个版本号，您可以参与我们的里程碑更新，不管更新内容的大小只要符合里程碑的要求我们则会通过pr并记录您为我们的贡献者。

### 如何参与项目
- `fork`项目
- `clone`项目
- 对代码进行 `修改/新增/删除`
- `提交/推送` 代码
- 发起 `pull request`
    - 选择最新的 `feature/xxx`进行操作
    - 编写该提交内容的作用
- 经项目管理者审核后合并至分支

### 开发规范
在开始开发项目当中，请先设置您的代码格式，在visual studio当中，`工具` -> `选项` -> `文本编辑器` -> `C#` -> `制表符`

- 设置缩进为 `块`
- 制表符当中选择 `保留制表符`
- 制表符大小 `4`
- 缩进大小 `4`

代码整理: `ctrl + k + f`

### 编辑器展示
![编辑器首页](ScreenShot/screenshot.png)

### 注意
本项目可以作为学习使用，但未经允许不得二次更改发布。不允许做任何其它商业使用。你可以加入我们或者询问合作事项。