|
|
@@ -7,26 +7,29 @@ MineCase
|
|
|
|
|
|
#### [English](https://github.com/dotnetGame/MineCase/blob/master/README.md) | [中文](https://github.com/dotnetGame/MineCase/blob/master/README-zh.md)
|
|
|
|
|
|
-`MineCase` is a cross-platform application with distributed server of `Minecraft`.
|
|
|
-The project is designed to create a high-performance, distributed system by using isolating different components through actor mode.
|
|
|
-Different chunks are managed by different servers so that all players can play in a world. This makes minecraft servers more scalable.
|
|
|
-Anarchy servers can allow more players to join in without waiting in queue by using distributing server.
|
|
|
-It written in `C#` with `.NET Core 2.0` env and based on `orleans` framework to work with released [1.12 protocol](https://minecraft.net/en-us/article/minecraft-112-pre-release-6).
|
|
|
+`MineCase` is a `Minecraft` server implement in dotnet core.
|
|
|
+The project is designed to create a high-performance, distributed `Minecraft` server with virtual actor provided by Orleans distributed framework.
|
|
|
+Different chunks are managed on different servers so that more players can join in and play in the same world. This makes minecraft servers more scalable.
|
|
|
+Servers like Anarchy servers can allow more players to join in without waiting in queue by using distributed server.
|
|
|
+It written in `C#` with `.NET Core 3.1` env and based on `orleans` framework to work with released [1.15.2 protocol](https://www.minecraft.net/en-us/article/minecraft-java-edition-1-15-2). The [website](https://wiki.vg/) describes the Minecraft protocol clearly.
|
|
|
+
|
|
|
+**MineCase is under refactoring, so branch refactor may not work.**
|
|
|
|
|
|
**MineCase is not stable and lack of many features now. Please don't use MineCase in production unless you know what you're doing.**
|
|
|
|
|
|
|
|
|
|
|
|
## Run Requirements
|
|
|
-* [.Net Core 2.0](https://www.microsoft.com/net/download)
|
|
|
+* [.Net Core 3.1](https://www.microsoft.com/net/download)
|
|
|
* [MongoDB](https://www.mongodb.com/download-center/community)
|
|
|
|
|
|
## Install (Build From Source)
|
|
|
* 1 . Download and install a `.NET Core sdk` from this [page](https://www.microsoft.com/net/download).
|
|
|
* 2 . Download and install a `MongoDB` from this [page](https://www.mongodb.com/download-center?jmp=nav#community).
|
|
|
* 3 . Download a `MineCase` archive from the [github page](https://github.com/dotnetGame/MineCase/archive/master.zip) (or **clone:**)
|
|
|
+
|
|
|
```bash
|
|
|
- git clone --depth 1 https://github.com/dotnetGame/MineCase.git
|
|
|
+ git clone [email protected]:dotnetGame/MineCase.git
|
|
|
cd MineCase
|
|
|
```
|
|
|
* 4 . Un-zip `Minecase` archive.
|
|
|
@@ -35,46 +38,45 @@ It written in `C#` with `.NET Core 2.0` env and based on `orleans` framework to
|
|
|
* **Linux** : Run the `build_and_run.sh`.
|
|
|
* **Win** : Double-click `build_and_run.bat`.
|
|
|
|
|
|
-## Install (Docker)
|
|
|
-* 1 . Download and install `Docker` [Mac](https://docs.docker.com/docker-for-mac/install/) [Linux](https://docs.docker.com/install/) [Windows](https://docs.docker.com/docker-for-windows/install/).
|
|
|
-* 2 .
|
|
|
+## How it works
|
|
|
+None
|
|
|
|
|
|
- ```bash
|
|
|
- url=https://raw.githubusercontent.com/dotnetGame/MineCase/master/build/docker/linux/docker-compose.yml
|
|
|
- curl -o docker-compose.yml $url
|
|
|
- docker-compose up
|
|
|
- ```
|
|
|
- ##### Tips:
|
|
|
- * You can stop the server by enter `docker-compose stop`.
|
|
|
+
|
|
|
+
|
|
|
+## Contributors
|
|
|
+[](https://github.com/sunnycase)[](https://github.com/jstzwj)[](https://github.com/akemimadoka)[](https://github.com/Alinshans)[](https://github.com/ray-cast)[](https://github.com/Melonpi)[](https://github.com/zaoqi)
|
|
|
+
|
|
|
+## Credits
|
|
|
+
|
|
|
+**Patreon backers**
|
|
|
+
|
|
|
+Wooden Pickaxe backers:
|
|
|
+
|
|
|
+* [](https://www.patreon.com/acid_chicken) Acid Chicken
|
|
|
+* [](https://www.patreon.com/user/creators?u=4934636) Balajanovski
|
|
|
+* [](https://www.patreon.com/Gongo/creators) Gongo
|
|
|
|
|
|
## Get Involved
|
|
|
+
|
|
|
We need help to make MineCase better. You can help us by fixing bugs, developing new features, improving documents.
|
|
|
Some new contributors wonder what to work. The project began with the love for Minecraft, so our answer is always "do what you love".
|
|
|
|
|
|
## Contact
|
|
|
- This project is still under development.
|
|
|
+This project is still under development.
|
|
|
You can submit code by using `Pull Requests` or Feel free to contact me via `e-mail` or `issues`, I'll add your profile to team members
|
|
|
and if you have any questions we can discuss together in the [Issues](https://github.com/dotnetGame/MineCase/issues).
|
|
|
and also 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).
|
|
|
we welcome and thank your contribution for this project.
|
|
|
|
|
|
* Reach me via e-mail: [email protected]
|
|
|
-* [Discord](https://discord.gg/8Z5RSRn) : MineCase
|
|
|
+* Discord : [MineCase](https://discord.gg/8Z5RSRn)
|
|
|
* QQ Group: 667481568
|
|
|
|
|
|
-## Credits
|
|
|
-
|
|
|
-**Patreon supporters list**
|
|
|
-
|
|
|
-Wooden Pickaxe Supporter:
|
|
|
-
|
|
|
-- Acid Chicken
|
|
|
-
|
|
|
[License (MIT)](https://raw.githubusercontent.com/dotnetGame/MineCase/master/LICENSE)
|
|
|
-------------------------------------------------------------------------------
|
|
|
MIT License
|
|
|
|
|
|
- Copyright (c) 2017-2019 MineCase
|
|
|
+ Copyright (c) 2017-2020 MineCase
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
JasonWang