diff --git a/README.md b/README.md index 7e4c69d8..89aaaa83 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ This repository is used to host assets used in Cyan World's Myst Online: Uru Liv * [dirtsand](https://github.com/H-uru/dirtsand) - An open-source Plasma-compatible server project. * [korman](https://github.com/H-uru/korman) - Blender plugin for creating ages for Cyan Worlds' Plasma engine. +## Browsing MOUL Assets +You may notice while browsing this repository online or after cloning on your own machine that most files seem to be small text files containing some kind of hash reference. This is because the MOUL assets repository is too large for (free) GitHub. We therefore use an external Git Large File Storage server. The easiest way to download the entire repository is to use `git lfs clone`. Do keep in mind that the repository is very large (over 20GB), so make sure to run this command in a location with sufficient space. You can of course also enable Git LFS be default. You can find some basic information on the [Git LFS website](https://git-lfs.com/) or refer to the [Git LFS wiki page on pulling and cloning](https://github.com/git-lfs/git-lfs/wiki/Tutorial#pulling-and-cloning). + ## Contributing This repository is intended to track large binary files where diffs are impractical. All binary objects are stored on the Guild of Writers server to avoid incurring additional fees from GitHub. To prevent abuse/spam, the ability to push binary objects is restricted to approved users, even in your own fork. If you would like to contribute to this repository, you can request access [here](https://guildofwriters.org/assets_repo).