Skip to content

Commit 2bf6b35

Browse files
committed
Insane upgrade
1 parent c8dc09f commit 2bf6b35

File tree

1 file changed

+96
-22
lines changed

1 file changed

+96
-22
lines changed

src/content/docs/start/getting_started.mdx

Lines changed: 96 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -163,30 +163,90 @@ This will create a `ferrumc` executable in the `target/release` directory.
163163
2. Select the **latest** successful workflow
164164

165165
2. <Badge text="Optional" variant="note" /> **Generate a config file**
166-
~~~bash
167-
./ferrumc --setup
168-
~~~
166+
<Tabs syncKey="os">
167+
<TabItem label="Linux">
168+
~~~bash
169+
./ferrumc --setup
170+
~~~
171+
</TabItem>
172+
<TabItem label="macOS">
173+
~~~bash
174+
./ferrumc --setup
175+
~~~
176+
</TabItem>
177+
<TabItem label="Windows">
178+
~~~powershell
179+
.\ferrumc.exe --setup
180+
~~~
181+
</TabItem>
182+
</Tabs>
169183

170184
3. **Import an existing world**
171185

172186
Place the region files (.mca) in the folder named import then run
173-
~~~bash
174-
./ferrumc --import
175-
~~~
187+
<Tabs syncKey="os">
188+
<TabItem label="Linux">
189+
~~~bash
190+
./ferrumc --import
191+
~~~
192+
</TabItem>
193+
<TabItem label="macOS">
194+
~~~bash
195+
./ferrumc --import
196+
~~~
197+
</TabItem>
198+
<TabItem label="Windows">
199+
~~~powershell
200+
.\ferrumc.exe --import
201+
~~~
202+
</TabItem>
203+
</Tabs>
176204
The location of these files in minecraft is explained [here](https://minecraft.wiki/w/Region_file_format#Location)
177-
<FileTree>
178-
179-
- import region files in here
180-
- ...
181-
- config.toml
182-
- ferrumc
183-
184-
</FileTree>
205+
<HeadlessTabs syncKey="os">
206+
<TabItem label="Linux">
207+
<FileTree>
208+
- import region files in here
209+
- ...
210+
- config.toml
211+
- ferrumc
212+
</FileTree>
213+
</TabItem>
214+
<TabItem label="macOS">
215+
<FileTree>
216+
- import region files in here
217+
- ...
218+
- config.toml
219+
- ferrumc
220+
</FileTree>
221+
</TabItem>
222+
<TabItem label="Windows">
223+
<FileTree>
224+
- import region files in here
225+
- ...
226+
- config.toml
227+
- ferrumc.exe
228+
</FileTree>
229+
</TabItem>
230+
</HeadlessTabs>
185231
<Aside type="tip">
186232
If you want to modify batch size (default 150), you can use
187-
~~~bash
188-
./ferrumc --import --batch_size=<num>
189-
~~~
233+
<HeadlessTabs syncKey="os">
234+
<TabItem label="Linux">
235+
~~~bash
236+
./ferrumc --import --batch_size=<num>
237+
~~~
238+
</TabItem>
239+
<TabItem label="macOS">
240+
~~~bash
241+
./ferrumc --import --batch_size=<num>
242+
~~~
243+
</TabItem>
244+
<TabItem label="Windows">
245+
~~~cmd
246+
.\ferrumc.exe --import --batch_size=<num>
247+
~~~
248+
</TabItem>
249+
</HeadlessTabs>
190250
Basically the number of chunks to import at once, higher => faster but more CPU intensive.
191251
Max is 1024, since that's the max number of chunks in a region(.mca) file.
192252
</Aside>
@@ -206,16 +266,30 @@ This will create a `ferrumc` executable in the `target/release` directory.
206266
~~~
207267
</TabItem>
208268
<TabItem label="Windows">
209-
~~~bash
269+
~~~cmd
210270
.\ferrumc.exe
211271
~~~
212272
</TabItem>
213273
</HeadlessTabs>
214274

215275
You can change logging level by using ```--log=<level>```:
216-
~~~bash
217-
./ferrumc --log=info #for info level logging
218-
~~~
276+
<Tabs syncKey="os">
277+
<TabItem label="Linux">
278+
~~~bash
279+
./ferrumc --log=info #for info level logging
280+
~~~
281+
</TabItem>
282+
<TabItem label="macOS">
283+
~~~bash
284+
./ferrumc --log=info #for info level logging
285+
~~~
286+
</TabItem>
287+
<TabItem label="Windows">
288+
~~~cmd
289+
.\ferrumc.exe --log=info #for info level logging
290+
~~~
291+
</TabItem>
292+
</Tabs>
219293

220294
###### Logging values:
221295
- trace (Extremely verbose)
@@ -232,7 +306,7 @@ You can change logging level by using ```--log=<level>```:
232306
export FERRUMC_ROOT=/home/YourUser/Documents/Code/Rust/ferrumc
233307
~~~
234308
</TabItem>
235-
<TabItem label="macOS">
309+
<TabItem label="macOS">
236310
~~~bash
237311
export FERRUMC_ROOT=/home/YourUser/Documents/Code/Rust/ferrumc
238312
~~~

0 commit comments

Comments
 (0)