Terms and Nomenclature - Wynntils/Wynntils GitHub Wiki

Some words are used in Wynntils with a very specialized meaning. Most of them map to corresponding terms in Wynncraft (e.g. "Quest", "Potion", "Ingredient"), but in some cases a suitable term was missing in Wynncraft, or we needed terms to describe the inner workings of Wynntils. This list assumes you are familiar with the normal terms used in Wynncraft, and will only list these terms if some clarification is needed.

Please try to stick to these words when talking about these concepts, and conversely, try to avoid using these words if talking about something else.

  • Accessor - An Accessor is a minimal Mixin that just provides access to an otherwise non-reachable vanilla field.

  • ActionBar - Refers to the vanilla GUI text element set by GameInfo updates.

  • Activity - An Activity is the name we've given to the kind of stuff that appears in the Wynncraft "Content Book". In user fronting text, it could be referred to as a "Content Book Activity", to make the connection to the Content Book clear. Examples of activities are quests, caves, dungeons and raids, but also the various discoveries.

  • Annotator - An Annotator is responsible for taking in an Item (in the form of an ItemStack), and parsing this to generate a WynnItem that encapsulates the relevant Wynncraft aspects of this item.

  • Athena - The internal name of our server that provides Wynntils account login, personalized cosmetics and other functionality.

  • Character - The term Character applies to the current player, his/her class, location in the world, current health and mana, etc. Do not confuse this with the term Player, which refers to all other vanilla player entities.

  • CharacterStat - CharacterStats refer to these aspect of a player's Character that can be expressed as a set of (type, value) pairs.

  • Command - Adds a client-side Minecraft chat command.

  • Component - A core building block of Wynntils. It could be any of a Handler, Manager, Model or Service.

  • Config - Config is a Persisted (see this) annotation that will make a field persistent over restarts. Fields annotated with @Config will show up in the Settings GUI, where they can be modified by the user.

  • Consumer - Consumers uses our Components to provide actual gameplay benefits to the users. They make up the user-visible part of the mod, and consists of Commands, Features, Functions, Overlays and Screens.

  • Container - A Container is any vanilla GUI that shows a container interface. Containers in Wynncraft can be either pure GUIs (like the various Trade Market Containers), or a "real" container (such as a loot chest).

  • CustomBar - A CustomBar (or CustomBarOverlay) is a fully customizable progress bar Overlay, in contrast to the GameBarOverlays which are more or less hard-coded by Wynntils.

  • Embellishment - (for Features) Functionality that provides just cosmetic flair.

  • Event - A subtype of the NeoForged bus Event class, which is used primarily to communicate between mixins and the rest of the mod, but also sometimes from Components such as Models or Managers.

  • Extension - A Mixin Extension is an interface that is used when enhancing a vanilla class with additional Wynntils functionality.

  • Feature - A single, modular feature that Wynntils provides that can be enabled or disabled.

  • Function - A class implementing functions that can be used in e.g. overlays.

  • GameItem - A GameItem is a WynnItem which represent an item you can interact with in Wynncraft, and store in your inventory or bank (cf. GuiItem).

  • Gear - Gear refers to a subset of WynnItems that can be worn (armor) or wielded (weapons) by the player. A build consists of a full combination of Gear.

  • Guide - Guides are Wynntils way of presenting all known Wynncraft items of a certain kind.

  • GuiItem - A GuiItem is a high-level representation of certain Container GUIs, which you cannot take out from the GUI, e.g. the items representing individual servers in the lobby compass menu (cf. GameItem).

  • Hades - The internal name of our server that tracks the location of other players that have opted to share their location.

  • Handler - Handlers span the bridge between Minecraft and Wynncraft. They manage a certain aspect of Minecraft functionality, and with some Wynncraft knowledge, they distribute the MC content to the actual Wynncraft models. A handler is needed when there is not a clear 1-to-1 relationship between Minecraft components and models.

  • InfoBox - An InfoBox (or InfoBoxOverlay) is a fully customizable Overlay that can display a text, with Function evaluation.

  • Ingredient - Ingredients are, next to Gear, one of the major open sets of WynnItems.

  • Item - An Item just refers to the vanilla core item functionality, typically represented by an ItemStack in the code (cf. WynnItem).

  • ItemEncoding - The term ItemEncoding refers to the specialized way we can encode relevant information about a WynnItem into a string that can be e.g. sent in the chat.

  • ItemRecord - A method for storing information of certain WynnItems in your possession.

  • KeyBind - Binding a specific key press to Wynntils functionality, with the key visible in Vanilla key settings.

  • Label - A Label is a text display, like a name tag, that appears in the Wyncraft world.

  • Location - An (x, y, z) triple, with integer terms, typically used to describe a block coordinate (cf. Position).

  • LootrunPath - A path through the world as recorded in Wynntils. Do not confuse this with the Wynncraft Lootrun mechanics.

  • Manager - Managers constitute the core functionality of Wynntils. They provide the framework of the entire mod, but does not have any knowledge about Wynncraft specific details nor any specialized services.

  • MapArea - A MapFeature providing an area, that is a polygon.

  • MapAttributes - Aspects of a MapFeature that affect how it is represented on the map, such as name, icon or visibility at different zoom levels.

  • MapCategory - A systematic way to allow MapFeatures to inherit MapAttributes, based on a namespace, with names such as wynntils:service:merchant:tool.

  • MapData - A systematic way to represent all information that is relevant to display on a map. (As of the time of writing, this is not yet in use.)

  • MapFeature - A MapLocation, MapPath or MapArea, belonging to a MapCategory providing MapAttributes.

  • MapLocation - A MapFeature providing a single, specific Location (see this).

  • MapPath - A MapFeature providing a path, that is a line segment (cf. LootrunPath).

  • Mixin - A Mixin will be injected into a vanilla class to override or extend functionality. Mixins should normally send an event in response to the code reaching an injection point.

  • Model - Models are our representation of the Wynncraft world, game state and Wynncraft metadata. In general, any non-trivial interesting aspect of Wynncraft that is provided through vanilla Minecraft elements, should be parsed and provided by a Model.

  • Notification - A short message, channeled through the NotificationManager, and typically displayed in the Notification overlay for a brief moment.

  • NpcDialogue - NpcDialogue (or sometimes just Dialogue) refers to the messages sent in chat by Wynncraft that constitutes part of the players communication with NPCs, or sometimes just general descriptive messages ("You can feel the ground shaking").

  • Overlay - A GUI element that can be put on top of the normal vanilla gameplay screen.

  • Persisted - Persisted is the top-level interface for our Config and Storage types. Fields marked with a Persisted annotation will have their value stored on disk, and reloaded at startup.

  • Position - An (x, y, z) triple, with real-valued (non-integer) terms, typically used to describe the whereabouts of an entity (cf. Location).

  • Property - A Java system property of the form -Dwynntils.<ownerManagerName>.<propertyPath>, used for more esoteric tweaking or debugging.

  • Redirect - (for Features) Functionality that converts chat messages to Notifications.

  • ScoreboardSegment - Wynncraft uses the vanilla scoreboard system to display relevant information in chunks, e.g. the next step of the current quest. Each such chunk is a ScoreboardSegment.

  • Screen - A GUI screen that hides the normal vanilla gameplay screen.

  • Service - Services provide support to consumers for anything that is not specifically related to the Wynncraft model, either since it is an external service (3rd party library, or system/environment interaction), or since it is something that we augment the Wynncraft world with, but the Wynncraft servers has no knowledge about. In other words, this is a "misc" category, where everything consumers need that is neither a manager, handler or manager can be placed.

  • Social - A common name to refers to the three kinds player groups supported in Wynncraft (Friends, Parties and Guilds).

  • Splash - The funny or profound line of text that is showed randomly on the Wynntils main screen.

  • Stat - Stats are aspect on WynnItems, as (type, value) pairs. Confusingly, Stats are often referred to as "identifications" in the Wynntils gaming community, but we avoid that term in Wynntils.

  • Statistics - Collected data about the Wynncraft gameplay that is administered by the StatisticsService.

  • StatusEffect - Effects that are currently applied to the player. StatusEffects have a name, a modifier and a remaining time.

  • Storage - Storage is a Persisted (see this) annotation that will make a field persistent over restarts. Fields annotated with @Storage will not show up in the Settings GUI, and are not supposed to be modified by the user. Instead, this is used for Wynntils to keep track of essential data.

  • StyledText - The Wynntils internal representation of formatted Minecraft strings. It should be used instead of the vanilla Component in all internal Wynntils usage, since it has a more stable and reliable API for our needs.

  • Token - A Token is a special item that are sometimes needed to make progress in e.g. quests and dungeons, and that is tracked by Wynntils.

  • Transcription - A method to convert from one writing system to another, particularly from the Wynnic or Gavellian alphabets.

  • Translation - A way to translate the English texts to other natural languages (cf. Transcription).

  • Upfixer - An Upfixer is a class responsible for converting Persisted data from an older form to a newer one. Whenever the on-disk format changes for a Config or Storage, a corresponding Upfixer is needed to convert the user's data in the most compatible way.

  • UrlId - All specific URLs that point to resources that Wynntils need will have an UrlId assigned. These are read from a special file tha can be easily updated, in case these URLs needs to be changed.

  • WynnItem - A WynnItem is a representation of the aspects of an in-game item that is relevant for gameplay, e.g. a weapon with its various stats. A WynnItem does not per se know anything about the underlying ItemStack that is used to represent it (cf. Item, GameItem, GuiItem). WynnItems consists of two large and open sets: Gear and Ingredients, and several smaller and closed sets such as Materials, Potions, Powders, etc.