Peek
>
Manual
>

Version Control

Updated: 2019-08-08

Peek should be excluded from your project's version control system like Collaborate, Git, Perforce or Plastic. This minimizes the size of your repository and keeps things cleaner.

If you're using a public repository for your project, you must exclude Peek files with the instructions below. If you don't, you are effectively illegally redistributing Peek online and breaking the Unity Asset Store EULA and ToS.

Peek requires one license per seat. Each developer on a project with Peek must have a license. If you do not want to purchase licenses for every developer, you must exclude Peek files with the instructions below. If you don't, you are illegally breaking the Unity Asset Store EULA and ToS.

Ignoring files

To exclude files from your version control solution, the standard approach is to include a file that specifies which files and folder to exclude.

You should place this file at the root of the project folder, above the Assets folder.

  • If you are using Git, name this file .gitignore
  • If you are using Unity Collab, name this file .collabignore
  • If you are using Subversion, you will need to ignore the files manually

On Windows, creating files without a filename is forbidden in explorer. Follow these instructions to create the file.


Ignore directives

This template will ignore all Peek files while preserving your project settings. You can add these lines anywhere to your ignore file.

## Peek
Assets/Ludiq/Ludiq.PeekCore
Assets/Ludiq/Ludiq.Peek
Assets/Ludiq.Generated/Transient

We also recommend you include the standard Unity ignore directives.


Removing ignored files retroactively

If you previously committed files that should be excluded, you can use the following Git commands to create a commit that removes them:

git rm -r --cached . 
git add .
git commit -am "Remove ignored files"

If you had pushed these files to a public repository, this will not erase them from the commit history. Therefore, you would still be illegally redistributing the Peek files. Either make your repository private or start a new repository with a fresh tree that never included the Peek files.

Was this article helpful?
This article was helpful for 1 person.
Yes, helpful
No, not for me