Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 7.64 KB

README.md

File metadata and controls

100 lines (75 loc) · 7.64 KB
Raw

DisPlace Plugin

This is a modification of MakePlacePlugin for personal use. I make no assurances that this will work or that I will keep it updated as I mainly just wanted to enable features that were disabled in makeplace and enable the plugin for the current version of FFXIV. A plugin to automatically save and load housing furniture layouts for FFXIV. It can also import/export layouts from the MakePlace program since it uses the same file format.

Contents

Installation

  • You will need to use the FFXIV Quick Launcher to run the game. This allows third-party plugins (such as this) to be used.
  • Open the settings window by using the command /xlsettings in the chat, or by hitting Esc and selecting Dalamud Settings.
  • Click on the "Experimental" tab
  • Copy the following url into a new line on the Custom Plugin Repositories section: https://raw.githubusercontent.com/Drakansoul/DisPlace/master/DisPlacePlugin.json
    • Note: This plugin does not work for the CN server.
  • Click on the + button. Make sure the new entry has "Enabled" checked.
  • Click the "Save and Close" button
  • Open the plugins window by typing /xlplugins in the chat, or hit Esc and select Dalamud Plugins
  • Search for "DisPlace Plugin" and click "Install"

Usage

Type /displace to open the plugin screen. Most functions are only available when in Rotate Furniture mode (Housing -> Indoor/Outdoor Furnishings. Click on the Rotate button).

Saving a layout from the game

  • Make sure you are in furniture mode
  • Click on Get Interior/Exterior Layout
  • Click on Save As, and specify the file name. Done!

Loading a layout into the game

  • Make sure you are in rotate furniture mode
  • Click on Load and select the .json design file. Your layout should show up in the plugin
  • Make sure the relevant floors are checked.
    • If in an apartment, you want to check all floors
  • Make sure all the required furniture are placed in the house
    • The plugin will not touch furniture that are in your inventory or storage
    • If you re-load the design, all the furniture in the list should be white and not grayed out
  • Click on Apply Interior Layout. Sit back and wait for the placement to finish!

Interface

  • Save As: Saves the currently loaded interior and exterior layout to the specified file. You will need to load the interior/exterior layout before you can save it.
  • Save: Saves the layout to the current file. When first starting the plugin, this is not available since no file is specified.
  • Load: Loads the layout from the specified file. The plugin will check the currently placed furniture in the house to see if there is a match with the layout. It also checks if there is a match for the dye color. All layout furniture with no match will be grayed out.
  • Get Interior/Exterior Layout: Loads the current furniture layout in the house/yard. Interior and exterior layouts are loaded separately.
  • Apply Interior/Exterior Layout: Applies the layout position to all applicable furniture in the house/yard (those that are not grayed out). Furniture needs to be placed before it can be used in the layout - items in the inventory or storeroom will not be used. Make sure that no furniture is selected before using this.
  • Time Interval: The time period between each furniture placement when applying the entire layout. Setting this too low (e.g. 200ms) may cause some furniture placements to be missed.
  • Label Furniture: Shows a small tooltip over each furniture, with a button to apply the layout position to the furniture

FAQ

Help! I can't get the plugin to work.

Do not contact the original author unless the errore you are seeing occurs in their plugin. I will likely not do much debugging or work on this plugin I provide no gurantees as to the usability or safety of this plugin.

Does the plugin work if the game is not in English?

Yes! Saving, loading, and transferring layouts will work in all languages.

Can I use this to copy layouts from other houses?

No. You can only load layouts when in furniture layout mode, in your own house. Yes you can! This is the entire reason I modified the original. I doubt it's safe, though the original author likely didn't want people stealing each other's designs. IDK, I just wanted to copy the layout from a house so I took off the guard rails.

Does the plugin use furniture from my inventory or storage?

It uses the furniture that is already placed in the house. It won't touch your inventory or storage, so there's no worries about messing up inventory management. Also, since placing furniture binds it and makes it untradeable, it's best that the player does it directly.

Is it safe to use the plugin?

PROBABLY NOT!

Since all third-party plugins are not in line with the game's terms of service, there is always an inherent risk. The plugin's automated furniture placement may also be detectable by the server as there is a very short interval between placing each furniture. You can increase the time interval between each furniture placement to reduce this risk.

Overall, I believe that the danger is low since SE focuses more on ToS violations that upset the game-balance (e.g. RMT). You can also reduce your risk by keeping a low profile and not mentioning the use of the plugin within the game.

How do I update the plugin?

Likely never unless I get pinged to update this.

Why does the furniture snap back to the floor/wall after I apply a layout and exit the furnishing menu?

Items have a minimum float distance, below which they will snap back to the floor. Similarly, wall-mounted items have a minimum distance they need to be from a wall or partition, otherwise they will snap to it. Unfortunately, this is a game limitation and you will need to adjust your design.

If using the MakePlace app, you can enable Minimum Float Distance in settings to get a visual indicator when placing furniture.

Why does the plugin crash sometimes when applying a layout?

Make sure of the following:

  • Mouse cursor is not hovering over any item (even if the item is behind the plugin UI). When applying a layout, hovering over an item may cause some game code to conflict with the placement process.
  • Character is not in the way of where furniture will be placed
  • No more than 10 items attached to another (e.g. table-top items on tables, wall-mounted items on partition walls)

There is unfortunately no solution to the above issues, since this is tied to how the game operates.

The plugin says it's placing items but nothing is moving

You probably pressed Get Interior Layout, which loads the current layout in the game, instead of Load, which loads the layout from the file. Since the plugin is placing furniture that is already in position, it will look like nothing is moving.

Credits

MakePlacePlugin for making a great plugin. This plugin builds upon the foundation laid by 3 other great plugins: HousingPos, BDTH and HouseMate. The UI in particular borrows heavily from HousingPos.

Donate

If you enjoy this plugin work and wish to support the original creator, you can use the below links:

Ko-fi: https://ko-fi.com/jawslouis

Patreon: https://www.patreon.com/jawslouis