Skip to main content
Version: 1.0

Integrating the Gamemodstudios SDK into Unity

Introduction

The Gamemodstudios SDK enables seamless integration of your game with Gamemodstudios' ecosystem, allowing for enhanced modding capabilities, online features, and more. This guide will walk you through the process of integrating the SDK into your Unity project.

Prerequisites

Before getting started, ensure you have the following:

  • Unity 2021.3 LTS or later installed
  • A Gamemodstudios Developer Account (Sign up here)
  • The Gamemodstudios SDK Package (downloadable from the official repository)

Step 1: Import the SDK

  1. Open your Unity project.

  2. Navigate to Window > Package Manager.

  3. Click the + button and select Add package from git URL.

  4. Enter the Gamemodstudios SDK repository URL:

    https://github.com/Game-mods-studio/Gamemodstudios-SDK.git
  5. Click Add and wait for the package to install.

Step 2: Configure the SDK

  1. Go to Edit > Project Settings > Gamemodstudios SDK.
  2. Enter your Gamemodstudios API Key and Project ID (available in the developer dashboard).
  3. Adjust settings based on your game’s needs, such as authentication, modding support, or cloud services.

Step 3: Initialize the SDK

In your main script (e.g., GameManager.cs), initialize the SDK:

using Gamemodstudios;

public class GameManager : MonoBehaviour
{
void Start()
{
GamemodstudiosSDK.Instance.Initialize();
}
}

Step 4: Verify the Integration

  1. Run your game in the Unity Editor.

  2. Open the Console window and check for the message:

    Gamemodstudios SDK Initialized
  3. If you encounter errors, ensure the SDK is installed correctly and your API keys and/or gameID are valid.

Next Steps

Now that you’ve integrated the SDK, explore additional features:

  • Modding Support: Enable user-generated content for your game.
  • Online Services: Use cloud features and leaderboards.
  • Analytics: Track player activity for insights.

Happy coding and welcome to the Gamemodstudios ecosystem! 🚀