doc: update doc
This commit is contained in:
@@ -1,5 +1,35 @@
|
||||
# How to contribute to LibCmo21
|
||||
|
||||
## Contributor Limit
|
||||
## Contributor Limitation
|
||||
|
||||
This project does not allow contributions coming from employees who are or have been employees of Dassault.
|
||||
|
||||
## Feature Limitation
|
||||
|
||||
For the content of contribution, 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
|
||||
|
||||
These features will be accepted as soon as possible.
|
||||
|
||||
* The bug fix of any existing code.
|
||||
|
||||
### Not Urgent Features
|
||||
|
||||
These features are in plan, but not urge to merge.
|
||||
|
||||
* The `CK_ID` remap system of Reader.
|
||||
* CK3dEntity hierarchy system.
|
||||
* Other CK classes implementations.
|
||||
* Non-Virtools 2.1 implementations.
|
||||
|
||||
### Don't Care Features
|
||||
|
||||
These features explicitly will not be merged.
|
||||
|
||||
* Run Virtools file.
|
||||
* Plugin system.
|
||||
|
||||
@@ -2,6 +2,15 @@
|
||||
|
||||
This article tells the details of this project for the developer of this project.
|
||||
|
||||
## Version
|
||||
|
||||
When bumping a new version, you should update the version number in following files:
|
||||
|
||||
* `CMakeLists.txt`: It control the version of `LibCmo`, `Unvirt`, `BMap` and `BMapInspector`. All of these projects share the same version.
|
||||
* `Assets/BMapBindings/pybmap/pyproject.toml`: The version of `BMap` Python binding. It should have the same version with `BMap` but not compelled.
|
||||
* `Assets/BMapBindings/BMapSharp/BMapSharp/BMapSharp.csproj`: The version of `BMap` C# binding. Same as above.
|
||||
* TODO
|
||||
|
||||
## Java
|
||||
|
||||
### Java
|
||||
|
||||
34
README.md
34
README.md
@@ -22,7 +22,7 @@ This project will not link any original Virtools dynamic library. So this projec
|
||||
|
||||
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.
|
||||
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 inspire my work.
|
||||
|
||||
**The difference between this project and other Virtools libraries (e.g. [doyaGu/Ballanced](https://github.com/doyaGu/Ballanced)), 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.**
|
||||
|
||||
@@ -35,7 +35,7 @@ The ultimate goals of this project are:
|
||||
- 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.
|
||||
|
||||
These goals are now all achieved.
|
||||
These goals now are all achieved.
|
||||
|
||||
## Project Layout
|
||||
|
||||
@@ -43,37 +43,11 @@ These goals are now all achieved.
|
||||
* Unvirt: Interactive Virtools file viewer. Can provide more detail than Luigi Auriemma's unvirt.
|
||||
* Ballance: Ballance related stuffs which utilize LibCmo.
|
||||
- BMap: A dynamic library which is specific for Ballance Map loading and saving.
|
||||
- BMapInspector: A inspector for checking Ballance Map.
|
||||
- BMapInspector: An inspector for checking Ballance Map.
|
||||
|
||||
## Contributions
|
||||
|
||||
However, not all contribution will be accepted.
|
||||
|
||||
For the limitation of contributor, please see [Contribution Guideline](./CONTRIBUTING.md).
|
||||
|
||||
For the content of contribution, 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
|
||||
|
||||
These features will be accepted as soon as possible.
|
||||
|
||||
* The bug fix of any existing code.
|
||||
|
||||
### Not Urgent Features
|
||||
|
||||
These features are in plan, but not urge to merge.
|
||||
|
||||
* The `CK_ID` remap system of Reader.
|
||||
* CK3dEntity hierarchy system.
|
||||
* Other CK classes implementations.
|
||||
* Non-Virtools 2.1 implementations.
|
||||
|
||||
### Don't Care Features
|
||||
|
||||
These features explicitly will not be merged.
|
||||
|
||||
* Run Virtools file.
|
||||
* Plugin system.
|
||||
See [Contribution Guideline](./CONTRIBUTING.md)
|
||||
|
||||
## Compile
|
||||
|
||||
|
||||
Reference in New Issue
Block a user