Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Elvyria authored Oct 25, 2022
1 parent 5b792e0 commit 8490e03
Showing 1 changed file with 40 additions and 8 deletions.
48 changes: 40 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,43 @@
# NifHacks
![License](https://img.shields.io/github/license/Elvyria/nifhacks?color=green)

## Features:
* Export Nif shapes to Obj
* Transfer vertex/normal/texture coordinates from Obj to Nif

## Build Dependencies:
#### VCPKG:
* boost-algorithm
* tinyobjloader
* fmt
* Export **nif** shapes to ***obj**
* Transfer *vertex/normal/texture* coordinates from **obj** to **nif**

## Usage
```
$ nifhacks --help
Janky tool that (sometimes) get things done for your nif-needs
Usage: build/bin/nifhacks [OPTIONS] INPUT OUTPUT
Positionals:
INPUT *.nif *.obj
OUTPUT *.obj *.nif
Options:
-h,--help Print this help message and exit
-s,--skin Apply skin transforms to shape
```

To export skinned shape (highpoly head)
```bash
$ nifhacks -s head.nif head.obj
```

To import changes back to **nif**. (Your **.nif** file will not be overwritten by default, expect changes in **.nif.nif** file)
```
$ nifhacks -s eyes.obj head.nif
```

## Building
Aside from c++ build tools you'll need [CMake](https://cmake.org) and [Conan](https://conan.io)
```bash
$ git clone --depth 1 https://github.com/Elvyria/nifhacks
$ cd nifhacks
$ mkdir build && cd build
$ conan install .. -s build_type=Release --build=missing
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ cmake --build .
```

0 comments on commit 8490e03

Please sign in to comment.