Skip to content

Hackathon (Sep. 2017)

Sebastien Phaneuf edited this page Aug 25, 2017 · 19 revisions

Getting Started - How to create a plugin?

Step 1 - Install prerequisites

In order to get setup to build the Stingray getting started plugin you'll need a Git client to clone the content of this repository on your computer.

If you want your plug-in to include C/C++ libraries that extend the editor or the engine, you will also need:

Step 2 - Get a developer build of Stingray 1.9

You can find a developer build of Stingray at the following location <http://todo jo box.com>

If you want to build your own version of Stingray you can following the instruction on the README page at this location.

Step 3 - Clone stingray-plugin

Clone this depot!

And follow the setup instructions.

TODO JO: provide links for cloning that fits with build version

Step 4 - Start hacking!

Technology Overview

Stingray is an interactive engine (and an editor) allowing a user to author games or interactive applications (VR or otherwise). The Stingray Editor supports a flexible plugin API allowing a user to enhance the capability of the editor.

Documentation resources

Extending the Editor

Extending the Engine

Lua Development

Plugins ideas

TODO ALL: Add plugins ideas

Sample Applications

Here are a list of already existing plugins and examples that can be used either as tutorials on how to implement some specific workflows or as inspiration.

Plugin installation

Here are the instruction to install any of the plugins described below:

1- Open Stingray Plugin Manager

pm

2- Press Add Plugin and navigate to the stingray-plugin-api-samples/samples folder and select the .stingray_project in one of the plugin folder:

pm

pm

3- See what has been added to Stingray :) Usually, it will be a new menu item in the Window menu or a totally new menu in the Main menu toolbar.

pm

Singray Plugin API Samples

This repository contains a lot of different plugin examples. You should download or clone this repository and look at some of the examples.

Noteworthy examples

  • Viewport Examples

Other plugins

  • (TODO JO) Giphy

  • Jo Massot: Git

  • (TODO SEB) Thunderstorm

Clone this wiki locally