An open API service indexing awesome lists of open source software.

https://github.com/xelsplugins/xelstweaks

Modular Dalamud tweak hub for small quality-of-life changes.
https://github.com/xelsplugins/xelstweaks

csharp dalamud dalamud-plugin dotnet ffxiv final-fantasy-xiv tweaks xivlauncher

Last synced: 12 days ago
JSON representation

Modular Dalamud tweak hub for small quality-of-life changes.

Awesome Lists containing this project

README

          

# XelsTweaks

XelsTweaks is a modular Dalamud tweak hub for opt-in interface and utility fixes.

The first version contains the plugin shell, config window, tweak manager, and Auto Login tweak.

## Build

```bash
dotnet restore XelsTweaks/XelsTweaks.csproj
dotnet build XelsTweaks/XelsTweaks.csproj -c Release -p:EnableWindowsTargeting=true
```

On Linux, make sure Dalamud dev assemblies are available at `$DALAMUD_HOME` or `$HOME/.xlcore/dalamud/Hooks/dev`.

## Installation

Add the following URL to Dalamud's custom plugin repositories:

```text
https://raw.githubusercontent.com/XelsPlugins/XelsDalamudRepo/main/pluginmaster.json
```

Stable and testing builds are published manually. Testing builds require Dalamud's plugin testing versions option.

## Commands

- `/xelstweaks` or `/xt` opens the config window.
- `/xelstweaks list` prints registered tweak IDs.
- `/xelstweaks on ` enables a tweak.
- `/xelstweaks off ` disables a tweak.
- `/xelstweaks toggle ` toggles a tweak.

The same subcommands work with `/xt`.

## Adding Tweaks

1. Add a class under `XelsTweaks/Tweaks//`.
2. Inherit from `TweakBase`.
3. Override `OnEnable`, `OnDisable`, and optionally `DrawConfig`.
4. Register it in `TweakManager.RegisterTweaks`.