endernon/idmangler-cli
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 3 Wiki Activity

make README.md actually good, edit the error messages

Browse source
This commit is contained in:
endernon 2024-09-11 23:00:30 +01:00
parent ac31624f05
commit 5346e870e4
2 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -3,11 +3,14 @@ Basically this generates fake items by loading from a json. Effectively a wrappe
## How to get the program
### Option 1: prebuilt
Go to the releases tab
## how to use:
Go to the [releases tab](https://git.frfrnocap.men/endernon/idmangler-cli/releases)
### Option 2: compile yourself
requirements: rust, cargo
use cargo run --release to build and run
use cargo run --release to build and run.
## Usage
Move the program to some folder. Download these three files and place them next to the program:
https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json
https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json
https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json
read the provided config markdown file to understand how to edit config.json

12
src/main.rs
View file

@ -258,10 +258,10 @@ fn pass() {
const ERROR: [&'static str; 7] = [
"Error 0: what did you even do to get this? ",
"Error 1: json config file is missing, obtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this directory. ",
"Error 2: json config is broken. Reread the example data or reobtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this diirectory. ",
"Error 3: Identifications hashmap not found. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
"Error 4: Identifications hashhmap is corrupt. Reobtain it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
"Error 5: Shiny data json is missing. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/a8469fad2f3bd0fc0fe2678eeb812d7877c9e61b/Data-Storage/shiny_stats.json and move it to this directory. ",
"Error 6: Shiny data json is corrupt. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/a8469fad2f3bd0fc0fe2678eeb812d7877c9e61b/Data-Storage/shiny_stats.json and move it to this directory. "
"Error 1: json config json is missing, obtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this directory. ",
"Error 2: json config json is corrupt. Reread config.md or reobtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this diirectory. ",
"Error 3: Identifications hashmap is missing. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
"Error 4: Identifications hashmap is corrupt. Reobtain it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
"Error 5: Shiny data json is missing. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json and move it to this directory. ",
"Error 6: Shiny data json is corrupt. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json and move it to this directory. "
];