McWebserver/README.md
2023-09-07 00:56:27 +02:00

36 lines
2.5 KiB
Markdown

# McWebserver
This is the fabric port, the Forge version is available [here](https://github.com/J-onasJones/McWebserver-forge)
<a href="https://github.com/J-onasJones/McWeberver/blob/master/LICENSE"><img src="https://img.shields.io/github/license/J-onasJones/McWebserver?style=flat&color=900c3f" alt="License"></a>
<a href="https://discord.gg/V2EsuUVmWh"><img src="https://img.shields.io/discord/702180921234817135?color=5865f2&label=Discord&style=flat" alt="Discord"></a>
<a href="https://www.curseforge.com/minecraft/mc-mods/mcwebserver"><img src="https://cf.way2muchnoise.eu/full_649823.svg" alt="CF"></a>
<a href="https://modrinth.com/mod/mcwebserver"><img src="https://img.shields.io/modrinth/dt/mcwebserver?logo=modrinth&label=&style=flat&color=242629&labelColor=00AF5C&logoColor=white" alt="Modrinth"></a>
<a href="https://modrinth.com/mod/mcwebserver"><img src="https://img.shields.io/modrinth/game-versions/mcwebserver?logo=modrinth&color=242629&labelColor=00AF5C&logoColor=white"></a>
![GitHub all releases](https://img.shields.io/github/downloads/J-onasJones/McWebserver/total?label=GitHub%20downloads)
<a align="center"><img src="http://cdn.jonasjones.dev/mod-badges/support-fabric.png" width="250px"><img src="http://cdn.jonasjones.dev/mod-badges/support-quilt.png" width="250px"><img src="http://cdn.jonasjones.dev/mod-badges/support-forge.png" width="250px"></a>
<img src="http://cdn.jonasjones.dev/mod-badges/fabric-api.png" width="250px">
### About the mod
This mod runs a simple HTTP server alongside the minecraft server.
The mod allows You to host websites and share files and Server Backups directly from your server without the need of a seperate server setup. Adjust the port and design your website.
### API
It also has a powerful API allowing you to fetch server info about players and the server itself. More info on the [API's Wiki page](https://github.com/J-onasJones/McWebserver/wiki/3.-Web%E2%80%90API)
The http server has up to no performance impact on the server
### Warning
If used wrongly this mod can be a security risk for your server and all devices connected to the network that your server is in.
Do **only** put files into your webservers root directory that you want to be accessible to the internet. Those files are **public** to the entire world.
**Use at your own risk!**
<img src="https://raw.githubusercontent.com/modrinth/art/main/Branding/Badge/badge-light__184x72.png" width="250px">
### Setup
For Setup and further Info, please refer to the [Wiki](https://github.com/J-onasJones/McWebserver/wiki)