Skip to content

Commit dc11026

Browse files
committed
Added README and LICENSE FILES
1 parent 5cd0306 commit dc11026

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Saad Muhammad
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# FerrumC
2+
3+
A high performance Minecraft server written in Rust.
4+
5+
## Description
6+
7+
FerrumC is a Minecraft server written from the ground up in rust with performance in mind. Utilizing the power of the
8+
Rust language, FerrumC is able to achieve high performance and low latency. FerrumC is designed to be a drop-in
9+
replacement for the vanilla Minecraft server, and aims to be compatible with all vanilla clients. The open-source
10+
nature of FerrumC allows for the community to contribute to the project and help shape the future of the server. It
11+
also allows for easy tweaking and customization of the server to fit the needs of the user.
12+
13+
## Getting Started
14+
15+
### Dependencies
16+
17+
* Nothing but the Rust compiler!
18+
19+
### Installing
20+
21+
You can either download the source code and compile it yourself to get bleeding edge updates, or download a pre-compiled
22+
binary from the releases page.
23+
24+
### Using FerrumC
25+
26+
#### Compiling from source
27+
```
28+
git clone https://github.com/Sweattypalms/ferrumc
29+
cd ferrumc
30+
cargo build --release # This will take a while
31+
cd target/release
32+
```
33+
34+
#### Running the server
35+
* Move the binary to a directory of your choice (it will create a few files in the directory it is run from)
36+
* Run the binary with `./ferrumc.exe` on Windows or `./ferrumc` on Linux/Mac to start up the server with the default settings
37+
* You can also run `./ferrumc --setup` to generate a config file and then edit it to your liking
38+
39+
## License
40+
41+
This project is licensed under the MIT License - see the LICENSE.md file for details
42+
43+
## Acknowledgments
44+
45+
Inspiration, code snippets, dependencies etc.
46+
* [Tokio Runtime](https://github.com/tokio-rs/tokio)

0 commit comments

Comments
 (0)