novus/README.md

# Novus

[![builds.sr.ht status](https://builds.sr.ht/~redstrate/novus.svg)](https://builds.sr.ht/~redstrate/novus?)

A suite of FFXIV modding tools for Linux.

**Note:** This is alpha level software, not intended to be usable in any capacity at the moment. Thus, I have not tagged
any stable releases.

## Components

This repository contains many parts of Novus, such as:

* [Argcracker](argcracker), a program that can decrypt game arguments.
* [Armoury](armoury), a graphical gear and character viewer.
* [Bone Decompiler](bonedecomp), a tool to decompile Havok skeleton files into TexTools-compatible JSON.
* [EXD Viewer](exdviewer), a graphical program to view Excel (EXD) sheets from the game.
* [Explorer](explorer), a graphical interface to explore DAT files.
* [Model Viewer](mdlviewer), a graphical model viewer for MDL files.

## Building

Please refer to the [building document](BUILDING.md) for instructions on how to build Novus.

## Contributing

Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to Novus.

## License

![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)

This project is licensed under the [GNU General Public License 3](LICENSE). Some code or assets may be licensed differently, please refer to the [REUSE](https://reuse.software/spec/) metadata.
Add README 2022-03-15 16:00:36 -04:00			`# Novus`

Add CI status to README 2023-08-31 14:21:53 +02:00			`[![builds.sr.ht status](https://builds.sr.ht/~redstrate/novus.svg)](https://builds.sr.ht/~redstrate/novus?)`

Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`A suite of FFXIV modding tools for Linux.`
Add screenshot to README 2022-04-11 12:15:32 -04:00
Add mdlviewer screenshot in README 2022-04-12 09:56:16 -04:00			`Note: This is alpha level software, not intended to be usable in any capacity at the moment. Thus, I have not tagged`
			`any stable releases.`
Add screenshot to README 2022-04-11 12:15:32 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`## Components`
Add explorer tool This is similar to FFXIVExplorer, where you can view a list of known files in a nice tree view. 2022-04-14 08:24:06 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`This repository contains many parts of Novus, such as:`
Add explorer tool This is similar to FFXIVExplorer, where you can view a list of known files in a nice tree view. 2022-04-14 08:24:06 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`* [Argcracker](argcracker), a program that can decrypt game arguments.`
			`* [Armoury](armoury), a graphical gear and character viewer.`
			`* [Bone Decompiler](bonedecomp), a tool to decompile Havok skeleton files into TexTools-compatible JSON.`
			`* [EXD Viewer](exdviewer), a graphical program to view Excel (EXD) sheets from the game.`
			`* [Explorer](explorer), a graphical interface to explore DAT files.`
			`* [Model Viewer](mdlviewer), a graphical model viewer for MDL files.`
Add explorer tool This is similar to FFXIVExplorer, where you can view a list of known files in a nice tree view. 2022-04-14 08:24:06 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`## Building`
Add argcracker tool 2022-04-14 19:00:42 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`Please refer to the [building document](BUILDING.md) for instructions on how to build Novus.`
Add argcracker tool 2022-04-14 19:00:42 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`## Contributing`
Add argcracker tool 2022-04-14 19:00:42 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to Novus.`
Add argcracker tool 2022-04-14 19:00:42 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`## License`
Add argcracker tool 2022-04-14 19:00:42 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)`
Add argcracker tool 2022-04-14 19:00:42 -04:00
Improve README (and add more), add BUILDING and CONTRIBUTING 2023-08-18 12:18:36 -04:00			`This project is licensed under the [GNU General Public License 3](LICENSE). Some code or assets may be licensed differently, please refer to the [REUSE](https://reuse.software/spec/) metadata.`