forked from ferrumc-rs/ferrumc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5cd0306
commit dc11026
Showing
2 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Saad Muhammad | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# FerrumC | ||
|
||
A high performance Minecraft server written in Rust. | ||
|
||
## Description | ||
|
||
FerrumC is a Minecraft server written from the ground up in rust with performance in mind. Utilizing the power of the | ||
Rust language, FerrumC is able to achieve high performance and low latency. FerrumC is designed to be a drop-in | ||
replacement for the vanilla Minecraft server, and aims to be compatible with all vanilla clients. The open-source | ||
nature of FerrumC allows for the community to contribute to the project and help shape the future of the server. It | ||
also allows for easy tweaking and customization of the server to fit the needs of the user. | ||
|
||
## Getting Started | ||
|
||
### Dependencies | ||
|
||
* Nothing but the Rust compiler! | ||
|
||
### Installing | ||
|
||
You can either download the source code and compile it yourself to get bleeding edge updates, or download a pre-compiled | ||
binary from the releases page. | ||
|
||
### Using FerrumC | ||
|
||
#### Compiling from source | ||
``` | ||
git clone https://github.com/Sweattypalms/ferrumc | ||
cd ferrumc | ||
cargo build --release # This will take a while | ||
cd target/release | ||
``` | ||
|
||
#### Running the server | ||
* Move the binary to a directory of your choice (it will create a few files in the directory it is run from) | ||
* Run the binary with `./ferrumc.exe` on Windows or `./ferrumc` on Linux/Mac to start up the server with the default settings | ||
* You can also run `./ferrumc --setup` to generate a config file and then edit it to your liking | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the LICENSE.md file for details | ||
|
||
## Acknowledgments | ||
|
||
Inspiration, code snippets, dependencies etc. | ||
* [Tokio Runtime](https://github.com/tokio-rs/tokio) |