Skip to content

Commit e27bcf6

Browse files
committed
added read me file
1 parent 0b0607a commit e27bcf6

File tree

4 files changed

+66
-1
lines changed

4 files changed

+66
-1
lines changed

.github/assets/bottom.png

1.28 MB
Loading

.github/assets/text_banner_dark.png

126 KB
Loading

.github/assets/text_banner_light.png

126 KB
Loading

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1+
![banner](.github/assets/text_banner_dark.png#gh-dark-mode-only)
2+
![banner](.github/assets/text_banner_light.png#gh-light-mode-only)
3+
14
# Machine
2-
1.19.2 Minecraft server implementation
5+
6+
[![license](https://img.shields.io/github/license/machinemc/machine?style=for-the-badge&color=657185)](../LICENSE)
7+
8+
Machine is a Minecraft Server software that is completely free and open source.
9+
It was created from scratch without any code from Mojang.
10+
11+
One key difference between vanilla Minecraft servers and Machine is that our
12+
software does not come with any default features. However, we offer a
13+
comprehensive API that allows you to easily create anything you desire.
14+
15+
**[!]** Right now Machine is heavily in development and is not ready to use in
16+
a production environment.
17+
18+
# Table of contents
19+
* [Why Machine](#why-machine)
20+
* [Building](#building)
21+
* [Credits](#credits)
22+
* [Contributing](#contributing)
23+
* [License](#license)
24+
25+
## Why Machine
26+
27+
Machine does not come with any default features,
28+
but instead offers a complete API that allows users to easily create their
29+
own custom features and modifications. This flexibility is beneficial for users who require high
30+
performance and greater control over their Minecraft servers.
31+
32+
Machine is a free and open source Minecraft Server software,
33+
which means that anyone can download, use, modify, and distribute its code
34+
without any cost or restriction.
35+
36+
Machine's codebase is clean and straightforward, making it easier for
37+
users to understand how the server works and to modify it as needed.
38+
39+
**Advantages:**
40+
* Remove the overhead of vanilla features
41+
* Multi-threaded
42+
* Open-source
43+
* Modern API
44+
45+
**Disadvantages:**
46+
* Does not work with Bukkit plugins
47+
* Does not work with older clients
48+
* Bad for vanilla experience
49+
* It takes longer to develop something playable
50+
51+
## Building
52+
* Configure ITJ Gradle to use JDK 17.
53+
* Reload all gradle projects & run newly created task `buildAll` in group `build` of the root Machine project.
54+
55+
## Credits
56+
* The [contributors](https://github.com/MachineMC/Machine/graphs/contributors) of the project. ❤️
57+
* [The Minecraft Coalition](https://wiki.vg/) and [`#mcdevs`](https://github.com/mcdevs) - protocol and file formats research.
58+
* [The Minecraft Wiki](https://minecraft.gamepedia.com/Minecraft_Wiki) for all their useful info.
59+
* [Minestom](https://github.com/Minestom) and [Krypton](https://github.com/KryptonMC) projects for inspiration when designing both api and implementation.
60+
61+
## Contributing
62+
See [CONTRIBUTING.md](CONTRIBUTING.md) file fore more information about contributing and project guidelines.
63+
64+
## License
65+
Machine is free software licensed under the [GPUv3 license](LICENSE).
66+
67+
![bottom](.github/assets/bottom.png)

0 commit comments

Comments
 (0)