обновление README
This commit is contained in:
29
README.MD
29
README.MD
@@ -1,3 +1,30 @@
|
||||
# MC-CORE
|
||||
|
||||
Minecraft server
|
||||

|
||||

|
||||
|
||||
Модульный **Minecraft** сервер.
|
||||
|
||||
## Модули
|
||||
|
||||
* **Core** - ядро сервера
|
||||
|
||||
## Сборка
|
||||
|
||||
```
|
||||
gradle jar
|
||||
```
|
||||
|
||||
Так же можно собрать все необходимые библиотеки в "кучу":
|
||||
|
||||
```
|
||||
gradle copyDep
|
||||
```
|
||||
|
||||
Или сразу развернув сервер где надо:
|
||||
|
||||
```
|
||||
gradle deploy -Ddeploy=path/to/folder -DcreateRunScript=true
|
||||
```
|
||||
|
||||
`createRunScript` - указание этого параметра создаст скрипт-запускатор
|
||||
102
core/README.MD
102
core/README.MD
@@ -6,59 +6,31 @@
|
||||
|
||||
### ConfigFromSpring
|
||||
|
||||
Implements: `mc.core.Config`
|
||||
Настройка параметров сервера через конфигурацию "спринга".
|
||||
|
||||
Bean:
|
||||
Имеются следующие настройки:
|
||||
* `descriptionServer` - описание сервера (aka "Motd")
|
||||
* `favicon` - файл с иконкой сервера
|
||||
* `maxPlayers` - максимальная вместимость сервера
|
||||
|
||||
**Implements:** `mc.core.Config`
|
||||
|
||||
**Bean example:**
|
||||
|
||||
```xml
|
||||
<bean id="config" class="mc.core.embedded.ConfigFromSpring">
|
||||
<property name="descriptionServer" value="MC Core"/>
|
||||
<property name="maxPlayers" value="100"/>
|
||||
<property name="faviconBase64" value="icon.png"/>
|
||||
<property name="favicon" value="icon.png"/>
|
||||
</bean>
|
||||
```
|
||||
|
||||
### IdleTime
|
||||
|
||||
Implements: `mc.core.time.TimeProcessor`
|
||||
|
||||
Bean:
|
||||
|
||||
```xml
|
||||
<bean id="idleTime" class="mc.core.time.IdleTime">
|
||||
<constructor-arg index="0" type="long" value="1000"/>
|
||||
</bean>
|
||||
```
|
||||
|
||||
в качестве параметра конструктора указывается стартовое время.
|
||||
|
||||
### TimePerTick
|
||||
|
||||
Implements: `mc.core.time.TimeProcessor`
|
||||
|
||||
Bean:
|
||||
|
||||
```xml
|
||||
<bean id="timePerTick" class="mc.core.time.TimePerTick">
|
||||
<property name="startGameTime" value="1000"/>
|
||||
</bean>
|
||||
```
|
||||
|
||||
в качестве параметра указывается стартовое время.
|
||||
|
||||
### RealTime
|
||||
|
||||
Implements: `mc.core.time.TimeProcessor`
|
||||
|
||||
Bean:
|
||||
|
||||
```xml
|
||||
<bean id="realTime" class="mc.core.time.RealTime"/>
|
||||
```
|
||||
|
||||
### GameLoop
|
||||
|
||||
Bean:
|
||||
**Bean example:**
|
||||
|
||||
Доступные параметры:
|
||||
* `gameTimer` - бин, управляющий ходом времени
|
||||
|
||||
```xml
|
||||
<bean id="gameLoop" class="mc.core.GameLoop">
|
||||
@@ -66,4 +38,48 @@ Bean:
|
||||
</bean>
|
||||
```
|
||||
|
||||
`gameTimer` - бин, управляющий ходом времени
|
||||
### IdleTime
|
||||
|
||||
Игровое время суток застывает на указанной отметке.
|
||||
|
||||
Доступные параметры:
|
||||
* `gameTime` - отметка времени (long)
|
||||
|
||||
**Implements:** `mc.core.time.TimeProcessor`
|
||||
|
||||
**Bean example:**
|
||||
|
||||
```xml
|
||||
<bean id="idleTime" class="mc.core.time.IdleTime">
|
||||
<property name="gameTime" value="1000"/>
|
||||
</bean>
|
||||
```
|
||||
|
||||
### TimePerTick
|
||||
|
||||
Игровое время суток соответствует игровым тикам (20 tps)
|
||||
|
||||
Доступные параметры:
|
||||
* `startGameTime` - стартовое время (long)
|
||||
|
||||
**Implements:** `mc.core.time.TimeProcessor`
|
||||
|
||||
**Bean example:**
|
||||
|
||||
```xml
|
||||
<bean id="timePerTick" class="mc.core.time.TimePerTick">
|
||||
<property name="startGameTime" value="1000"/>
|
||||
</bean>
|
||||
```
|
||||
|
||||
### RealTime
|
||||
|
||||
Игровое время суток соответствует реальному времени
|
||||
|
||||
**Implements:** `mc.core.time.TimeProcessor`
|
||||
|
||||
**Bean example:**
|
||||
|
||||
```xml
|
||||
<bean id="realTime" class="mc.core.time.RealTime"/>
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user