Skip to content

Commit 03eaf7d

Browse files
committed
feat: add readme
1 parent edca068 commit 03eaf7d

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

.idea/artifacts/MinecraftServerConnection_jar.xml

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Minecraft Server Admin Panel
2+
A small Admin Panel using the new Minecraft Server Management Protocol.
3+
The backend code like json parsing methods and websocket requests is written by me. For the UI I let generative AI help me.
4+
5+
## Usage
6+
Under linux create the file ```~/.minecraftServerSecret``` and put the URL to the websocket server of the minecraft server into the first line.
7+
Put the secret into the second line.
8+
9+
Example File `~/.minecraftServerSecret`:
10+
```
11+
wss://example.com:25585
12+
ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcd
13+
```
14+
15+
When starting the Admin Panel it will ask for the Websocket URL and the Secret but will automatically fill the fields with the first and second line of `~/.minecraftServerSecret` respectively.

src/META-INF/MANIFEST.MF

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Manifest-Version: 1.0
2+
Main-Class: server.Main
3+

0 commit comments

Comments
 (0)