diff --git a/armorlab/README.md b/armorlab/README.md index 71f340c3..c9a57ee8 100644 --- a/armorlab/README.md +++ b/armorlab/README.md @@ -7,18 +7,18 @@ armorlab *Note 1: This repository is aimed at developers and may not be stable. Distributed binaries are [paid](https://armorlab.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 ArmorLab, 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 ArmorLab, 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/armorlab -cd armorlab +git clone --recursive https://github.com/armory3d/armortools +cd armortools/armorlab # Unpack `models.zip` from https://github.com/armory3d/armorai/releases into `Assets/models` using 7-Zip - Extract Here ``` **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\ArmorLab.sln` # Build and run for x64 & release # Copy build\x64\Release\ArmorLab.exe to build\krom to run ArmorLab.exe directly @@ -26,16 +26,16 @@ armorcore\Kinc\make --from armorcore -g direct3d11 **Linux** *wip - cpu only* ```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 ArmorLab -./ArmorLab ../../build/krom +./ArmorLab ../../armorlab/build/krom ``` **macOS** *wip - apple silicon only* ```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/ArmorLab.xcodeproj` # Build and run ``` @@ -47,42 +47,3 @@ cp -a build/krom/ armorcore/Deployment **iOS** *wip* ```bash ``` - -**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 -# Open generated Visual Studio project at `build\ArmorLab.sln` -# Build and run for x64 & release -# Copy build\x64\Release\ArmorLab.exe to build\krom to run ArmorLab.exe directly -``` - -**Linux VKRT** *wip* -```bash -``` - -**Updating cloned repository** -```bash -git pull origin main -git submodule update --init --recursive -# Delete `armorlab/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 -./ArmorLab . --snapshot -# Generates a `krom.bin` file from `krom.js` file -```