Skip to content

Latest commit

 

History

History
47 lines (41 loc) · 4.17 KB

README.md

File metadata and controls

47 lines (41 loc) · 4.17 KB
Raw

Splatoon

An accessibility tool to assist in FFXIV gameplay and compensate for human imperfections.

Become a Supporter!

If you like Splatoon or any of the other plugins I maintain, please consider becoming a supporter on Patreon or via other means! This will help me to continue updating Splatoon and work on new plugins and features.

Key features

  • Put infinite amount of waymarks in the world with different shapes, colors, hit text, etc.
  • Create various trggers and conditions to display them in specific situations.
  • Quickly find objects around you using /sf command.
  • Create, import and share scripts - extensions of Splatoon, capable of doing pretty much any stuff that any Dalamud plugin can do, but in a much faster to create way and with a lot of helper objects provided. Ideal for creating so-called "microplugins" without hassle of creating full plugin just to do some small thing.
  • Use Web API to integrate Splatoon with other programs and ECommons Splatoon API to integrate it with other plugins.

Important information

  • Splatoon is designed to operate primarily as an accessibility tool to compensate for people's imperfections.
  • By default, Splatoon comes with no presets or scripts preinstalled. It's on you to find and import ones that you want to use or create your own.
  • Imported presets will not update automatically. Should new version become available, you will have to update it yourself.
  • Imported (from official repo) scripts, however, will update automatically.
  • Splatoon only operates on a client side. Other players can not see and can not interact with your presets and scripts. Server can not check whether you are using Splatoon or not.
  • Splatoon only uses data you supply. Additionally, Splatoon uses only data that is available to you normally, without going beyond standard game client operations.
  • It is advised against streaming or screen sharing while using Splatoon.
  • Presets and scripts that can be used to deteriorate other player experience are not accepted.

Navigation

Information for Chinese players

Chinese fork of Dalamud currently intentionally prevents usage of Splatoon by adding it into banned plugins list. Banned plugin list was originally created to prevent unstable plugins from loading on updates. However, Chinese forkers of Dalamud decided to abuse it to attempt to prevent you from using the plugin for their personal reasons.

Easy way to unblock Splatoon and all other plugins:

Simply download this program https://github.com/NightmareXIV/UnbanPluginsCN/releases/latest and run it before you run the game/inject Dalamud. Just keep this program running and you should be good.

This plugin is in development

This means that there are still features that I would like to implement in future or features that I would like to enhance, as well as that I'm accepting suggestions and feature requests.

Installation

  1. Install FFXIVQuickLauncher and enable Dalamud in it's settings. You have to run the game through FFXIVQuickLauncher in order for any of these plugins to work.
  2. Open Dalamud settings by typing /xlsettings in game chat.
  3. Go to "Experimental" tab.
  4. Find "Custom Plugin Repositories" section, agree with listed terms if needed and paste the following link into text input field: https://love.puni.sh/ment.json
  5. Click "Save" button.

You should now have Puni.sh plugins available in your plugin installer.
Open plugin installer by typing /xlplugins in game chat, go to "Available plugins" section and search for a plugin you would like to install.

image

Support

Join Puni.sh Discord to receive support for the plugin.