diff --git a/.gitmodules b/.gitmodules index c070acb0..e595964f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,7 @@ [submodule "external/glm"] path = external/glm url = https://github.com/g-truc/glm +[submodule "assets"] + path = assets + url = https://github.com/SaschaWillems/Vulkan-Assets + branch = main diff --git a/README.md b/README.md index fbd0449e..3620efe1 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ You can find this repository at https://github.com/KhronosGroup/Vulkan-Samples As I've been involved with getting the official repository up and running, I'll be mostly contributing to that repository from now, but may still add samples that don't fit there in here and I'll of course continue to maintain these samples. ## Cloning -This repository contains submodules for external dependencies, so when doing a fresh clone you need to clone recursively: +This repository contains submodules for external dependencies and assets, so when doing a fresh clone you need to clone recursively: ``` git clone --recursive https://github.com/SaschaWillems/Vulkan.git @@ -53,11 +53,8 @@ git submodule update ``` ## Assets -Many examples require assets from the asset pack that is not part of this repository due to file size. A python script is included to download the asset pack that. Run - python download_assets.py - -from the root of the repository after cloning or see [this](data/README.md) for manual download. +**Important notice:** As of may 2023 assets have been moved to a [submodule](https://github.com/SaschaWillems/Vulkan-Assets). If you have cloned the repository before this date, you may need to initialize and update submodules. If you do a fresh clone, no action is required to get the assets. ## Building diff --git a/assets b/assets new file mode 160000 index 00000000..cef63c5c --- /dev/null +++ b/assets @@ -0,0 +1 @@ +Subproject commit cef63c5c44cd0ad53e778ccdb150ff3b650183ab diff --git a/data/README.md b/data/README.md deleted file mode 100644 index 1566ad0a..00000000 --- a/data/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Getting the assets - -Binary assets (models, textures, etc.) are not stored in this repository and need to be downloaded manually. - -## Downloading the assets - -### Option 1: Run the python script - -Run the [download_assets.py](../download_assets.py) python script which will download the asset pack and unpacks it into the appropriate folder. - -### Option 2: Manual download - -Download the asset pack from [https://vulkan.gpuinfo.org/downloads/vulkan_asset_pack_gltf.zip](https://vulkan.gpuinfo.org/downloads/vulkan_asset_pack_gltf.zip) and extract it in the ```data``` directory.