Skip to content

tungcheng/FastSetup

Repository files navigation

Fast Setup

Unity Version License

Fast Setup for your Unity Project Folders and Packages.

Features

  • 🚀 Create new folders inside your project Assets following your preferred structure
  • 🛠️ Quickly add multiple packages at once
  • ✍️ Overwrite your template packages manifest.json
  • 🌭 Add ScriptTemplates folder to have more choices when creating new script files

Designed to Share

  • 📱 Share your folder structure in an easy-to-read format
  • 🍕 Share your favorite must-have packages with anyone
  • 📩 Share your template packages manifest.json customized by game genre
  • 🎁 Share your script templates tailored for many file types

FastSetup Add Package Example File

# openupm is added by default
# npm is added by default
# add new with format below
# registry <registryName> <url>

# add package from git repo
# git <url>
git https://github.com/dbrizov/NaughtyAttributes.git#upm
git https://github.com/mfragger/TagsAndLayersGenerator.git
git https://github.com/AnnulusGames/uPools.git?path=/Assets/uPools
git https://github.com/UnityCommunity/UnitySingleton.git

# add package from OpenUPM
openupm add jp.hadashikick.vcontainer
openupm add com.cysharp.unitask

# add package from NPM
npm i com.kyrylokuzyk.primetween

FastSetup Folder Structure Example File

__MyGame
  - Art
    - Animation
    - Material
    - Sprite
  - Audio
    - Music
    - Sound
  - Code
    - Editor
    - Runtime
      - _Common
      - Gameplay
      - UI
    - Shader
  - Design
    - Config
    - Prefab
    - Scene

Installation

Via Package Manager

  1. Open Unity Package Manager (Window → Package Manager)
  2. Click the + button in the top-left corner
  3. Select Add package from git URL...
  4. Enter the following URL:
    https://github.com/tungcheng/FastSetup.git
    

Manual Installation

  1. Download the latest release from Releases
  2. Extract the package to your project's Packages folder
  3. Unity will automatically import the package

(You can customize sample files and copy-paste them when setting up a new project)

Quick Start

Sample

  • Please check my template setup in the "Sample" folder. There are some good resources based on my experience.
  • You can also create your own files from these templates.

Create Folders with Predefined Structure

  1. Right-click on your folder structure .txt file
  2. Select FastSetup/Create Folder Structure from file
  3. Wait for the success dialog

Import Packages

  1. Right-click on your packages list .txt file
  2. Select FastSetup/Import Packages from file
  3. Wait for the success dialog

Overwrite Packages

  1. Right-click on your custom packages .json file
  2. Select FastSetup/Overwrite Packages manifest file
  3. Confirm that your existing packages setup will be overwritten
  4. The packages manifest file will be overwritten

Add Script Templates

  1. Right-click on your custom script templates folder (or FastSetup/ScriptTemplates)
  2. Select FastSetup/Copy script templates folder
  3. Copy script templates folder
  4. Your Unity will close. Reopen your project and you will find new options in the Create menu.

Thanks to annulusgames for the script templates folder.

About

Fast Setup your Unity Project Folders and Packages

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages