diff --git a/armorpaint/README.md b/armorpaint/README.md index 58156354..f0b155f4 100644 --- a/armorpaint/README.md +++ b/armorpaint/README.md @@ -7,17 +7,17 @@ armorpaint *Note 1: This repository is aimed at developers and may not be stable. Distributed binaries are [paid](https://armorpaint.org/download) to help with the project funding. All of the development is happening here in order to make it accessible to everyone. Thank you for support!* -*Note 2: If you are compiling git version of ArmorPaint, then you need to have a compiler ([Visual Studio](https://visualstudio.microsoft.com/downloads/) - Windows, [clang](https://clang.llvm.org/get_started.html) + [deps](https://github.com/armory3d/armorpaint/wiki/Linux-Dependencies) - Linux, [Xcode](https://developer.apple.com/xcode/resources/) - macOS / iOS, [Android Studio](https://developer.android.com/studio) - Android) and [git](https://git-scm.com/downloads) installed.* +*Note 2: If you are compiling git version of ArmorPaint, then you need to have a compiler ([Visual Studio](https://visualstudio.microsoft.com/downloads/) - Windows, [clang](https://clang.llvm.org/get_started.html) + [deps](https://github.com/armory3d/armortools/wiki/Linux-Dependencies) - Linux, [Xcode](https://developer.apple.com/xcode/resources/) - macOS / iOS, [Android Studio](https://developer.android.com/studio) - Android) and [git](https://git-scm.com/downloads) installed.* ```bash -git clone --recursive https://github.com/armory3d/armorpaint -cd armorpaint +git clone --recursive https://github.com/armory3d/armortools +cd armortools/armorpaint ``` **Windows** ```bash -# Unpack `armorcore\v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB) -armorcore\Kinc\make --from armorcore -g direct3d11 +# Unpack `..\armorcore\v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB) +..\armorcore\Kinc\make --from ..\armorcore -g direct3d11 # Open generated Visual Studio project at `build\ArmorPaint.sln` # Build and run for x64 & release # Copy build\x64\Release\ArmorPaint.exe to build\krom to run ArmorPaint.exe directly @@ -25,24 +25,24 @@ armorcore\Kinc\make --from armorcore -g direct3d11 **Linux** ```bash -armorcore/Kinc/make --from armorcore -g opengl --compiler clang --compile -cd armorcore/Deployment +../armorcore/Kinc/make --from ../armorcore -g opengl --compiler clang --compile +cd ../armorcore/Deployment strip ArmorPaint -./ArmorPaint ../../build/krom +./ArmorPaint ../../armorpaint/build/krom ``` **macOS** ```bash -armorcore/Kinc/make --from armorcore -g metal -cp -a build/krom/ armorcore/Deployment +../armorcore/Kinc/make --from ../armorcore -g metal +cp -a build/krom/ ../armorcore/Deployment # Open generated Xcode project at `build/ArmorPaint.xcodeproj` # Build and run ``` **Android** *wip* ```bash -git apply armorcore/patch/android_document_picker.diff --directory=armorcore/Kinc -armorcore/Kinc/make --from armorcore -g opengl android +git apply ../armorcore/patch/android_document_picker.diff --directory=../armorcore/Kinc +../armorcore/Kinc/make --from ../armorcore -g opengl android cp -r build/krom/* build/ArmorPaint/app/src/main/assets/ # Manual tweaking is required for now: # https://github.com/armory3d/armorcore/blob/master/kfile.js#L136 @@ -53,9 +53,9 @@ cp -r build/krom/* build/ArmorPaint/app/src/main/assets/ **iOS** *wip* ```bash git clone https://github.com/armory3d/armorpaint_plugins Libraries/plugins -git apply armorcore/patch/ios_document_picker.diff --directory=armorcore/Kinc -armorcore/Kinc/make --from armorcore -g metal ios -cp -a build/krom/ armorcore/Deployment +git apply ../armorcore/patch/ios_document_picker.diff --directory=../armorcore/Kinc +../armorcore/Kinc/make --from ../armorcore -g metal ios +cp -a build/krom/ ../armorcore/Deployment # Open generated Xcode project `build/ArmorPaint.xcodeproj` # Set iOS Deployment Target to 14.0 # Build for device in release mode @@ -63,9 +63,9 @@ cp -a build/krom/ armorcore/Deployment **Windows DXR** *wip* ```bash -# Unpack `armorcore\v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB) -git apply armorcore/patch/d3d12_raytrace.diff --directory=armorcore/Kinc -armorcore\Kinc\make --from armorcore -g direct3d12 +# Unpack `..\armorcore\v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB) +git apply ../armorcore/patch/d3d12_raytrace.diff --directory=../armorcore/Kinc +..\armorcore\Kinc\make --from ..\armorcore -g direct3d12 # Open generated Visual Studio project at `build\ArmorPaint.sln` # Build and run for x64 & release # Copy build\x64\Release\ArmorPaint.exe to build\krom to run ArmorPaint.exe directly @@ -74,43 +74,18 @@ armorcore\Kinc\make --from armorcore -g direct3d12 **Linux VKRT** *wip* ```bash git clone --recursive https://github.com/armory3d/glsl_to_spirv armorcore/Libraries/glsl_to_spirv -git apply armorcore/patch/vulkan_raytrace.diff --directory=armorcore/Kinc -armorcore/Kinc/make --from armorcore -g vulkan --compiler clang --compile -cd armorcore/Deployment +git apply ../armorcore/patch/vulkan_raytrace.diff --directory=../armorcore/Kinc +../armorcore/Kinc/make --from ../armorcore -g vulkan --compiler clang --compile +cd ../armorcore/Deployment strip ArmorPaint -./ArmorPaint ../../build/krom +./ArmorPaint ../../armorpaint/build/krom ``` **Windows VR** *wip* ```bash -# Unpack `armorcore\v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB) -armorcore\Kinc\make --from armorcore -g direct3d11 --vr oculus +# Unpack `..\armorcore\v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB) +..\armorcore\Kinc\make --from ..\armorcore -g direct3d11 --vr oculus # Open generated Visual Studio project at `build\ArmorPaint.sln` # Build and run for x64 & release # Copy build\x64\Release\ArmorPaint.exe to build\krom to run ArmorPaint.exe directly ``` - -**Updating cloned repository** -```bash -git pull origin main -git submodule update --init --recursive -# Delete `armorpaint/build` directory if present -``` - -**Generating a locale file** -```bash -pip install typing_extensions -t Assets/locale/tools -python ./Assets/locale/tools/extract_locales.py -# Generates an `Assets/locale/.json` file -``` - -**Release builds** *Optional, used for best performance* -```bash -# Compile krom.js using the closure compiler -https://developers.google.com/closure/compiler -# Generate a v8 snapshot file -export ARM_SNAPSHOT=1 -armorcore/Kinc/make --from armorcore -g api -./ArmorPaint . --snapshot -# Generates a `krom.bin` file from `krom.js` file -```