DOE: OLE Extension

From Fantasy Grounds Wiki
Jump to: navigation, search

The DOE: OLE Extension brings the ability to link to external URLs to Fantasy Grounds in the form of OLE Links. OLE Links can be manually selected and triggered by the GM.

OLE Links are accessed via the DOE: OLE OLE List and GM-created MiniLists, lists of OLE Links able to be manipulated almost the same as any other Fantasy Grounds list of links.

OLE Links can be used in Story and Notes Entries via the use of MiniLists which can be linked via the Link Paragraph Type. MiniLists can even be placed on Maps and Images as Map Pins. Basically, almost anywhere where you can use a Link in Fantasy Grounds you can use a MiniList.

GM's can share MiniLists with Players.

Version

1.0 - Initial Creation
1.3 - FG v3.2.2 Compatibility Update

Dependencies

This Extension is dependent upon the following Rulesets:

  • CoreRPG v3.2.2+

This Extension is dependent upon the following Extensions:

  • DOE: Base v2.3

Ruleset Compatibility

This Extension has been tested and works with the following Rulesets:

  • CoreRPG Ruleset v3.2.2+
  • 3.5E D&D Ruleset
  • 4E D&D Ruleset
  • 5E D&D Ruleset
  • Barbarians Of Lemuria Ruleset
  • 6E Call Of Cthulhu Ruleset
  • 7E Call Of Cthulhu Ruleset
  • Castles And Crusades Ruleset
  • Fate Core Ruleset
  • Numenera Ruleset
  • Pathfinder Ruleset
  • SavageWorlds Ruleset

This Extension has been tested and works with the following Rulesets, but requires compatible Graphics. Please contact the Author if you would like to help by providing suitable Graphics:

  • 13th Age Ruleset v3+
  • d20 Modern Ruleset
  • MoreCore Ruleset

This Extension is not required by the following Rulesets, as this functionality is already built-in:

  • DOR: Core Ruleset
  • DOR: Alternity Ruleset
  • DOR: Dragon Warriors Ruleset
  • DOR: √úbergame Ruleset

This Extension will not work with any other Ruleset. Other CoreRPG-Child Rulesets may be able to use this Extension, but the Extension will need to be tested first. Please contact the Author if you would like this Extension to be tested with an unlisted CoreRPG-Child Ruleset.

Extension Compatibilities

This Extension has been tested and works with the following Extensions:

  • DOE: Alignment Graph Extension
  • DOE: Campaign Style Graph Extension
  • DOE: Locations Extension
  • DOE: Organisations Extension
  • DOE: Sound Extension
  • DOE: Weather Extension
  • 1890s Era (CoC)
  • 5E - Language Fonts (FR) - Wizards
  • 5E - Language Fonts - Wizards
  • Blank Skills (Fate)
  • D&D Player's Handbook Desktop Decal Extension
  • Dark Ages (CoC)
  • Present Era (CoC)
  • Theme - Dungeon
  • Theme - Wood

This Extension has been tested and works with the following Extensions, but requires compatible Graphics. Please contact the Author if you would like to help by providing suitable Graphics:

  • 5E D&D Theme - Wizards

This Extension has not been tested with any other Extension, but should work with any Extension compatible with the CoreRPG Ruleset v3.2+ and any child Rulesets.

Supersedes

The following Extensions are superseded by this Extension and are no longer required:

  • None

Known Bugs

This Extension has the following known bugs:

  • None

Usage

Creating OLE Links

OLE Links and MinBoards can only be created by the GM.

OLE Links cannot be created directly on the DOE: OLE OLE List, but are created via the DOE: OLE OLE Setup page. Simply create an OLE Record with whatever name you like, then enter in an appropriate OLE Link String.

It's also generally a good idea to note down in Notes section any relevant information about the OLE Link.

Finally, remember to Lock the OLE Record so that you don't accidentally overwrite the new OLE Link.

Using OLE Links

OLE Links can be activated by clicking on the appropriate OLE Link Icon, a green box with a blank set of chain links in it. All OLE Links will be displayed on the DOE: OLE OLE List so that you can have all of your OLE Links in one place.

OLE Links can also be dragged from the DOE: OLE OLE List to any MiniList. MiniLists are exactly that: Mini OLE Lists. MiniLists can be organised into Categories, linked into any place in Fantasy Grounds that will accept a regular link, including as Pin Links on Images and Maps and as Link Formatted Paragraph Types in Story and Note Entries, and even shared with Players.

