From 8490e03b8fa586e7361bb7c495a7e8cae9c433d5 Mon Sep 17 00:00:00 2001 From: Elvyria Date: Tue, 25 Oct 2022 18:15:34 +0300 Subject: [PATCH] Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 81a473b..24fd7ee 100644 --- a/README.md +++ b/README.md @@ -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 . +```