Revision as of 00:39, 29 January 2021 by Baertram (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Elder Scrolls Online allows us players to extend and even modify the default user interface via add-ons. ESOUI is a community dedicated to provide not only a large collection of add-ons created by many of our talented members, but also guides, tutorials and API information to help you create your own add-ons.

Overview

• API documentation
• ESOUI API Function - The lua file/function source code parsing reference that was split from the main API documentation page.
• API functions by category

API Versions:

• Current Live: 100033 "Markarth" ([1])
• Current PTS: 100034 "Flames of Ambition" ([2])
• API version history

Source

• github

Code:

• Functions - What your add-on can do
• Events - What can trigger your functions
• Filter for Events - What can filter your functions
• Global constants & their values

String and Text Handling:

• zo_strformat & ZO_CachedStrFormat for formatting localized text, player and NPC names, numbers, etc.
• In-game Text Formatting - color, padding, textures/icons, etc, in chat and labels.
• Creating and Understanding Links and Custom links
• Currency_Formatting Use ESO's built-in currency formatting

GUI:

• UI XML - The UI layout language
• Fonts - The game's UI fonts
• Controls - Provide UI interactivity
  • Anchors & Offsets - Positioning and anchoring controls to each other
• Virtuals - Used as for templates & inheritance
• Keybindings - List of keybinding names in the vanilla UI
• Example.xml - a working xml file that you can use as template

Data:

• UESP Data search UESP - ESO: Record Types
• Texture List - full and a list of Textures Textures useful for GUI building
• Sounds - how to play a sound, and an overview of the constants
• Maps - overview of maps
• Zones - overview of zones (ids and indices)
• Campaigns - PVP campaigns
• Keeps - keep IDs in Cyrodiil
• Collectibles - datamined collectible IDs and names
• Houses - a list of house ids
• Quests - a list of quest ids
• DLC & chapter - a list of the DLCs & chapters + their names
• Wayshrines - a list of the wayshrines

Getting Started

• Lua GOTCHAs
• AddOn Quick Questions
• Everything is a table?? A brief introduction of how LUA does things
• What variables and functions do exist?
• Write/read to/from disk (SavedVariables), and including other files

Packaging

• Add-on structure - Information about how to put together an add-on
• Add-on manifest (.txt) format - The way ESO interprets add-on metadata
• Libraries - Re-usable code / API functions etc. for your addons

Tutorials

• Writing your first add-on
• MyFirstAddon tutorial by Zenimax Online
• sirinsidiator's Simple Notebook Tutorial
• Circonian's Tutorials: Stamina Bar - Saved Variables - Menu Settings
• Click Counter Lua Tutorial

HowTo

• Event & Update Buffering
• How to add a slash command
• How to create custom links
• How to add buttons to the keybind strip
• How to add localization support
• Working with strings in ESO lua (zo_strformat)
• How to trigger things with ESO's default code
• PvP Zone Detection
• How to... do UI element X
• How to run your code before/after functions (PreHook/PostHook)
• How to create a/add to inventory context menu
• How to create a simple text tooltip at a control
• How to use Event handlers on controls (e.g. react on a mouse click)
• How to get a table of owned mounts [id]=name
• How to hide any assistant
• units and unitTags
• How to open menu / change UI mode like via keybinds
• How to get your AddOn removed

Templates

• A simple, event-based add-on to learn and copy from
• Scene Manager: On scene change
• Fragments in a scene: On fragment state change (e.g. Hide control as menu opens)
• Bank backpack items based on criteria
• LibAddonMenu: Example how to detect panel Show/Hide
• Collection of AddOn template with predefined structures/code

More

• Running LUA-Code asynchronously/delayed
• Annotated collections of events

• Utility functions

• ESO Database (items, skills, NPCs, etc.)
• ESO UI Source Code
• Lua language reference (not ESO specific)
• ESOUI.com: Downloads / Forums / Add-on Libraries
• Chat for add-on authors
• Add-on Terms

• FAQ
• Mon Premier Addon
• Premiers Pas

Contributeur et Moddeur Français, n'hésitez pas à participer !

• Fonctions

J'ai repris simplement la liste des fonctions déjà créé dans la VO, afin de pouvoir ensuite créer une nouvelle page à chaque fonction mais cette fois ci en Français ! TODO liste FR ( Pour les contributeurs qui ne saurait quoi faire ) :

• Traduire en général ce qui a déjà était fait par nos amis Anglophones
• Traduire la FAQ
• Créer les Pages FR des fonctions listé ici : Liste FR des Fonctions

Всем привет, здесь русская часть сообщества постарается публиковать переводы и материалы по аддонам к Elder Scrolls Online. Перед любыми действиями, в особенности перед созданием страниц, прочтите соглашение об именовании. Будем рады помощи! Пока все переводится skv1991...

Код:

• Функции - Что может делать ваш аддон
• События - Что может запускать ваши функции
• Глобальные константы и их значения

GUI (графический интерфейс):

• UI XML - Язык разметки шаблонов интерфейса
• Controls - Добавляет в UI интерактивность

Упаковка:

• Формат объявлений (.txt) в аддоне - Как ESO находит ваш аддон

• FAQ по аддонам
• Учебник "Мой первый аддон"
• Как добавить слеш-команду

• Lua. Справка по языку (не относится к ESO)
• ESOUI.com: Загрузки / Форумы / Библиотеки для аддонов