Update documentation
This commit is contained in:
parent
743b0c4c34
commit
2614c7ce77
2
.gitignore
vendored
2
.gitignore
vendored
@ -2,4 +2,4 @@
|
|||||||
target
|
target
|
||||||
/output.log
|
/output.log
|
||||||
/world
|
/world
|
||||||
/.cargo
|
/server-icon.png
|
||||||
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2020-2022 Garen Tyler
|
Copyright (c) 2020-2023 Garen Tyler
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
18
README.md
18
README.md
@ -1,13 +1,19 @@
|
|||||||
# Composition
|
# Composition
|
||||||
|
Composition is a new Minecraft server written from the ground-up in Rust.
|
||||||
|
|
||||||
Composition is targeting 1.8.9, protocol version 47.
|
Composition is targeting Minecraft version 1.19.3, protocol version 761.
|
||||||
The main goal is to get a working server, then optimize for speed.
|
The main goal is to get a working server, then optimize for speed (multi-threading/kubernetes/etc).
|
||||||
|
|
||||||
## Development Resources
|
## Project Structure
|
||||||
|
Composition is broken up into multiple crates to speed up build times and improve modularity.
|
||||||
|
- `src/main.rs` is a wrapper around `composition-core` that sets up logging among other things.
|
||||||
|
This is the main binary that is exported with `cargo build`.
|
||||||
|
- `composition-core` implements the main server logic, such as handling clients and loading world chunks.
|
||||||
|
- `composition-protocol` handles the types and packets needed for network communication.
|
||||||
|
The library was designed to be able to used by anyone looking to implement a Minecraft server.
|
||||||
|
|
||||||
- [Normal Login Sequence](https://wiki.vg/Protocol_FAQ#What.27s_the_normal_login_sequence_for_a_client.3F)
|
## Useful Resources
|
||||||
- [Protocol Specification](https://wiki.vg/Protocol)
|
- [Protocol Specification](https://wiki.vg/Protocol)
|
||||||
|
- [Normal Login Sequence](https://wiki.vg/Protocol_FAQ#What.27s_the_normal_login_sequence_for_a_client.3F)
|
||||||
- [Server Ping](https://wiki.vg/Server_List_Ping)
|
- [Server Ping](https://wiki.vg/Server_List_Ping)
|
||||||
- [Map Format](https://wiki.vg/Map_Format)
|
- [Map Format](https://wiki.vg/Map_Format)
|
||||||
- [Rust TcpStream Docs](https://doc.rust-lang.org/std/net/struct.TcpStream.html)
|
|
||||||
- [Rust Channel Docs](https://doc.rust-lang.org/std/sync/mpsc/index.html)
|
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
log_level = "debug"
|
log_level = "debug"
|
||||||
max_players = 20
|
max_players = 20
|
||||||
motd = "Hello world!"
|
motd = "Hello world!"
|
||||||
ping_game_version = "1.18.1"
|
ping_game_version = "1.19.3"
|
||||||
port = 25565
|
port = 25565
|
||||||
server_icon = "server-icon.png"
|
server_icon = "server-icon.png"
|
||||||
|
|
||||||
|
BIN
server-icon.png
BIN
server-icon.png
Binary file not shown.
Before Width: | Height: | Size: 11 KiB |
Loading…
x
Reference in New Issue
Block a user