@@ -72,7 +72,7 @@ our [Discord server](https://discord.gg/qT5J8EMjwk) for help or to discuss the p
72
72
<h4>📝 Custom made network, NBT and Anvil encoding systems to allow for minimal I/O lag</h4>
73
73
</li >
74
74
<li >
75
- <h4>💾 Multiple database options to finetune the server to your needs </h4>
75
+ <h4>💾 Crazy fast K/V database </h4>
76
76
<i>32 render distance*</i>
77
77
<img src="https://github.com/ferrumc-rs/ferrumc/blob/master/assets/README/chunk_loading.gif?raw=true" alt="Chunk Loading DEMO">
78
78
</li >
@@ -94,7 +94,7 @@ our [Discord server](https://discord.gg/qT5J8EMjwk) for help or to discuss the p
94
94
<h4>Optimizations</h4>
95
95
</li >
96
96
<li>
97
- <h4>Plugin support (JVM currently, other languages will be considered later)</h4>
97
+ <h4>Plugin support (FFI currently, other languages will be considered later)</h4>
98
98
</li>
99
99
</ul >
100
100
@@ -148,9 +148,23 @@ cargo build --release
148
148
149
149
## 🖥️ Usage
150
150
151
+ ``` plaintext
152
+ Usage: ferrumc.exe [OPTIONS] [COMMAND]
153
+
154
+ Commands:
155
+ setup Sets up the config
156
+ import Import the world data
157
+ run Start the server (default, if no command is given)
158
+ help Print this message or the help of the given subcommand(s)
159
+
160
+ Options:
161
+ --log <LOG> [default: debug] [possible values: trace, debug, info, warn, error]
162
+ -h, --help Print help
163
+ ```
164
+
151
165
1 . Move the FerrumC binary (` ferrumc.exe ` or ` ferrumc ` depending on the OS) to your desired server directory
152
166
2 . Open a terminal in that directory
153
- 3 . (Optional) Generate a config file: ` ./ferrumc -- setup `
167
+ 3 . (Optional) Generate a config file: ` ./ferrumc setup `
154
168
- Edit the generated ` config.toml ` file to customize your server settings
155
169
4 . Import an existing world: Either copy your world files to the server directory or specify the path to the world files
156
170
in the ` config.toml ` file. This should be the root directory of your world files, containing the ` region ` directory
@@ -218,10 +232,9 @@ with the vanilla server, but we do plan on implementing some sort of terrain gen
218
232
219
233
### Will there be plugins? And how?
220
234
221
- We do very much plan to have a plugin system and as of right now, our plan is to leverage the
222
- JVM to allow for plugins to be written in Kotlin, Java, or any other JVM language. We are also considering other
223
- languages
224
- such as Rust, JavaScript and possibly other native languages, but that is a fair way off for now.
235
+ We do very much plan to have a plugin system and as of right now we are planning to use
236
+ some kind of ffi (foreign function interface) to allow for plugins to be written in other languages.
237
+ Not confirmed yet.
225
238
226
239
### What does 'FerrumC' mean?
227
240
0 commit comments