OLE Links can also be linked directly to Maps and Images, Story and Note entries, etc, without using a MiniList. However, the resulting OLE Links will not be Exportable and WILL NOT WORK when re-imported. It is highly recommended that you only place OLE Links via a linked MiniList. OLE Link Icons will revert back to the standard Fantasy Ground Link Icon if linked incorrectly, indicating that they will be broken if Exported.

OLE Links and OLE Records can be deleted and edited, but any such changes will have no effect on any OLE Links on MiniLists or on OLE Links dragged from the DOE: OLE OLE List, because when an OLE Link is dragged from the DOE: OLE OLE List a copy of the OLE Link is made when the OLE Link is dropped onto the parent object.

Extension Details

General Information

All Controls and Entryfields should be self-explanatory. Notes are provided for those that may not be.

All Fields will be Hidden when Empty.

All Text Entryfields are multi-line.

The Notes Field is a FormattedText.

All OLE Links are eligible to be used as Pin Locations on Maps as well as Links in all CoreRPG sub-systems, but this is NOT recommended; use one or more OLE Links on a MiniList instead. MiniLists should be able to be used in all CoreRPG-Child Ruleset sub-systems, but this is not guaranteed.

Accessing The DOE: OLE System

The DOE: OLE System is accessed from the Menubar/Sidebar by clicking on the Small OLE Button located with the other Small Buttons. Note that this Button may be different from the one shown in some Rulesets.

This opens the OLE List, which consists of a list of OLE Links. Also accessible via the Tabs along the right-hand side are the OLE Records and the MiniLists, each consisting of a List of the appropriate Records (see Figure 2). In addition, there is the standard Filter Box along the bottom.

OLE List

The OLE List contains a List of OLE Links, along with a List Edit Button.

Each Entry in the List consists of a Name, a OLE Link Icon and, when the List is in Edit Mode, a Delete Item Button.

OLE Links are placed on this list automatically when they are created in OLE Records.

Setup (OLE Records)

The Setup Page contains a List of OLE Records, along with a List Edit Button.

Each Entry in the List consists of a Name, a Shortcut Icon and, when the List is in Edit Mode, a Delete Item Button.

OLE Records are use to record information about a given OLE Link, including the OLE Link's OLE String.

Type or copy (CTRL-V) the appropriate OLE String into the OLE String Entrybox.

Click on the green Create OLE Button to actually create the OLE Link for this OLE Record.

MiniList

The MiniList Page contains a List of MiniLists, along with a List Edit Button.

MiniLists are use to list groups of OLE Links to be linked to other Fantasy Grounds records. They consist of a Name, a List of OLE Links and a Notes page.

Drag and Drop OLE Links from the DOE: OLE OLE List to the MiniList to add OLE Links to the MiniList.

Useful Links

This Extension

Other Extensions By Dulux-Oz

Copyright Information

This Software is Copyright Peregrine I.T. Pty Ltd © 2004-2017 except where explicitly stated otherwise.

'Purple Die Over Australia' is Copyright Peregrine I.T. Pty Ltd © 2004-2017.

'Fantasy Grounds' is a trademark of SmiteWorks USA, LLC.

'Fantasy Grounds' is Copyright © 2004-2017 SmiteWorks USA LLC.

Copyright to other material within this Manual/Extension may be held by other Individuals and/or Entities. Nothing in or from this Manual/Extension in printed, electronic and/or any other form may be used, copied, transmitted or otherwise manipulated in ANY way without the explicit written consent of Matthew James BLACK or, where applicable, any and all other Copyright holders.

License Agreement

Please see the Extension Module (available from this Extension's Forum Page) for full Licensing details.

Donations

If you like this Extension and find it useful, you may like to consider making a Donation to the Author so that this Extension and similar Software can continue to be maintained and developed.

Donations can be made via PayPal to:

Thankyou.

Developer Notes

The following Notes are provided to enable other Developers to write Rulesets and Extensions which will be compatible with this one.

The Author is happy to assist fellow Developers to get their Ruleset and/or Extension working with this Extension - please contact the Author via the Fantasy Grounds Forums.

Extension Properties

This Extension includes the following Properties Tags:

<exclusiongroup>DOEOLE</exclusiongroup>
<loadorder>50</loadorder>

Return to the Extensions Page.