Skip to content

201841: The documentation is moved to dev docs #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pelin-d wants to merge 3 commits into
base: main
Choose a base branch
from
Open

201841: The documentation is moved to dev docs #17

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b0c3f3
Removed integration from readme, added link instead
pelin-d Oct 31, 2024
b3ba557
removed redundant info in readme
pelin-d Nov 1, 2024
bdd5cd2
added links to new docs
pelin-d Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 4 additions & 58 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,14 @@
# Optimove-SDK-Unity
![GitHub](https://img.shields.io/github/license/optimove-tech/Optimove-SDK-Unity?style=flat-square)

# Unity Version And Platform Support
## Unity Version And Platform Support

Optimove Unity SDK supports Unity >= 2019.3. Supported platforms are iOS and Android.

# Integration Guide
## Integration Guide

In this guide we will discuss the steps to integrate the Optimove Unity SDK with your application.

### Setup

1. [Initializing the SDK](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/Initializing-the-sdk)
2. [Tracking customers](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/Tracking-customers)
3. [Tracking events](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/Tracking-events)

### Mobile Messaging

1. [Push Setup](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/push-setup)
2. [In-App Setup](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/in-app)
3. [Deferred Deep Linking](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/deferred-deep-linking)
4. [Testing](https://github.com/optimove-tech/Optimove-SDK-Unity/wiki/testing-troubleshooting)

> **NOTE**:
To unlock these capabilities, you will need to have added the relevant OptiMobile channels to your Optimove package. If you can’t see this feature in your Optimove instance, contact your CSM to find out more.

### Integration summaries

This is a quick start integration guide. For detailed integration instructions refer to the above.

#### ================= Android =================

1. create a new project
2. switch platform: Android
3. set package id (Player Settings -> Other Settings)
4. import OptimoveSDKUnity package
5. add OptimoveInit to MainCamera
6. in Player Settings verify (it should be set automatically):
- custom gradle main template set to `Plugins/Android/mainTemplate.gradle`,
- custom gradle launcher template set to `Plugins/Android/launcherTemplate.gradle`
- custom gradle base template set to `Plugins/Android/baseProjectTemplate.gradle`
- custom main manifest set to `Plugins/Android/AndroidManifest.xml`.
- for 2020.3+ make sure custom gradle properties template set to `Plugins/Android/gradleTemplate.properties`
7. If using push/ddl uncomment relevant lines in gradle templates and `AndroidManifest.xml`
8. Create `Assets/OptimoveConfigFiles/optimove.json`, set credentials
9. If using push push add `google-services.json` to `Assets/OptimoveConfigFiles/google-services.json`
10. (Optional) Export project


#### ================= iOS =================

1. create a new project
2. switch platform to ios
3. set bundle id (Player Settings -> Other Settings)
4. import OptimoveSDKUnity package
5. add OptimoveInit to MainCamera
6. Create `Assets/OptimoveConfigFiles/optimove.json`, set credentials
7. Move `Artifacts/OptimoveNativeAssets~` to `Assets` folder
8. build project. Depending on values in `optimove.json` this automatically adds capabilities, NotificationServiceExtension and sets up Xcode project.

##### In Xcode project

9. signing (if was not set in Unity Player Settings)
10. Switch to New Build System in File -> Project Settings -> Build System (likely already on). This is necessary to use xcframeworks.
[Getting Started on Mobile](https://developer.optimove.com/docs/getting-started-on-mobile)
[SDK Reference](https://developer.optimove.com/docs/sdk-reference-1)

# License

Expand Down