Added instructions to readme
This commit is contained in:
parent
3ae79e9485
commit
ed53413eba
41
readme.md
41
readme.md
|
@ -1,6 +1,45 @@
|
||||||
# Favorite Place
|
# Favorite Place
|
||||||
|
|
||||||
Simple Minecraft Server that generates terrain based on simple mathematical equations.
|
Simple Minecraft Server that generates terrain based on simple mathematical
|
||||||
|
equations.
|
||||||
|
|
||||||
Imagine your favorite place. For me, it is a meadow with grass and some wild
|
Imagine your favorite place. For me, it is a meadow with grass and some wild
|
||||||
flowers, and it is on a hill that can defined by a mathematical equation.
|
flowers, and it is on a hill that can defined by a mathematical equation.
|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
### Cloning
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://purplecello.serveminecraft.net/git/KylerOlsen/favorite-place.git
|
||||||
|
```
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
- Python 3
|
||||||
|
- It is recommended to use the [pypy](https://www.pypy.org/) distribution of
|
||||||
|
python for increased speed and performance.
|
||||||
|
- Python bitstring 3.1.9
|
||||||
|
- Python quarry
|
||||||
|
- Python requests (Optional)
|
||||||
|
- Used to download the Minecraft 1.18.2 Java Server jar for the data
|
||||||
|
generator.
|
||||||
|
- Java 17+ (Optional)
|
||||||
|
- Used to run the data generator from the Minecraft 1.18.2 Java Server jar.
|
||||||
|
|
||||||
|
### Data Reports
|
||||||
|
|
||||||
|
The data reports are used by the server to encode game data correctly for the
|
||||||
|
client to receive it.
|
||||||
|
|
||||||
|
The reports from the data generator must be in
|
||||||
|
`generate_data\generated\reports`. If the optional dependencies are installed
|
||||||
|
and the `generate_data` directory does not exists, the sever will download the
|
||||||
|
jar and run the data generator.
|
||||||
|
|
||||||
|
### Running
|
||||||
|
|
||||||
|
In the root directory of the repository run:
|
||||||
|
```
|
||||||
|
python server/main.py
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue