Table of Contents

GDF Unity Core

GDF Unity Core is the base package for any GDF feature in unity. It implements a lot of default features for your projects. and is the main focus of this documentation.

Here is the compatibility chart:

Platform Runtime Editor
iOS Supported
Android Supported
Windows Supported Supported (2022.3.46f1 and newer)
Mac OS Supported Supported (2022.3.46f1 and newer)
Linux Supported Supported (2022.3.46f1 and newer)

The Package is stored on a GIT repository accessible for anyone to download. You can install it from the package manager or manually install it in your project.

Note

These steps must be done in a working unity project. Follow this tutorial to create a Unity project.

Package Manager installation

Here are the steps to install the GDF Unity Core package from the Unity Package Manager.

Note

You must choose between the Package Manager and manual installation. Installing the package both ways will result in compilation errors.

  1. Open the package manager
    • From the menu, got to "Window > Package Manager"
  2. Add a git package
    • Click on the + button and "Add package from git URL..."
  3. Enter the GDF Unity Core's repo url
https://github.com/Game-Data-Forge/GDFUnityCore.git
  1. Wait for the package to be installed

You are set to configure GDF for your project !

Manual installation

Here are the steps to install the GDF Unity Core package manually. You can either download the source code OR clone the repo.

Note

You must choose between the Package Manager and manual installation. Installing the package both ways will result in compilation errors.

Download a zip

  1. Go to the GDF Unity Core repository
  2. Download the repo as a .zip file
    • Click on the <> Code button
    • Click on the Download ZIP button
  3. Extract the downloaded zip in the Assets/ folder of your Unity project

You are set to configure GDF for your project !

Clone the repo

You need to have git installed on your computer.

  1. (Optional) Create a Packages/ folder in the Assets/ folder of your Unity project
  2. Clone the repo inside of the Packages/ folder
    • If you skipped this step, you can clone it in any folder inside Assets/
    • From a terminal execute
git clone https://github.com/Game-Data-Forge/GDFUnityCore.git

You are set to configure GDF for your project !