Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/defnot001/mc_scoreboards
Small program to make datapacks for minecraft servers to generate and update minecraft scoreboards.
https://github.com/defnot001/mc_scoreboards
cli datapacks minecraft rust scoreboards stats
Last synced: 25 days ago
JSON representation
Small program to make datapacks for minecraft servers to generate and update minecraft scoreboards.
- Host: GitHub
- URL: https://github.com/defnot001/mc_scoreboards
- Owner: defnot001
- Created: 2023-03-26T21:04:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-02T12:39:58.000Z (12 months ago)
- Last Synced: 2024-01-03T13:20:36.151Z (12 months ago)
- Topics: cli, datapacks, minecraft, rust, scoreboards, stats
- Language: Rust
- Homepage:
- Size: 337 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# MC Scoreboards
A tool to generate scoreboards for all statistics that Minecraft tracks. This CLI program generates a datapack with mcfunctions that can be loaded and executed on a server.
In the [releases tab](https://github.com/defnot001/mc_scoreboards/releases), you can find premade datapacks for all the supported versions.
Currently supported versions:
- 1.16.5
- 1.17.1
- 1.18.2
- 1.19.2
- 1.19.3
- 1.19.4
- 1.20.4
If you need a datapack an unsupported version, don't hesitate to open an issue or join my [Discord server](https://discord.gg/wmJ3WBYcZF).
## Using the program
If you want to build and execute this program yourself, you can do so by following these steps. Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed.
### Building the program
Clone this repository:
```shell
git clone https://github.com/defnot001/mc_scoreboards.git
```
Go into into the project directory:
```shell
cd mc_scoreboards
```
Build the program:
```shell
cargo build --release
```
You should now have a binary in `target/release/mc_scoreboards`.
### Creating the datapack
This CLI program accepts multiple arguments and flags that can be used to customize the output. You can see all the options by running mc_scoreboards --help.
The most basic usage on Linux and Mac will look like this:
```shell
./target/release/mc-scoreboards 1.20.4
```
On Windows, you will need to use the `.exe` file:
```shell
./target/release/mc-scoreboards.exe 1.20.4
```
This will create a datapack in the current directory with the name `scoreboards_1.19.3.zip`. You can then load this datapack on your server and execute the functions in it.
```shell
/reload
/function mc-scoreboards:create
```
If you want to remove the scoreboard, you can run the following command:
```shell
/function mc-scoreboards:remove
```
The flags that are additionally available are:
#### `--outdir` (`-o`):
You can use this flag to specify an output directory for the datapack. If this flag is not specified, the datapack will be created in the current directory.
#### `--stats` (`-s`):
Whenever you create a new scoreboard in minecraft, it will initialize all scores to 0.
If you want to update the scores to the current value of the statistic you need to specify this flag and point it to the stats folder of your world.
You can find the `stats` folder in the `world` folder of your server.
If you specify this flag, the program will read the stats files and create a third mcfunction file called `update.mcfunction` that will update the scoreboard to the current value of the statistic.
```shell
./target/release/mc-scoreboards 1.19.3 -s /path/to/stats/folder
```
#### `--whitelist` (`-w`):
Currently, this flag is required if you want to use the `--stats` flag and it also only works if you also specify the `--stats` flag.
```shell
./target/release/mc-scoreboards 1.19.3 -s /path/to/stats/folder -w /path/to/whitelist.json
```
### Naming Convention
This program follows the naming convention introduced by [every-scroreboard](https://github.com/samipourquoi/every-scoreboard).
The scoreboards are named accordingly:
- `m-` Blocks mined
- `u-` Items used
- `c-` Items crafted
- `b-` Tools broken
- `p-` Items picked up
- `d-` Items dropped
- `k-` Mobs killed
- `kb-` Killed by mob
- `z-` Custom stats (find all possible `stats` [here](https://minecraft.fandom.com/wiki/Statistics#List_of_custom_statistic_names))
If you are looking for translation files, check out [scoreboard-translations](https://github.com/defnot001/scoreboard-translations) to get pretty printed json files for translation purposes.
#### Acknowledgements
This program is heavily inspired by [every-scroreboard](https://github.com/samipourquoi/every-scoreboard). I would like to thank [samipourquoi](https://github.com/samipourquoi) for creating this project and making it open source aswell as [Syntro42](https://github.com/Syntro42) for maintaining it.
Thank you for reading this far! If you have any questions, feel free to join my [Discord server](https://discord.gg/wmJ3WBYcZF). If you find any bugs, please open an [issue](https://github.com/defnot001/mc_scoreboards/issues) on GitHub. If you liked this project, please consider starring it on GitHub.