Skip to content

universalconquistador/Stagehand

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

165 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

  Stagehand Logo

Stagehand is an FFXIV plugin that lets the player place extra visual objects into the game world and manage them in sets called Stages.

Installing

Add the custom repo https://github.com/universalconquistador/Stagehand/releases/latest/download/repo.json in your Dalamud settings and then install the Stagehand plugin.

Usage

Use the /stagehand command to bring up the main UI.

The left side of the main window lists the Stages in your Stages folder (by default in C:\Users\<username>\Documents\Stages\). The right side of the main window shows info about the selected Stage and lets you edit it or assign it to automatically load for specific locations.

Get or create some Stages and set their automatic show conditions to fill your journey through Eorzea and beyond!

Developers

Repo Layout

Stagehand is made up of several C# projects:

Stagehand.Definitions: The object model for Stage .json files and the serialized strings used in IPC.
NuGet Version

Stagehand.Api: A library for other plugins to interact with the Stagehand plugin via Dalamud IPC.
NuGet Version

Stagehand: The Stagehand FFXIV plugin itself, including (but not limited to):

  • The Stagehand.Live namespace, containing classes for creating objects ingame from Stage definitions
  • The Stagehand.Windows namespace, containing the Dear ImGui windows that make up the plugin's user interface
  • The Stagehand.Editor namespace, containing all the code for the definition editor

IPC

The Stagehand IPC API is defined in the Stagehand.Api.IStagehandApi interface. It lets plugins query the local Stage definitions and create, show, hide, and destroy temporary Stages.

To get started, reference the Stagehand.Api NuGet package and call StagehandApi.CreateIpcClient(). For more information, see the README.

Definitions

To inspect, modify, or generate Stage definitions, use the Stagehand.Definitions package. For more information, see the README.

Human Project

This whole thing is designed and typed by humans, so far just myself (UniversalConquistador), for you, for the joy of it.

About

FFXIV plugin for creating extra objects in the world.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Generated from goatcorp/SamplePlugin