Skip to content

HelloPackage_TipsAndTricks

Éloi Strée edited this page Jun 2, 2020 · 4 revisions

Branch tag and commit target

In your manifest.json You can use the #Value to define that you want to use a package at a specific point of the git project state. Example: Access the In Development branch:

  • "be.eloistree.quickgitutility","https://github.com/EloiStree/2019_07_21_QuickGitUtility.git#InDevelopment" Access the project at specific a commit:
  • "be.eloistree.quickgitutility","https://github.com/EloiStree/2019_07_21_QuickGitUtility.git#3bb0f671489ac1b8b33da1886ecaadfc41cf1fce"

Use a sub-modules for Documentation

If you want the user to have some documentations in your project. But you want to edit this documentation outside of the project. You can use sub-modules.

Sub... what 🤢?
It is the use of git in a git...🤗

⚠Don't use it if you don't learn sub-modules before or if you Git skills is too basic⚠

  1. Go in your package
  2. Open in explorer
  3. Window + R > Type cmd > cd "yourrootpackagepath"
  4. git submodule add yourWikiGitUrl.git Documentations~
  5. Ta da 📚 🤘

Small difference with your habits. When you clone your package to update it.
Now you need to use the following command:
git clone --recurse-submodules -j8 yourPackageUrl.git to clone with the submodules or git submodule update --init --recursive to update not cloned submodules

FAQ and Bugs

  • Package.json Namespace don't allow upper case and numbers in 2018.
  • Don't use the "SampleScene" as based of your package to avoid having same asset meta as other in the project.

Clone this wiki locally