Skip to content

Commit a8cd39a

Browse files
committed
update readme
1 parent 5b63911 commit a8cd39a

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
modkit
1+
![Diggers Modkit](docs/logo.png)
2+
3+
# Diggers Modkit
4+
5+
## Installation
6+
7+
* Install NodeJS >= 8.5.0
8+
* Clone or download the repository
9+
* `cd diggers-modkit`
10+
* `npm i`
11+
12+
## Usage
13+
14+
### Unpack
15+
16+
To unpack the existing mod (or unpack the vanilla game files), simply run:
17+
18+
`node mod --unpack <path-to-game-dir>`
19+
20+
### Pack
21+
22+
To package the modified files, run:
23+
24+
`node mod --pack <path-to-game-dir>`

docs/logo.png

16 KB
Loading

0 commit comments

Comments
 (0)