alexrazor1337 / mta-resource-tool Goto Github PK

Update documentation, add more examples.

3 base settings for start:

• 1. Obfuscation level.
• 2. Silent mode Error levels.
• 3. List of skipped file types when copying.

About implementation:
Preferred way of storing and loading is JSON.
When starting a script for the first time it creates settings file with default value. At the next starts this file would be checked and loaded.

0. Encode model files by any tool(TODO)
1. Analyze count of model files in directory(perhaps they are encoded or you don't need encoding)

• If there are too few free ID's(you can add them in config), the script will give error and stop

2. Generate client file with load/replace model/col/txd

• ID's can be assigned randomly and then this will be saved to "assignment model" which will be JSON file with fields like: "file_name: model_id" e.g ("building: 13232")
• ID's can be assigned from the existing assignment model (so it won't break existing work) and if there are new game files, the model will be updated
• There are should be linking rules for some situations. By default, "file_name" will be loaded as dff+txd as a skin, dff+txd as a vehicle, dff+txd+col as a world object, probably differentiated by folder name. But sometimes few world models are having the same txd file. For simplicity, they should have the same substring in their name, so for e.g: World1.dff and World2.dff are using World.txd, so there are must be linking rule like World.txd: "World"

3. Use metagen script to generate meta for the resource
4. Use compiling script to compile client file

When generating meta for resource it automatically adds

<file src="meta-generated.xml"/>

Add documentation about how to use this script.

Steps to reproduce:

1. move meta.py into the any resource folder
2. run python meta.py .
3. Read meta-generated.xml and it won't produce any <script src"..." /> output

Make option to override meta file with generated one #6 . It's should ask the user every time if it's enabled for safety reasons.

Some resources need "oop" in their meta(#4), ACL rights(ACL request) and it can be useful for versioning, saving description and etc.
The idea is to have a file something like "resource.json" in resource folder which will contain this settings, example:

{
  "oop": true,
  "rights": {
    "general.ModifyOtherObjects": true, 
    "function.startResource": true,
  }
}

Tool to generate meta.xml
It should parse all files inside a specified folder and add them to meta.xml unless they had restricted file type (should be specified in settings from #1 ).

There are must be a set(sets?) of rules how to determine is it clientside file or serverside.
Variants:

• File prefix(e.g c_client.lua)
• Directory name(e.g \Server\core.lua)
• Looking for clientside/serverside function only(e.g dxDrawText is clientside function only, so file is clientside) (questionable)

In any way, a case may arise when it is not possible to set the type. (no prefix, no directory, all functions are shared). So ability to set it manually is required.

Automatically add exported functions to generated meta.xml (#4)

To declare that function is exported it should be stated in function header:

function foo() --exported
end