Redprint: Difference between revisions

From Resonite Wiki
Created page
 
many Major Additions
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
RedPrint is a [[ProtoFlux]] managing [[Tools|tool]] created by [[User:Ukilop|Ukilop]]. It is used to easily pack, unpack, and organise ProtoFlux code.
Redprint is a [[Community Tools|Community Tool]], created by [[User:Ukilop|Ukilop]], for managing [[ProtoFlux]]. It is used to easily pack, unpack, and organize ProtoFlux code.


Additionally, RedPrint allows you to label particular scripts with a name and color for additional distinction when working.
Additionally, Redprint allows you to label particular scripts with a name and color for additional distinction when working.


There is a [https://youtu.be/YyFRNAI0HiI?si=s80Mgvw-xKvPMG5q video tutorial] detailing the use of RedPrint.
Here is an unofficial [https://youtu.be/YyFRNAI0HiI?si=s80Mgvw-xKvPMG5q video tutorial] detailing the use of Redprint. And here's the older [https://www.youtube.com/playlist?list=PLmLAc9aMxtdIgVEasyU58tiZzRRxYe-dc official videos]. (July 2022)


== RedPrint Manager ==
The Redprint folder can be found in Ukilop's public folder: <code>resrec:///U-ukilop/R-75dcb1f3-678b-4b1d-81f9-2297b173a574</code>
All RedPrints rely on the existance of a RedPrint Manager object. Without the Manager, a RedPrint will not work as expected. Most of the code used by the RedPrint is contained in the Manager for optimisation reasons.


== RedPrint Tool ==
== Redprint Manager ==
The RedPrint Tool is used to spawn new RedPrints and also doubles as a [[ProtoFlux Tool|ProtoFlux Tool.]] The RedPrint  Tool can be aquired by clicking on a RedPrint Manager.
All Redprints rely on the existence of a Redprint Manager being present in the world, but only one is needed no matter how many Redprints are in the world. Without the Manager, a Redprint will not work as expected. Most of the code used by the Redprint is contained in the Manager for optimization reasons.
 
== Redprint Tool ==
The Redprint Tool is split into two tools, the RedTip and a modified [[ProtoFlux Tool]].
 
The Redprint Tool can be acquired by clicking on the Redprint Manager, or a button on the Redprint's UI.
 
The modified ProtoFlux Tool has a few additional features:
 
* Auto-Snap: when pointing at a Redprint, spawning a node will automatically place the node onto the print
* VR label Overlay: the material for the text above the tool is (locally) an Overlay material
* <s>NodeTransformer: Used to quickly create certain nodes of any type</s> [Currently non-functional and hidden, may revisit.]
 
==== RedTip ====
The RedTip is the primary tool for interfacing with many of the more advanced Redprint features such as:
 
* Miniprints
* Comments
* Group Actions
 
== Meta ==
There are are few features that exist in or around Redprint for more advanced users:
 
==== Cloud Spawning ====
First off, while Cloud Spawning is on the [[Things to Avoid#Using Keyboard Components/Nodes to spawn items|Things to Avoid]] list, every item that is spawn-able is available in the public folder, Just In Case<sup>TM</sup>.
 
The Redprints already use Cloud spawning to spawn the Manager when not present, and the RedTip has a context menu Cloud Spawn for more Redprints.
 
The Cloud spawn for a Redprint is available in the Beta folder.
 
==== Redprint Tool Integration ====
In the Redprint Beta folder, there is also a special module to dynamically fetch the Redprint Tip from the manager and make it a part of whatever multi-tool you integrate this module into. This means it can grab the newest version of the Redprint Tip from the manager each time its needed.
[[Category:Tools:CommunityTools]]

Latest revision as of 06:27, 5 February 2024

Redprint is a Community Tool, created by Ukilop, for managing ProtoFlux. It is used to easily pack, unpack, and organize ProtoFlux code.

Additionally, Redprint allows you to label particular scripts with a name and color for additional distinction when working.

Here is an unofficial video tutorial detailing the use of Redprint. And here's the older official videos. (July 2022)

The Redprint folder can be found in Ukilop's public folder: resrec:///U-ukilop/R-75dcb1f3-678b-4b1d-81f9-2297b173a574

Redprint Manager

All Redprints rely on the existence of a Redprint Manager being present in the world, but only one is needed no matter how many Redprints are in the world. Without the Manager, a Redprint will not work as expected. Most of the code used by the Redprint is contained in the Manager for optimization reasons.

Redprint Tool

The Redprint Tool is split into two tools, the RedTip and a modified ProtoFlux Tool.

The Redprint Tool can be acquired by clicking on the Redprint Manager, or a button on the Redprint's UI.

The modified ProtoFlux Tool has a few additional features:

  • Auto-Snap: when pointing at a Redprint, spawning a node will automatically place the node onto the print
  • VR label Overlay: the material for the text above the tool is (locally) an Overlay material
  • NodeTransformer: Used to quickly create certain nodes of any type [Currently non-functional and hidden, may revisit.]

RedTip

The RedTip is the primary tool for interfacing with many of the more advanced Redprint features such as:

  • Miniprints
  • Comments
  • Group Actions

Meta

There are are few features that exist in or around Redprint for more advanced users:

Cloud Spawning

First off, while Cloud Spawning is on the Things to Avoid list, every item that is spawn-able is available in the public folder, Just In CaseTM.

The Redprints already use Cloud spawning to spawn the Manager when not present, and the RedTip has a context menu Cloud Spawn for more Redprints.

The Cloud spawn for a Redprint is available in the Beta folder.

Redprint Tool Integration

In the Redprint Beta folder, there is also a special module to dynamically fetch the Redprint Tip from the manager and make it a part of whatever multi-tool you integrate this module into. This means it can grab the newest version of the Redprint Tip from the manager each time its needed.