Skip to content

install.md

Latest commit

 

History

History
24 lines (15 loc) · 1.29 KB

install.md

File metadata and controls

24 lines (15 loc) · 1.29 KB

Installation

Steps for getting started with SpriteStudioPlayer for Godot.

A. Use the SSPlayerForGodot GDExtension (Recommended)

The shortest path to using the plugin without any build work.

  1. Download a 4.6-series Godot Engine from the official site.
  2. Download the GDExtension bundle for your platform from the SSPlayerForGodot Releases.
  3. Extract the ZIP and copy the addons folder it contains into your Godot project root directory.
    • If placed correctly, res://addons/spritestudio/spritestudio.gdextension should exist.
  4. Restart the Godot editor and the SpriteStudioPlayer2D node and the SS Import Dock will become available.

B. Use a Godot Engine with the SSPlayerForGodot Custom Module

If you want to build and use the plugin as a custom module, refer to the Build Guide.

Next Steps

Once installation is complete, continue to one of the following:

  • If you do not have an .ssab file yet → Asset Import and Editor Integration to generate .ssab from your SpriteStudio project (.sspj).
  • If you already have an .ssab file in your project → Basic Usage to place and play it in a scene.