Skip to content
X4D ESO Add-Ons
Lua PowerShell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
X4D_Bank
X4D_Chat
X4D_Core
X4D_LibAntiSpam
X4D_LibStub
X4D_Loot
X4D_Mail
X4D_MiniMap
X4D_Quest
X4D_UI
X4D_Vendors
X4D_XP
lib
.gitignore
Create-AddOnSymLinks.ps1
Create-LibSymLinks.ps1
Create-Packages.ps1
LICENSE.md
README.md

README.md

Build status

X4D ESO Add-Ons

A collection of LibStub-compatible Add-Ons that provide minor enhancements to the game "Elder Scrolls Online".

Compatibility with Others, and Infrequent Updates

Development of these AddOns began years ago when the game first released. I still enjoy using them when I play and don't really "shop" much for others, so, I've no idea if they are at all compatible with other AddOns.

I only update these AddOns when I am actively playing the game, which has been infrequent over the years. Bills need paying, life remains busy. I'd be happy to work with other developers to maintain these AddOns (will grant rights as necessary to commit and release new builds.) Would be nice to see enough contributors to keep these alive and listed on ESOUI, Curse, etc.

As it is I no longer publish to these sites because I'm not publishing regularly enough for it to matter. Instead, i've added a set of scripts to assist others with getting setup directly from github for development and/or play-testing. I've also added a script to assist with the package & deployment of these AddOns.

Dependencies

  • LibStub (Optional)
  • LibAddonMenu-2.0 (Optional)

Modularity

One of the earliest goals of X4DESO was to provide modular add-ons, so users could install only what they wanted.

To that end, the following independent modules exist. When it makes sense they will auto-detect one another and interact accordingly.

  • X4D_Core - A LibStub-compatible Framework for Developing Add-Ons for ESO, All X4D Add-Ons depend on this Framework.
  • X4D_Bank - Performs regular bank deposits of items and gold based on user-configured options.
  • X4D_Chat - Modifies Chat to show Character Names in Guild Chat, and adds timestamps to all chat messages, supports color stripping, text clean-up. All features optional.
  • X4D_LibAntiSpam - An Anti-Spam Library that can be used to perform basic pattern/flood spam filtering.
  • X4D_Loot - Displays looted Items in Chat Window, including Quest Items, Stack Counts, Item Icons and Monetary transactions.
  • X4D_Mail - Provides minor Mail enhancements, namely integrating 'LibAntiSpam', performing auto-accepting mail attachments and auto-deleting system-generated mail.
  • X4D_Vendors - Launder and Sell items at Merchants and Fences.
  • X4D_XP - Shows XP Gains in the Chat Window.
  • X4D_UI - Provides additional UI elements to the game, such as a Status Bar Window
  • X4D_MiniMap - (BETA) Adds a 'minimap' to the game with Tracked Quest, POI and NPC pins.
  • X4D_Quest - Integrates with in-game Quest Tracker and Quest APIs, used by MiniMap.

All of them are optional, except for X4D_Core, which all other X4D Add-ons depend on and it is thus required.

Development and/or Play-Testing

So you want to develop these AddOns, or, you want to play with these AddOns directly from the github repository? This section is for you.

Create-AddOnSymLinks.ps1

Creates symlinks for all X4D AddOns from the current repository to the default %USERPROFILE% location.

This is useful for developers that like to keep their development projects in a standard location (most of us?)

Q: I pulled from github but AddOn does not appear in AddOn Manager after restart of ESO?

A: Run Create-AddOnSymLinks.ps1 with Administrator privileges.

Create-LibrarySymLinks.ps1

Creates symlinks for all libraries used by AddOns.

Rather than have libraries/dependencies copied multiple times throughout the repository, a single copy of each dependency is maintained in /lib/ and this script is used to create symlinks from /lib/ into each AddOn folder.

Q: I ran Create-AddOnSymLinks.ps1 but still no workie.

A: Also run Create-LibrarySymLinks.ps1 with Administrator privileges.

Create-Packages.ps1

This script is used on the build server to create ZIP files with properly deployed libraries, README and LICENSE files ready for upload to ESOUI, Curse, or other ui mod aggregator.

Slash Commands

There are slash commands you will find useful when debugging AddOns or Testing changes to X4D AddOns.

Command
/x4d Without arguments this slash-command will print a 'Version' and 'Load Time' summary for all X4D AddOns.
/x4d dev Puts the AddOns into 'Development Mode'; Sets the log level to VERBOSE (shows 'useful' logging/activity, but not 'all'), and then performs a broad test of X4D_Core module. If you're doing any development that uses X4D_Core you will usually use this command after performing a /reloadui.
/x4d debug Puts the AddOns into 'Debugger Mode'; Sets the log level to DEBUG (shows all logging/activity), and adds a performance summary in the Chat window. You will not use this command often/ever.
/x4d pos,/x4d loc Print player location including 'normalized/virtual' and 'minimap/actual' coordinates.

Additionally, the X4D_DB module exposes its own commands:

Command
/x4db count [DBNAME] Writes the count for the specified database. If no database is specified then "all" DBs are enumerated. Please be aware that 'transient' databases may be enumerated by this command.
/x4db reset <DBNAME> Resets the target database such that it contains no items, no keys. Nothing. WARNING! Performing this against a "Core" DB may have unintended side-effects that will require you to manually delete savedvars. You should only use this to reset your OWN databases.

Support, Assistance, and Bug Reports

You can file a bug at GITHUB.COM.

You can send me in-game mail (not a /tell) if you prefer. I can be found on NA servers as @wilson0x4d. Feel free to say hello if you see me wandering about. :)

Donations

I hope you enjoy using my add-ons as much as I enjoy creating them. If you want to show your support and donate :D I can always use in-game gold and items, and they're easy things to come by.

I am also a firm believer in Bitcoin, so if you really want to put a smile on my face send a Bitcoin donation (of ANY amount!) to 1PeRYfrygTEo3VuJCQaZL5A43hrssRTNVH, you can use a service like Coinbase to purchase and send bitcoin if you don't already have a bitcoin wallet.

You can’t perform that action at this time.