Skip to content

Spine Viewer is a web application that allows you to visualize and play sprites created with Spine

License

Notifications You must be signed in to change notification settings

FrankoFPM/Spine-Viewer-Web

Repository files navigation

Spine Viewer

Spine Viewer is a web application that allows you to visualize and play sprites created with Spine, a 2D animation tool. This application is developed with React and Vite, and uses libraries such as PixiJS, Pixi-Spine, TailwindCSS and NextUI.

Read this in other languages: Español.

Features

  • Load and display Spine files in .skel format
  • Control the animations and modify basic values
  • Change the background of the visualization window
  • Supports Spine assets of version 3.8
  • Compatible with most modern web browsers

Prerequisites

Before you can run this project, you must have Node.js installed on your machine. This project has been tested and developed with Node.js version v18.17.1, so we recommend using at least that version to avoid potential compatibility issues.

You can download Node.js from the official Node.js website.

To check the version of Node.js you have installed, you can use the following command in your terminal:

node --version

Installation

To install and run the application on your local machine, follow these steps:

  • Clone this repository with the command git clone https://github.com/FrankoFPM/Spine-Viewer-Web.git
  • Enter the project folder with the command cd Spine-Viewer-Web
  • Install the dependencies with the command npm install
  • Start the development server with the command npm run dev
  • Open your browser and access the address http://localhost:####

Usage

To use the application, you need to have spine files in .skel format, which are generated by Spine when exporting the animations. You can get these files from different sources, such as games, tutorials or free resources.

To load a spine file, click on the "Upload asset" button and select the files of the spine you want to see, then on the "GO" button. The application will display the spine in the visualization window, and you can control the animation with the side controls. You can also change the background of the player with the "Background" button, you can choose a color or your own image.

This project aims to visualize sprites. In particular, it focuses on the sprites of the Azur Lane belong to Yostar game, owned by Yostar. Each user has the option to provide their own assets if they wish. This application is not for commercial purposes and aims to be a visualization and learning tool.

Note

You must select the 3 files of the sprite, they must have the same name The extensions for the 3 files must be .atlas, .skel and .png

Important

This application is an independent and unofficial project, which has no relationship or affiliation with Yostar, the company that owns the game Azur Lane. All copyrights and trademarks of Azur Lane belong to Yostar and their respective creators. This application only uses some names of characters from the game for educational and tribute purposes, without intending to violate the copyrights or obtain economic benefits.

Contribution

If you like this application and want to contribute to its development or improvement, you can do it in the following ways:

  • Report errors or suggest new features through GitHub issues

  • Send pull requests with your own changes or improvements to the code

  • Share the application with other users who may be interested

  • For more information on how to obtain the assets, please refer to the Asset Guide

License

This application is licensed under the GNU General Public License (GPL), which means that you can use it, modify it and distribute it freely, as long as any derived work is also licensed under the GPL and gives credit to the author.

About

Spine Viewer is a web application that allows you to visualize and play sprites created with Spine

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published