Skip to content

Commit 7c6227f

Browse files
committed
Update README.md
1 parent f408d00 commit 7c6227f

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The project is still at its early stages and will undergo drastic changes.
88

99
## Project structure
1010

11-
metamc is split into 2 parts.
11+
metamc is split into 2 parts, both of which are written in Rust.
1212

1313
### libmcmeta
1414

@@ -23,6 +23,29 @@ modloader installers) and then either serving these metadata files or
2323
generating them for usage somewhere else (like GitHub Pages). It is licensed
2424
under GPL-3.0-only.
2525

26+
#### How to run this
27+
28+
Since no binaries are released yet, you will have to clone and compile this
29+
repository yourself. Make sure you have Rust installed and then run:
30+
31+
```sh
32+
git clone https://github.com/PrismLauncher/mcmeta.git
33+
cd mcmeta/mcmeta
34+
35+
export RUST_LOG=INFO
36+
export MCMETA_BIND_ADDRESS=127.0.0.1:9988
37+
export MCMETA_META_DIRECTORY=../meta
38+
cargo run
39+
```
40+
41+
#### Endpoints
42+
43+
The following endpoints are currently implemented:
44+
45+
- `GET /raw/mojang` for the Mojang version manifest, which contains all
46+
versions
47+
- `GET /raw/mojang/:version` for a specific Minecraft version, if it exists
48+
2649
## Goals
2750

2851
Eventually, mcmeta should implement at least the following goals:

0 commit comments

Comments
 (0)