Moduprint

Moduprint is a Community Tool created by Colin The Cat. It is a modular ProtoFlux print system, similar to Redprint or OpenPrint, where most of the system is implemented using modules. Modules are smaller pieces of ProtoFlux which can be installed or uninstalled from the Moduprint Manager for customization. The manager itself only acts as a host for the modules.

Public Folder

The Moduprint public folder can be spawned in the game by pasting the following URL:
resrec:///U-1QbdepR26LI/R-CB30C41B4356E36B163150D6264D16E3AADE132E7A3A8BF219678ED37BAC0648

Main Features

• Tabs: Similar to a browser or Visual Studio (Code), Moduprint lets you work in multiple tabs on the same print, one for each unpacked ProtoFlux slot.
• Interoperability: Packing modules provide support for several other community ProtoFlux tools like Redprint, OpenPrint, or LightPrint. This allows for both packing and unpacking in their specific formats. Multiple packing modules can be installed at the same time.
• Performance: Depending on the configuration, spawning can cause lag, but the print system itself causes no lag by just existing in a session.
• Comments: A comments module compatible with Redprint is available.

Getting Started

Spawn a Manager preset from the public folder. For this example use the one in Manager Presets/Moduprint. Make sure to spawn the latest version. You might also want to use a different preset if you are migrating from OpenPrint or Redprint.

You can install modules (mainly found in the public folder) by dropping them onto the install plate (the yellow rectangle with the Moduprint logo.) And you can uninstall a module by pressing the eject button next to the module on the manager UI.

You can then open a new "Print" by clicking on the "New Print" Button

Anatomy of Moduprint

Moduprint Manager

The manager will need to stay in the world for spawned tabs to stay functional. Every print calls back to the Manager.

It usually consists of (from bottom to top):

• The grab-cube:
  • Is used to be able to grab and move the Manager around.
  • Every major version of Moduprint uses a different color for the cube, to make them easier to distinguish on a glance.
• Installer Plate:
  • Drop a Module here, to install it.
  • Installation may fail if the module has incompatibilities or is already installed.
• Manager UI:
  • Shows the version of the manger in top right corner
  • The UI has 2 Tabs:
    • Modules:
      • List of installed modules
      • Each showing their Icon, Name, Description version and an uninstall button.
    • Prints:
      • Lists all open Prints that are linked to this Manager.
  • The "New Print" button:
    • Spawns a new Print at your current location.

Prints

There can be multiple Prints linked to a single Manager. They contain minimal logic. Instead, they call Methods on the Manager and thus don't significantly contribute to lag.

Prints can be modified significantly by installed modules. And thus might differ significantly from what is shown and dicribed here (from top left to bottom):

• Color Picker:
  • This lets you choose a color for your Print and the color that the slot of the packed flux should use.
  • Below that are 3 color presets that are applied when clicked . These are saved to a cloud variable and will be the same between Prints, Managers, Worlds, and will even persist between restarts.
    • The presets can be changed by grabbing the color wheel and dropping that color onto a preset.
  • You can also grab the color from the color wheel, and drop it onto comments to recolor them.
• Comments (left to right):
  • Show/hide Comments for this Print
  • Create "Label Comment"
    • Both the starting point and Text can be moved
    • Usually used to add context to a single node
  • Create "Zone Comment"
    • Can be resized by grabbing the lower right corner
    • Can be used in 2 ways:
      • To group a section of a script and add context
      • To add a longer comment
        • Enable this mode by clicking on the "T" icon in the top right corner
        • This lets you write down more text. Like a list of bugs or To-do's
• Selection:
  • Click the frame button to enable selection mode.
  • Click and Drag over the nodes you want to select.
    • You can now:
      • Move the whole selection (by grabbing the selection itself),
      • deselect
      • copy selection
      • add "Zone Comment" around the selection
      • delete selection
    • Selections can be transferred between tabs on the same print by just swapping to another tab.
      • (Remember to deselect the selection to parent the nodes to the new tab)
• Packing Buttons:
  • These allow you to easily pack the flux under a slot without using a ProtoFlux Tool.
  • Using the Packing buttons also retains any of Moduprint's Metadata when packing or unpacking (like colors, virtual parenting and comments)
  • You can either input a slot into the big input field on the left (Shows "null" on a new Print) or pack and unpack "flux cubes"
    • Slot Packing:
      • This is usually used to pack/unpack flux from an object or avatar.
      • You can provide a slot that contains multiple Flux "Groups"
      • Each group is some flux packed under its own slot.
        • (This is usually handled more or less automatically trough the Tab system)
      • You can Display all flux "groups" that can be unpacked by clicking on the icon with the filled box with an upward arrow.
        • This opens a list of "Flux groups" if multiple are found. It will open a flux group directly if only one was found
        • You can reorder them by simply grabbing one and dropping it onto another one to swap them.
      • You can pack the current Tab into a "Flux Group" by pressing the button with the outlined box and downward arrow.
    • Flux Cubes:
      • Moduprint will pack your flux into a simple box, if no slot is selected.
      • This is great for sharing flux snippets with others
• Tab Buttons:
  • The left button allows you to Virtual Parent The flux from the current Tab onto the selected slot
  • Top right is a copy Button. This duplicates the currently open tab
  • Bottom right is a delete Button. It deletes the current Tab and it's contents. (Has to be pressed twice to avoid accidental activation)
• Follow Button:
  • This enables the Side Panel to follow the user.
• Tabs
  • These are displayed at the bottom of a print.
  • You can rename the current Tab by clicking on its name.
  • Tabs can be reordered by grabbing one and dropping it onto another. This will swap the 2 Tabs

Presets

Manually installing all modules on a blank manager

• Moduprint: Comes with a 2D grid and the Moduprint packing format preinstalled.
• OpenPrint: Includes all modules needed to be interoperable with OpenPrint.
• Redprint: Includes all modules needed to be interoperable with Redprint.
• Vanilla: Only the most basic modules, including a 2D grid and packing support similar to the ProtoFlux Tool.

Creating Your Own Modules

Guidance on how to create your own modules can be found on the API Documentation.