Compare commits

...

2 Commits

Author SHA1 Message Date
caa0801765 Add a demo video 2024-06-05 13:29:18 +02:00
a4509ea4a3 Add README.md 2024-06-05 13:11:53 +02:00

45
README.md Normal file
View File

@ -0,0 +1,45 @@
# Minecraft Realms Emulator
This is a custom implementation of a Minecraft Realms server for Java Edition,
written in C#.
# Requirements
- .NET SDK (version 8.0 or higher)
- Minecraft Java Edition
- PostgreSQL (for database support)
- Docker (for `REALMS` mode to work)
# Installation
Clone the repository:
```sh
git clone https://github.com/CyberL1/Minecraft-Realms-Emulator.git
cd Minecraft-Realms-Emulator/Minecraft-Realms-Emulator
```
Configure the server:
Create a `.env` file:
```
CONNECTION_STRING="User Id=postgres;Password=password;Server=db;Port=5432;Database=Minecraft-Realms-Emulator;"
ADMIN_KEY="[RANDOMLY GENERATED KEY]"
```
Build the server:
```sh
dotnet build
```
Run the server:
```sh
dotnet run
```
# Demo
[![Demo](https://img.youtube.com/vi/5pHPsKQhEjI/0.jpg)](https://www.youtu.be/5pHPsKQhEjI)