Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Meeples10 committed Dec 14, 2023
1 parent 2f7cc4b commit c0c0653
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Note that the numbers for `minecraft:air` may be inaccurate at high Y values due
### Command line arguments

```
java -jar mc-resource-analyzer-x.x.x.jar [-hHmsStV] [-B=PATH] [-M=PATH] [-o=STRING] [-T=PATH] [-v=VERSION] [INPUT]
java -jar mc-resource-analyzer-x.x.x.jar [-hmsStV] [-B=PATH] [-M=PATH] [-o=STRING] [-T=PATH] [-v=VERSION] [INPUT]
```

#### Positional arguments
Expand All @@ -30,7 +30,7 @@ java -jar mc-resource-analyzer-x.x.x.jar [-hHmsStV] [-B=PATH] [-M=PATH] [-o=STRI
- `-s`, `--statistics`: Outputs a file with statistics about the analysis.
- `-o`, `--output-prefix`: Use this argument to add a prefix to the program's output files. For example, using `-o abc` would result in the files `abc.csv` and `abc_table.html`.
- `-v`, `--version-select`: Use this argument if you want to analyze a world that was not generated with the latest version of Minecraft. Selecting a version that does not match the version with which the regions were generated may result in unexpected behavior. The following versions are supported:
- `ANVIL_118` for 1.18 to 1.20.2
- `ANVIL_118` for 1.18 to 1.20.4 (default)
- `ANVIL_2021` for 1.16 to 1.17
- `ANVIL_2018` for 1.13 to 1.15
- `ANVIL_2012` for 1.2 to 1.12
Expand All @@ -40,18 +40,17 @@ java -jar mc-resource-analyzer-x.x.x.jar [-hHmsStV] [-B=PATH] [-M=PATH] [-o=STRI
- `-m`, `--modernize-ids`: If analyzing regions saved before 1.13, numeric block IDs will be replaced with their modern string representations. If no string corresponding to the numeric ID is found, the numeric ID will be saved instead.
- `-B`, `--block-ids`: When using the `--modernize-ids` option on a world with block IDs outside the range of 0-255, use this to specify the path to a file containing block IDs in the same format as [blocks.properties](https://github.com/Meeples10/MCResourceAnalyzer/blob/master/src/main/resources/blocks.properties).
- `-M`, `--merge-ids`: When analyzing a world with block IDs outside the range of 0-255, use this to specify the path to a file containing block IDs in the same format as [merge.properties](https://github.com/Meeples10/MCResourceAnalyzer/blob/master/src/main/resources/merge.properties). Any block with an ID listed in this file will have all of its variants merged into a single value.
- `-H`, `--no-hack`: The program attempts to compensate for the aforementioned inaccuracies at high Y values by assuming that empty chunk sections are filled with air. Use this argument to disable this hack.
- `-n`, `--num-threads` (default: `8`): The maximum number of threads to use for analysis.
- `-S`, `--silent`: Prevents the program from printing output, other than errors. This may result in marginally improved performance.

### Version compatibility

MCResourceAnalyzer 1.2.3 can analyze worlds generated with any version of Minecraft: Java Edition between Indev 0.31 20100122 and 1.20.2.
MCResourceAnalyzer 1.2.4 can analyze worlds generated with any version of Minecraft: Java Edition between Indev 0.31 20100122 and 1.20.4.

Note that Indev worlds with the `Long` and `Deep` world shapes are not supported.

## Contributing

Contributions to this project are more than welcome. If you create your own fork, my only request is that you include the following URL somewhere in your fork: https://github.com/Meeples10/MCResourceAnalyzer
Contributions to this project are more than welcome. If you fork MCResourceAnalyzer, please include the following URL somewhere in your fork: https://github.com/Meeples10/MCResourceAnalyzer

If you notice that the program fails to analyze a particular world, please [create an issue](https://github.com/Meeples10/MCResourceAnalyzer/issues/new?title=Error%20when%20analyzing%20world&body=Minecraft%20version:%20%0A%0AProgram%20output:%0A%60%60%60%0A[paste%20output%20here]%0A%60%60%60%0A%0AOther%20details:%20%0A%0A%3C%21--%20If%20possible,%20please%20attach%20the%20region%20file%20that%20caused%20the%20failure%20--%3E) with the version of Minecraft with which the world was generated, the output of the program, and, if possible, the region file that caused the failure.
If you notice that MCResourceAnalyzer fails to analyze a particular world, please [create an issue](https://github.com/Meeples10/MCResourceAnalyzer/issues/new?title=Error%20when%20analyzing%20world&body=Minecraft%20version:%20%0A%0AProgram%20output:%0A%60%60%60%0A[paste%20output%20here]%0A%60%60%60%0A%0AOther%20details:%20%0A%0A%3C%21--%20If%20possible,%20please%20attach%20the%20region%20file%20that%20caused%20the%20failure%20--%3E) with the version of Minecraft with which the world was generated, the output of the program, and, if possible, the region file that caused the failure.

0 comments on commit c0c0653

Please sign in to comment.