Installation

A comprehensive guide to installing the plugin, including system requirements and any dependencies.

The S2SDK Plugin can be installed in two ways: manually downloading the release or using the Plugify package manager. This guide explains both methods and provides step-by-step instructions.

Method 1: Manual Installation

Download the Release

  1. Go to the S2SDK Plugin repository.
  2. Navigate to the Releases section.
  3. Download the latest release package (e.g., plugify-source-2.zip).

Extract the Package

  1. Extract the downloaded package to a temporary directory.

Place the Plugin in the Plugins Folder

  1. Locate the plugins folder in your Plugify installation directory.
  2. Copy the extracted plugin files into the plugins folder.

Verify Installation

  1. Start Plugify.
  2. The S2SDK Plugin should now be available for use.

Method 2: Installation via Package Manager

Add the Repository (if needed)

If the S2SDK Plugin is not found in the default package repository, you need to add the repository manually.

Option A: Add Repository via Command

  1. Run the following command in your terminal:
    plg repo https://untrustedmodders.github.io/plugify-source-2/s2sdk.json
    

Option B: Add Repository via plugify.pconfig

  1. Open the plugify.pconfig file in your Plugify installation directory.
  2. Add the following line under the repositories section:
    {
      "repositories": [
        "https://untrustedmodders.github.io/plugify-source-2/s2sdk.json"
      ]
    }
    

Install the Plugin

  1. Run the following command in your terminal:
    plg install s2sdk
    

Verify Installation

  1. Start Plugify.
  2. The S2SDK Plugin should now be installed and ready for use.

Folder Structure

After installation, the S2SDK Plugin should have the following folder structure:

Explanation

  • res/plugins/s2sdk: The root folder for the S2SDK Plugins.
  • bin: Contains the compiled plugin binaries (.dll for Windows, .so for Linux and .dylib for macOS).
  • s2sdk.pplugin: The plugin manifest file that describes the plugin and its exported functions.

Troubleshooting

Plugin Not Found

  • Ensure the repository URL is correct and accessible.
  • Verify that the repository has been added to plugify.pconfig or via the plg repo <url> command.

Installation Fails

  • Check your internet connection.
  • Ensure you have the latest version of Plugify installed.