Project Setup

A blank package template to create new packages from
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Dependencies
5. Roadmap
6. Contributing
7. Contact
8. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: projectsetup, linkedin_username, email_client, email, project_title, project_description

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Unity Engine setup [2022.3.3f1 <=] and a project to work from

Installation

Package Manager

1. Open the add [+] menu in the Package Manager’s toolbar.
2. The options for adding packages appear.

3. Select Add package from git URL from the add menu. A text box and an Add button appear.
4. Enter a valid Git URL in the text box and click Add. For more information about how to construct a valid Git URL, see Git URLs and extended syntax. Unity supports several Git protocols and some custom or extended syntax.

Taken From Unity Documentation »

Package Registry

1. Edit > Project Settings > Package Manager
2. Add the following to the registry:
   Name: Definitive Infinity Media
   URL: https://npm.pkg.github.com/@Definitive-Infinity-Media
   Scope(s): com.definitiveinfinitymedia
3. GitHub’s registry doesn’t fully support the search functionality of npm yet so you’ll have to modify the package json to add your package by adding (replacing the curly braces again) “com.{package_owner}.{package_name}”: “{version_number}”,
4. Create a .upmconfig.toml file at your user root “%USERPROFILE%.upmconfig.toml”
5. Add the following contents and replace the parts in curly braces with your details:

[npmAuth."https://npm.pkg.github.com/@Definitive-Infinity-Media"]
token = {PAT}
email = {email}
alwaysAuth = true

Taken From Article »

Git

This is the easiest way to clone the repository to make edits within a project.

1. [Project Directory] > Packages

2. Clone the repo

   git clone https://github.com/Definitive-Infinity-Media/com.definitiveinfinitymedia.projectsetup.git
   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Dependencies

Package	Version

Roadmap

• [ ] Feature 1
• [ ] Feature 2
• [ ] Feature 3
  • [ ] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Noah Day - @defin_infinity - email@email_client.com

Project Link: https://github.com/Definitive-Infinity-Media/com.definitiveinfinitymedia.projectsetup

(back to top)

Acknowledgments

• Package CI Setup

(back to top)