Skip to content

Commit f45a1d5

Browse files
committed
update readme
1 parent 040eeef commit f45a1d5

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
1-
# tarkov-image-generator
1+
# tarkov-image-generator ⚙️
2+
23
Originally written by kokarn, the tarkov image generator generates icons and grid-size images from the tarkov icon cache folder. This fork was made after kokarn made the decision to shutdown Tarkov Tools.
4+
5+
## Usage 🔨
6+
7+
To use this utility, you need to have `node` installed. You can then do the following steps:
8+
9+
1. Clone this repo
10+
2. Install dependencies - `npm install`
11+
3. Run the script - `npm start`
12+
13+
The results will be placed in two folders:
14+
15+
- `generated-images/`
16+
- `generated-images-missing/`
17+
18+
The results will contain `base-image`, `grid-image`, and `icon` files

0 commit comments

Comments
 (0)