Skip to content

README.md

Latest commit

 

History

History
89 lines (71 loc) · 4.3 KB

README.md

File metadata and controls

89 lines (71 loc) · 4.3 KB

日本語 | English

SpriteStudio 6 SDK

Copyright © CRI Middleware Co., Ltd.

Overview

This SDK consists of libraries and tools for flexibly using data (sspj, ssce, ssae, ssee) created with OPTPiX SpriteStudio 6 or later in your own playback environment.

  • sspjLib: A library for parsing SpriteStudio project files (sspj).
    • Loader: Module for loading SpriteStudio 6 format files (sspj, ssce, ssae, ssee).
    • Animator: Animation module that performs coordinate transformation, interpolation calculation, etc.
    • Drawer: Drawing module using OpenGL.
  • Tools: Tools created using the library.
    • Viewer: Viewer sample for Windows/Mac.
    • Converter: Converts sspj files into files for playback programs (.ssbp, .json, etc.).

Intended Use

The purpose of this SDK is to parse sspj files to create players for new platforms, or to create tools for processing and converting data into other formats. For use in games and apps, we provide player programs specialized for animation control. We also provide external tools useful for animation editing, so please refer to the links below.

Disclaimer

This SDK is maintained with the goal of being a reference implementation. It maintains a certain degree of redundancy without performing optimizations for specific platforms. Since the develop branch is the latest development version, it may contain some bugs. If you need a stable version, please obtain it from Releases.

Update History

Supported SpriteStudio Versions

Releases are created in the format SDK Version_SpriteStudio Version (e.g., 2.2.0_SS7.1.0). For details, please see Releases.

Tools

How to Build the SDK

Data Structure and Class Reference

SpriteStudio6 SDK Document

Branch Rules

SpriteStudioSDK has master and develop branches. The latest code, including the player, is committed to develop. Once judged to be a stable version, it is merged from develop to master and assigned a version number.

Pull Requests

Pull Requests are very welcome! There is no need to create an Issue before sending a request. Providing details of the changes in the commit comments is sufficient.

Open Source Libraries Used

The SDK uses the following libraries. Please check the links below for the licenses of each library.

SpriteStudio 5 3rdParty

We publish programs provided by the community. Please read this before use. SpriteStudio 5 3rdParty

Contact

Please post questions, requests, and bug reports to Issues. If you prefer to contact us privately, please use the Help Center. If you need to send reproduction data, please do so via the Help Center.

CRI Middleware Co., Ltd. https://www.cri-mw.co.jp/ Copyright © CRI Middleware Co., Ltd.