|
|
@@ -1,104 +1,59 @@
|
|
|
-MineCase
|
|
|
-[](https://ci.appveyor.com/project/sunnycase/minecase/branch/master)
|
|
|
-===
|
|
|
+# MineCase [](https://travis-ci.org/dotnetGame/MineCase) [](https://ci.appveyor.com/project/sunnycase/minecase/branch/master)
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-## 介绍
|
|
|
-`MineCase` 是一个分布式的 `minecraft` 服务端应用。`MineCase` 采用 `.net core` 编写，使用 `Orleans` 框架。<br>
|
|
|
-`MineCase` 具有以下特性：
|
|
|
+[English](https://github.com/dotnetGame/MineCase/blob/master/Readme.md) | [中文文档](https://github.com/dotnetGame/MineCase/blob/master/Readme-zh.md)
|
|
|
|
|
|
-* 跨平台
|
|
|
-* 分布式
|
|
|
-
|
|
|
-## 要求
|
|
|
-运行这个服务器之前，请保证你的环境满足：
|
|
|
+## Introduction
|
|
|
|
|
|
-* `.net core` sdk 2.0
|
|
|
+`MineCase` is a cross-platform, distributed `Minecraft` server application developed using `.NET Core` that uses the `Orleans` framework.
|
|
|
|
|
|
-目前支持的 `minecraft` 版本：
|
|
|
+We currently support [Release 1.12](https://minecraft.net/en-us/article/minecraft-112-pre-release-6) Minecraft protocol versions.
|
|
|
|
|
|
-* 1.12
|
|
|
+## Setup
|
|
|
|
|
|
-## 开始
|
|
|
+### From docker(Only support Linux)
|
|
|
|
|
|
->注：本项目还在施工阶段，还没有完成所有的功能。
|
|
|
+#### Install docker
|
|
|
|
|
|
-1. 获取源码
|
|
|
-```bash
|
|
|
-git clone [email protected]:dotnetGame/MineCase.git
|
|
|
-```
|
|
|
-或者 [下载ZIP](https://github.com/dotnetGame/MineCase/archive/master.zip)。
|
|
|
+You can install docker according to [this guide](https://docs.docker.com/engine/installation/).
|
|
|
|
|
|
-2. 构建并运行
|
|
|
+#### Run the application
|
|
|
|
|
|
-进入 `MineCase` 目录下，运行 `run_server.bat`，看到下面这一行提示的时候：
|
|
|
-```
|
|
|
-Press Ctrl+C to terminate...
|
|
|
+```bash
|
|
|
+curl -o docker-compose.yml https://raw.githubusercontent.com/dotnetGame/MineCase/master/build/docker/linux/docker-compose.yml
|
|
|
+docker-compose up
|
|
|
```
|
|
|
-再运行 `run_gateway.bat` 。
|
|
|
-
|
|
|
-## 进度
|
|
|
-
|
|
|
-| 模块 | 完成情况 |
|
|
|
-|:---:|:---:|
|
|
|
-|握手协议|:white_check_mark:|
|
|
|
-|登陆游戏|:white_check_mark:|
|
|
|
-|进入世界|:white_check_mark:|
|
|
|
-|地图生成|:x:|
|
|
|
-|怪物生成|:x:|
|
|
|
-|AI|:x:|
|
|
|
+You can use `docker-compose stop` to stop the application。
|
|
|
|
|
|
-## 反馈
|
|
|
+### From source
|
|
|
|
|
|
-如果你在使用 `MineCase` 的过程中遇到任何问题，请在 [Issues](https://github.com/dotnetGame/MineCase/issues) 中提出。
|
|
|
+#### Pre-requirement
|
|
|
|
|
|
-***
|
|
|
-
|
|
|
-## Introduction
|
|
|
-`MineCase` is a distributed `minecraft` server application. It is written in `.net core`, and using the `Orleans` framework. <br>
|
|
|
-`MineCase` has the following features:
|
|
|
+You need to install `.NET Core` sdk 2.0 first, you can find the version you need from [here](https://www.microsoft.com/net/download).
|
|
|
|
|
|
-* cross-platform
|
|
|
-* distributed
|
|
|
+#### Get source
|
|
|
|
|
|
-## Required
|
|
|
-Before running this server, please make sure your environment meet:
|
|
|
-
|
|
|
-* `.net core` sdk 2.0
|
|
|
-
|
|
|
-Currently supported version of `minecraft`:
|
|
|
+```bash
|
|
|
+git clone [email protected]:dotnetGame/MineCase.git
|
|
|
+cd MineCase
|
|
|
+```
|
|
|
+or [Download ZIP](https://github.com/dotnetGame/MineCase/archive/master.zip) and entry the `MineCase` directory.
|
|
|
|
|
|
-* 1.12
|
|
|
+#### Build and run
|
|
|
|
|
|
-## Getting Start
|
|
|
+* Windows
|
|
|
|
|
|
->Note: This project is still in the construction phase, has not completed all the feature.
|
|
|
+Double click the `build_and_run.bat`.
|
|
|
|
|
|
-1. Get source
|
|
|
-```bash
|
|
|
-git clone [email protected]:dotnetGame/MineCase.git
|
|
|
-```
|
|
|
-or [Download ZIP](https://github.com/dotnetGame/MineCase/archive/master.zip).
|
|
|
+* Linux or Mac
|
|
|
|
|
|
-2. Build and run
|
|
|
+Run the `build_and_run.sh`.
|
|
|
|
|
|
-Entry the `MineCase` directory, run `run_server.bat`, and when you see the following line：
|
|
|
-```
|
|
|
-Press Ctrl+C to terminate...
|
|
|
-```
|
|
|
-run `run_gateway.bat` .
|
|
|
+## Contributing
|
|
|
|
|
|
-## Schedule
|
|
|
+This project is still under development. We welcome and thank you for your contribution to this project.
|
|
|
|
|
|
-|Module|Finished|
|
|
|
-|:----:|:----:|
|
|
|
-|handshake|:white_check_mark:|
|
|
|
-|log in|:white_check_mark:|
|
|
|
-|entry the world|:white_check_mark:|
|
|
|
-|map generation|:x:|
|
|
|
-|monster generation|:x:|
|
|
|
-|AI|:x:|
|
|
|
+If you are a developer, we welcome you to fork this project and submit a `Pull Request` with your changes, and if you have any questions we can discuss together in the [Issues](https://github.com/dotnetGame/MineCase/issues).
|
|
|
|
|
|
-## Feedback
|
|
|
-If you encounter any problems with the use of `MineCase`, please point out that in [Issues](https://github.com/dotnetGame/MineCase/issues).
|
|
|
+If you are a user, any questions you may have while using this server, or any good suggestions, can be addressed to us in [Issues](https://github.com/dotnetGame/MineCase/issues).
|
Junyan Liu
