EML Plugins

This repository contains plugins developed by UBC Emerging Media Lab and instructions on how to install them.

All projects developed at the EML are required to use the core plugins if the platform allows it. The plugins will be developed continually and maintained. All features and how to use them will be listed in the separate 'Features' sections.

Feature requests and other suggestions are welcome. Contact us at emergingmedia.lab@ubc.ca.

Table of contents

• 1.0 EML Plugins
• 2.0 Unity Core Plugin
  • 2.1 Installation
  • 2.2 Features
    • 2.2.1 Generate EML Project Structure
    • 2.2.2 EML Coding Standards
    • 2.2.2 Contact Information
• 3.0 Unreal Core Plugin
  • 3.1 Installation
  • 3.2 Features
    • 3.2.1 Generate EML Project Structure
    • 3.2.2 EML Coding Standards
    • 3.2.2 Contact Information
• 4.0 Builds

2.0 Unity Core Plugin

2.1 Installation

1. Download the Unity Package from the Builds folder or clone this repository and open the Unity project in Unity 2021.3.22f1 or newer to create a Unity bundle manually.

2. Create a new project or load an existing one. Right click 'Assets' and click 'Import Package' -> 'Custom Package...'.

   

3. Navigate to the Unity Bundle and click 'Open'.

4. A new window 'Import Unity Package' will open. Select everything and click 'Import'.

   

5. If installation was successful, you should see the 'EML' folder in your 'Assets' folder.

   

   You should also see the 'EML' tab in the main menu.

   

2.2 Features

This section lists all EML Unity features and how to utilize them.

2.2.1 Generating EML Project Structure

The EML Unity Core plugin can generate the folder structure required by the EML Coding Styleguide.

To generate the EML Project structure:

1. Click on the 'EML' tab in the main menu.

2. Click on the 'Generate EML Project Structure' option.

   

If successful, you should see an 'EML' folder and all its subfolders in your 'Assets' folder.

![image](https://github.com/ubcemergingmedialab/23-3000-EML_Plugins/assets/130086654/67a8cce0-cc3c-4e66-8d22-2c91b73bac69)

2.2.2 EML Coding Styleguide

The EML Unity Core plugin contains a direct link to the EML coding styleguide.

To visit the EML Coding Styleguide:

1. Click on the 'EML' tab in the main menu.

2. Click on the 'EML Coding Styleguide' option.

   

If successful, your browser will open and take you to the EML coding styleguide.

2.2.3 Contact Information

The EML Unity Core plugin contains a direct link to the EML website, where you can contact us directly.

To visit the EML website:

1. Click on the 'EML' tab in the main menu.

2. Click on the 'Contact Information' option.

   

If successful, your browser will open and take you to the EML website.

Unreal Core Plugin

Installation

1. Download the Unreal Engine plugin from the Builds folder or clone this repository and open the Unreal Engine project in Unreal Engine 5.1 or newer to package the plugin manually.

2. Create a new Unreal Engine project. If you already have a project, you can skip this step.

3. Navigate to the project folder outside of Unreal Engine. This is where your .uproject file is located.

   

4. Open the 'Plugins' folder located in the project folder. If there is no 'Plugins' folder, create it.

5. Place the EML_Core_Unreal folder in the Plugins folder.

   

6. Restart the Unreal Engine Editor and open the project again.

7. In Unreal Engine, Click on Edit -> Plugins.

   

8. If installation was successful, you should be able to find the EML_Core_Unreal plugin in the plugins list.

   

   You should also be able to see the EML tab in the main menu.

   

3.2 Features

This section lists all EML Unreal Engine features and how to utilize them.

3.2.1 Generate EML Project Structure

The EML Unreal Engine Core plugin can generate the folder structure required by the EML Coding Styleguide.

To generate the EML Project structure:

1. Make sure you have saved your work before proceeding. Generating the project structure will require an Unreal Engine restart.

2. Click on the 'EML' tab in the main menu.

3. Click on the 'Generate EML Project Structure' option.

   

You will be asked to confirm. Make sure any unsaved work is saved before continuing.

![image](https://github.com/ubcemergingmedialab/23-3000-EML_Plugins/assets/130086654/7a3b8e76-6f81-483f-b395-b73c7932d16c)

Clicking 'Yes' will generate the project structure and restart Unreal Engine.

If successful, you should see an 'EML' folder and all its subfolders in your 'Content' folder.

![image](https://github.com/ubcemergingmedialab/23-3000-EML_Plugins/assets/130086654/be874641-3c3a-471e-af53-4ed9b46c702e)

3.2.2 EML Coding Styleguide

The EML Unreal Engine Core plugin contains a direct link to the EML coding styleguide.

To visit the EML Coding Styleguide:

1. Click on the 'EML' tab in the main menu.

2. Click on the 'EML Coding Styleguide' option.

   

If successful, your browser will open and take you to the EML coding styleguide.

3.2.3 Contact Information

The EML Unreal Engine Core plugin contains a direct link to the EML website, where you can contact us directly.

To visit the EML website:

1. Click on the 'EML' tab in the main menu.

2. Click on the 'Contact Information' option.

   

If successful, your browser will open and take you to the EML website.

Builds

Updated builds can be found in the Builds folder in this repository. You can also clone this repository and build the plugins manually.