From 305c0b1b65355fc17f864e0e918856715f88cc36 Mon Sep 17 00:00:00 2001 From: yyc12345 Date: Fri, 8 Nov 2024 15:17:45 +0800 Subject: [PATCH] doc: fix README --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f2a5c32..e43a5c3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # libcmo21 -The Library for CMO (also accept NMO, VMO and NMS) File Read/Write. Also the Minimalist Virtools Environment. -Write with one Library and Load Virtools File Everywhere. +The Library for CMO (also accept NMO, VMO and NMS) File RW (Read and Write). Also the Minimalist Virtools Environment. +Write with one Library and Load/Save Virtools File Everywhere. ## Status @@ -10,12 +10,15 @@ This project welcome everyone's contribution, except the employee of Dassault, w ## Introduction -The aim of this project is creating a universal library which can read / write CMO files or any other Virtools files without any Virtools dependencies. -This project will not link any original Virtools dynamic library. So this project can be ported to any platform if the compiler supports. -This project only involving specific Virtools version, 2.1. Other Virtools versions are not considered by this project. -This project is based on reverse work of `CK2.dll`, `VxMath.dll` and `CK2_3D.dll`. The program [unvirt](https://aluigi.altervista.org/papers.htm#unvirt) created by Luigi Auriemma, which is licensed by GPL-v2, also help my work. +The aim of this project is creating a universal library which can RW CMO files or any other Virtools files without any Virtools dependencies. -**The difference between this project and other Virtools libraries (e.g. [doyaGu/CK2](https://github.com/doyaGu/CK2)), is that we are not focusing on re-creating the whole Virtools engine. We only focus on the Virtools files RW, and we only just implement a minimalist Virtools environment for achieving this.** +This project will not link any original Virtools dynamic library. So this project can be ported to any platform if the compiler and runtime libraries support. + +This project only involving specific Virtools version, 2.1. Other too higher Virtools versions are not considered by this project. + +This project is barely based on the reverse work of doyaGu who decompile `CK2.dll`, `VxMath.dll` and `CK2_3D.dll`. The program [unvirt](https://aluigi.altervista.org/papers.htm#unvirt) created by Luigi Auriemma, which is licensed by GPL-v2, also help my work. + +**The difference between this project and other Virtools libraries (e.g. [doyaGu/CK2](https://github.com/doyaGu/CK2)), is that this project is not focusing on re-creating the whole Virtools engine. This project only focus on the Virtools files RW, and it only just implement a minimalist Virtools environment for achieving this.** ## Goals @@ -23,22 +26,20 @@ The ultimate goals of this project are: * Create a library which can read Virtools file and do not limited on x86 platform by original Virtools implement. * Create a universal dynamic library for Ballance Map file loading. - * Create a Python binding for the loader. And allow user can export Ballance Map from Blender on Linux platform natively. - * Create a C# binding for the loader to enable that I can load Ballance Map in Godot on Linux / Android platform natively. + - Create a Python binding for the loader. And allow user can export Ballance Map from Blender on Linux platform natively. + - Create a C# binding for the loader to enable that I can load Ballance Map in Godot on Linux / Android platform natively. There is still a long way to go. But I will try my best. ## Project Layout * LibCmo: Core library. It is a static library. Link to your program freely because I don't want to process export table things. -* IronPad: A tiny Crashpad like static library. Used by Unvirt and BMap. Report crash log and coredump only on Windows (Because I assume all Linux users have capacity to enable coredump and deliver it to developer.). * Unvirt: Interactive Virtools file viewer. Can provide more detail than Luigi Auriemma's unvirt but only can accept version limited Virtools file (< 4.0 I guess). * BMap: A dynamic library which is specific for Ballance Map loading by using LibCmo. ## Contributions -However, not all contribution will be accepted. Just like I said, we create **Minimalist** Virtools Environment. The basic RW functions is enough. We do not accept complex function implementations. -There are 3 lists which indicate our accept guideline. +However, not all contribution will be accepted. Just like I said, we create **Minimalist** Virtools Environment. The basic RW functions is enough. We do not accept complex function implementations. There are 3 lists which indicate our accept guideline. ### Wanted Features