Sinners of all rarities
This was made because it seems the tier list maker website hasn't been updated in a while. If you see any errors, that's totally on me. I wrote this in like 8 hours when I should have been sleeping. Make an issue or pull request if it bothers you. ## Installation You can either install it via `cargo` or compile from the source. ### Installing from Cargo (Recommended) To install it via Cargo from [crates.io](https://crates.io/), first ensure you have Cargo installed. You can check with the version command: ```bash cargo -V ``` If you need to install Cargo, look up a guide on your favorite search engine. Once it's installed, just run the installation command: ```bash cargo install ``` This is basically the same as compiling from the source, but more convenient. The binary will be usable as `limbus-image` if Rust is correctly configured in your path. Look it up if you have trouble or something. ### Building From the Source To build from the source, clone the repo and run the cargo command: ```bash cargo build --release ``` The binary will be created at `./target/release/limbus-image`. Use this path when executing in **Usage** instead of `limbus-image`. ## Usage ### Config file The binary requires a configuration [TOML](https://toml.io/en/) file in the following format: ```toml # Yi Sang is the first sinner by number, so he is first in the file [[sinner]] name = "Yi Sang" # Sinner name (for bottom text) path = "yi_sang" # Path of folder id = [ { name = "LCB Sinner", rarity = 1, image = "lcb.png" }, { name = "Seven Association", rarity = 2, image = "seven.png" }, { name = "Blade Lineage Salsu", rarity = 3, image = "blade_lineage.png" }, # ^ Image file name # ^ Rarity (1 to 3) # ^ Sinner name (some are truncated to not go over 2 lines) ... ] ... # Repeat for every sinner ``` The sinners and IDs should be in the order you wish the images to appear as the outputted files have numbers to automatically order them. In the example, I have ordered the sinners by sinner number and IDs by release order, rarity and then preference for tie breakers. The images are placed in relative directories to the config file, not from where you execute the command from. The specific locations are explained at the top, and but you can check out the `/test` directory to see what I have tested with. ### Generating the Images After updating the `cargo.toml`, run the binary with a path to the config file. Input and output directories are inferred based on the folder containing the config. If no location is given, the config will try to target `./config.toml`. Assuming you just compiled the program and haven't installed it: ```bash # Run on `./config.toml` (if it exists) limbus-image # Run on a specific config file limbus-image ./test/config.toml ``` The images will be generated flat in the `./output/id/` directory. They have numbers in the file names to be automatically sorted in sinner and then ID release order when sorted alphabetically. This is helpful for tools like Tier Maker which sort all uploaded images in alphabetical order automatically. The format is as follows: ```text [sinner_number (padded to 2)]_[sinner_name]_[id_number (padded to 2)]_[id_name].png ``` They will look something like this:
