Plug-ins: Difference between revisions

Latest revision as of 01:13, 10 June 2024

Ever since the underlying Lua interface code was opened up to VO's player base, Vendetta Online features the possibility for users to write their own plug-ins, affecting everything from the game's interface to in-game communication to game mechanics.

Installing Plugins

Installation instructions vary by platform, but in general, installing plugins involves copying files from the archive you download to <game install directory>/plugins/. If a plugin is Neoloader-compatible, it may need to be enabled in-game as well, depending on the user's configuration.

Platform	Common install directory
Windows	C:\Program Files (x86)\Vendetta
Linux	/home/<user>/.vendetta
Mac	<special>
Android***	/android/data/com.guildsoftware.vendetta/files
iOS	<special>
VR	Depends on device; usually follows android but requires headset to be connected and explorable by connected PC.

Mac users will right click the vendetta app in the finder application and select the option "Show Package Contents".

iOS users need to attach their device to a computer running iTunes, and sync a plugins folder into the game.

Create a folder anywhere, name it "plugins", and add your plugins to it as if it were your game's plugin directory.
Connect your iOS device and open iTunes.
Open your device information and settings window (small button in top-left), then select the option "File Sharing"
Select Vendetta Online from the list of apps on the left
Click and drag your plugins folder onto the right side pane (select overwrite if prompted)

Android users need to use an updated file manager such as NMM or X-plore on versions 12 and below. For Android 13+, pilots will need to connect their device to a computer to access the /android/data directory. This is due to scoped storage permissions.

This youtube guide should provide visual aide for the process, and is only slightly out of date in regards to Android.

Creating your own Plugins

VO Lua API that can be used for creating plugins can be found at [1].

Available Plugins

This page tracks many well-known plugins found across the public repositories listed below. It is not meant to be an encompassing list, but serves to track some of the most popular plugins used by many pilots. If you are looking for the old list of many plugins, or wish to add your own, please visit the Free plugin list.

Public Plugin Repositories:

Vendetta Online Unofficial Plugin Repository (VOUPR) is the original plugin repository, originally maintained by Calder.
NexusMods hosts many mods for multiple games, and includes its own section for Vendetta Online.
mr_spuck has a comprehensive list of plugins on his own site, though many of them need to be updated or are completely defunct at this point

Name	Author	Where to get	Purpose
Neoloader	Luxen	VOUPR NexusMods	Advanced Plugin Loader and Library Management
MDI-Targetlist	Draugath	VOUPR	Advanced yet minimalist target display on your HUD with addon support
MDI-RoidDB	Draugath	VOUPR	Asteroid Database Manager and Mining Assistant
Prospector	Snib, PaKettle	VOUPR	Asteroid Database Manager and Mining Assistant
Reskin	Luxen	VOUPR NexusMods	Theme Management Interface
Turret Selection Interface	Slime	VOUPR	GUI for selecting turrets on capital vessels
Trade Assistant 2	Snib, Mad Miner Moda	VOUPR	Trade and Commerce Utility
Toaster Crush Suite	ScionSpy, Scuba Steve 4.0	VOUPR	Combat toolkit
Sound Alert Suite	Chocolateer	VOUPR	Auditory notifications for game events
DroidButtons	Draugath	VOUPR	Flight Interface Modifier - redesign your input interface on mobile!
Key Manager	Lanigiro Elbbarcs	VOUPR	Manage access keys for stations and capital vessels
Honk	Rin Ganberro	VOUPR	Make ships honk!

Plug-ins: Difference between revisions

Latest revision as of 01:13, 10 June 2024

Installing Plugins

Creating your own Plugins

Available Plugins

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

popular

editing

Tools

@@ Line 1: / Line 1: @@
-Ever since the underlying LUA interface code was opened up to VO's player base, Vendetta Online features the possibility for users to write their own plug-ins, affecting everything from the game's interface to in-game communication to some mechanics.
+Ever since the underlying Lua interface code was opened up to VO's player base, Vendetta Online features the possibility for users to write their own plug-ins, affecting everything from the game's interface to in-game communication to game mechanics.
-==AutoJett==
+== Installing Plugins ==
-'''Description:''' Automatic jettison of certain ores.
+Installation instructions vary by platform, but in general, installing plugins involves copying files from the archive you download to ''<game install directory>/plugins/''. If a plugin is Neoloader-compatible, it may need to be enabled in-game as well, depending on the user's configuration.
-'''Created by:''' slime73
+{| border="1" class="wikitable"
+|-
+! Platform
+! Common install directory
+|-
+! Windows
+| C:\Program Files (x86)\Vendetta
+|-
+! Linux
+| /home/<user>/.vendetta
+|-
+! Mac
+| <special>
+|-
+! Android***
+| /android/data/com.guildsoftware.vendetta/files
+|-
+! iOS
+| <special>
+|-
+! VR
+| Depends on device; usually follows android but requires headset to be connected and explorable by connected PC.
+|}
-'''CLI:'''
+Mac users will right click the vendetta app in the finder application and select the option "Show Package Contents".
-/autojett -- lists commands ingame.
+iOS users need to attach their device to a computer running iTunes, and sync a plugins folder into the game.
+* Create a folder anywhere, name it "plugins", and add your plugins to it as if it were your game's plugin directory.
+* Connect your iOS device and open iTunes.
+* Open your device information and settings window (small button in top-left), then select the option "File Sharing"
+* Select Vendetta Online from the list of apps on the left
+* Click and drag your plugins folder onto the right side pane (select overwrite if prompted)
-/autojett toggle -- toggles AutoJett on or off.
+Android users need to use an updated file manager such as NMM or X-plore on versions 12 and below. For Android 13+, pilots will need to connect their device to a computer to access the /android/data directory. This is due to scoped storage permissions.
-/autojett switch -- switches between jettisoning all ores, or just non-rare ores.
+[https://www.youtube.com/watch?v=4yrMn3niWTY This youtube guide] should provide visual aide for the process, and is only slightly out of date in regards to Android.
-/autojett list -- lists all ores which won't be jettisoned if AutoJett Switch is on.
+== Creating your own Plugins ==
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 AutoJett plug-in thread entry]
+VO Lua API that can be used for creating plugins can be found at [http://www.vo-wiki.com/racecar2].
-==BotScan==
+== Available Plugins ==
-'''Description:''' Aids players who are looking for Hive Queens or Leviathans by scanning the toplist for any ships that start with "*Hive Queen" or "*Leviathan", and then displaying any matches to the chatlog. Also scans the missionlist upon docking for any Hive Skirmish missions, and prints sectors that are likely to have Hive Queens or Leviathans to the chatlog.
+This page tracks many '''well-known''' plugins found across the public repositories listed below. It is not meant to be an encompassing list, but serves to track some of the most popular plugins used by many pilots. If you are looking for the old list of many plugins, or wish to add your own, please visit the [[Free plugin list]].
-'''Created by:''' MSKanaka
+Public Plugin Repositories:
+* [http://voupr.spenced.com Vendetta Online Unofficial Plugin Repository (VOUPR)] is the original plugin repository, originally maintained by Calder.
+* [https://www.nexusmods.com/vendettaonline?tab=latest NexusMods] hosts many mods for multiple games, and includes its own section for Vendetta Online.
+* [https://kitchen.nfshost.com/ven/plugins/ mr_spuck has a comprehensive list of plugins on his own site], though many of them need to be updated or are completely defunct at this point
-'''CLI:'''
+{| border="1" class="wikitable sortable"
+! Name
-/botscan [on|off] -- Master switch. If this is off, the plugin doesn't run.
+! Author
+! Where to get
-/botscan queen [on|off] -- Enables or disables checks for Hive Queens on sector entry.
+! Purpose
+|-
-/botscan levi [on|off] -- Enables or disables checks for Leviathans on sector entry.
+| Neoloader
+| Luxen
-/botscan mission [on|off] -- Enables or disables missionlist scanning. Turned off by default. Only turn this on if you don't mind your chatlog being spammed; if there are a lot of skirmish missions available at the station, it will print a line for every 'critical' and 'central' mission it sees. Independent of the queen and levi settings.
+| [https://voupr.spenced.com/plugin.php?name=neoloader VOUPR]
+[https://www.nexusmods.com/vendettaonline/mods/3 NexusMods]
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219482 BotScan plug-in thread entry]
+| Advanced Plugin Loader and Library Management
+|-
-'''In the pipe:'''
+| MDI-Targetlist
+| Draugath
-- Bugfixes (if any).
+| [https://voupr.spenced.com/plugin.php?name=mdi-targetlist VOUPR]
+| Advanced yet minimalist target display on your HUD with addon support
-- Less spammy missionlist checking. Fixed. Thanks Naut!
+|-
+| MDI-RoidDB
-==CargoFind==
+| Draugath
+| [https://voupr.spenced.com/plugin.php?name=mdi-roiddb VOUPR]
-'''Description:''' Find a specific cargo widget with a command.
+| Asteroid Database Manager and Mining Assistant
+|-
-'''Created by:''' Smittens
+| Prospector
+| Snib, PaKettle
-'''CLI:''' /cargofind "WHATEVER" --> Finds the first widget within range that has "WHATEVER" in its name
+| [https://voupr.spenced.com/plugin.php?name=prospector~snib VOUPR]
+| Asteroid Database Manager and Mining Assistant
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#221455 CargoFind plug-in thread entry]
+|-
+| Reskin
-==ChangeBackground==
+| Luxen
+| [https://voupr.spenced.com/plugin.php?name=reskin VOUPR]
-'''Description:''' Allows you to set the current sector's background to any background you wish (by inputting a sectorid), or a random background. Recommended: bind rdmbackground and changebg to keys. (clientside only)
+[https://www.nexusmods.com/vendettaonline/mods/4 NexusMods]
+| Theme Management Interface
-'''Created by:''' slime73
+|-
+| Turret Selection Interface
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 ChangeBackground plug-in thread entry]
+| Slime
+| [https://voupr.spenced.com/plugin.php?name=turretviewer VOUPR]
-==customHUD==
+| GUI for selecting turrets on capital vessels
+|-
-'''Description:''' Adds movable hud displays with target, weapon and self info. Can also be used to toggle elements of the normal HUD, optionally at the press of bound keys.
+| Trade Assistant 2
+| Snib, Mad Miner Moda
-'''Created by:''' maq
+| [https://voupr.spenced.com/plugin.php?name=tradeassist2 VOUPR]
+| Trade and Commerce Utility
-[[image:customHUD.jpg|left|thumb|customHUD]]{{br}}
+|-
+| Toaster Crush Suite
-'''CLI:'''
+| ScionSpy, Scuba Steve 4.0
+| [https://voupr.spenced.com/plugin.php?name=tcs_ VOUPR]
-/customhud - toggles it on/off
+| Combat toolkit
+|-
-/customhud config - shows config window (duh)
+| Sound Alert Suite
+| Chocolateer
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/18790 maq's plug-in thread]
+| [https://voupr.spenced.com/plugin.php?name=soundalertsuite VOUPR]
+| Auditory notifications for game events
-'''User comments:''' '' 'A small but drastic change. With my penchant for keeping only relevant combat information around my central HUD elements, customHUD is essential. Together with DistanceMeter, you've got yourself a HUD that actually aids you in combat, not hinders you.' '' - [[User:Ion|Ion]]
+|-
+| DroidButtons
-==DistanceMeter==
+| Draugath
+| [https://voupr.spenced.com/plugin.php?name=droidbuttons VOUPR]
-'''Description:''' Another very simple plugin, this one moves the Distance meter (and the sector alignment info) to the bottom of the HUD, like it was with the old Vendetta client. *** Broken slightly if used with the latest version of TargetLS ***
+| Flight Interface Modifier - redesign your input interface on mobile!
+|-
-'''Created by:''' slime73
+| Key Manager
+| Lanigiro Elbbarcs
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 DistanceMeter plug-in thread entry]
+| [https://voupr.spenced.com/plugin.php?name=keys VOUPR]
+| Manage access keys for stations and capital vessels
-'''User comments:''' '' 'A welcome change back to the old style. To my mind, the only information that should be near to the central crosshair is information that pertains to the battle between yourself and your current target, and DistanceMeter remedies one annoyance in this respect.' '' - [[User:Ion|Ion]]
+|-
+| Honk
-==FactionColor==
+| Rin Ganberro
+| [https://voupr.spenced.com/plugin.php?name=honk VOUPR]
-'''Description:''' Factions whose names are checked in the /factioncolor dialog will have their ship names coloured based on their default ship colour. For example, Xang Xi will be teal in the sectorlist and the TargetLS HUD list.
+| Make ships honk!
+|}
-'''Created by:''' slime73
-[[image:Factioncolor.jpg|left|thumb|FactionColor target list]]{{br}}
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489FactionColor plug-in thread entry]
-==FlashChange==
-'''Description:''' A very simple plugin that changes the red flash when you get hit to be less intense. It gets slightly brighter as your hull weakens.
-'''Created by:''' slime73
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 FlashChange plug-in thread entry]
-==GroupStat==
-'''Description:''' Broadcasts when you die and who killed you to your group.
-'''Created by:''' Drazed and Moda Messolus.
-'''CLI:''' /groupstat - Yields a sortable matrix of the information.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/17818 GroupStat forum thread]
-==Guild Notify==
-'''Description:''' Prints the names of players in your guild when they log on or off.
-'''Created by:''' slime73
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 Guild Notify plug-in thread entry]
-==Jett==
-'''Description:''' Jettisons items in your cargo hold in 1cu increments.
-'''Created by:''' slime73
-'''CLI:''' To use it, type '/Jett' ingame. It's set by default to jettison only a single crate of cargo when you do that, but you can configure it to jettison everything in your cargo hold (with a .5 second delay between every cargo crate jettisoned) by typing '/Jett toggle'. If you need help using the script ingame, type /jett help.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 Jett plug-in thread entry]
-==JumpSFX==
-'''Description:''' Enables the built-in (but normally unused) wormhole and sector jump sound effects.
-'''Created by:''' MSKanaka
-'''CLI:''' /jumpsfx [on|off] -- Turns the jump effects on or off.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219482 JumpSFX plug-in thread entry]
-'''Known Bugs:'''
-- VO soundtrack will not play due to the script's use of playmusic(); the function required for this does not work with these particular sound effects. Fixed.
-'''In the pipe:'''
-- Bugfixes (if any)
-- Option to allow the VO soundtrack to continue playing by auto-detecting which music file should be playing based on the player's location. Implemented via gksound.GKPlaySound().
-==Msg Beep==
-'''Description:''' With this plugin, whenever you receive a /msg you will hear the proximity warning sound.
-'''Created by:''' slime73
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 Msg Beep plug-in thread entry]
-==Navadd==
-'''Description:''': Allows the player to add sectors to their navroute by using sectorIDs instead of coordinates.
-'''Created by:''' MSKanaka
-'''CLI:''' /navadd [sID] -- adds the sector with the ID number of sID to your navroute.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219482 Navadd plug-in thread entry]
-'''In the pipe:''' Bugfixes (if any).
-==multiclick==
-'''Description:''' Double-click (or more) functionality for any button.
-'''Created by:''' maq
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/18790 maq's plug-in thread]
-==QuickPlot==
-'''Description:''' Plots a quick course to a specific sector.
-'''Created by:''' slime73
-'''CLI:''':
-/Jump ''sector'' -- sector can be a sector such as Sedina L2 or just the sector coordinates if you want to jump in-system, e.g. arta a1 and a1 will both go to Arta Caelestis A-1 if you are already in Arta.
-Bind jump_prompt to a key if you want it to prompt you for a sector when you press a key.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 QuickPlot plug-in thread entry]
-==racestats==
-'''Description:''' In-game viewer for Sedina Racetracks' times.
-'''Created by:''' maq
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/18790 maq's plug-in thread]
-==Really simple Navroute-reversing Lua Plugin==
-'''Description:''' Reverses navroutes.
-'''Created by:''' slime73
-'''CLI:''' Type "/ReverseNav" ingame.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 ReverseNav plug-in thread entry]
-==SetShipColor==
-'''Description:''' Lets the player set the color of ships that they purchase to match that of one of the ingame factions or guilds.
-'''Created by:''' MSKanaka
-'''CLI:'''
-/setshipcolor faction [factionname] -- Sets ship purchase color to match the given faction.
-/setshipcolor guild [guildacronym] -- Sets ship purchase color to match the given guild's color.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219482 SetShipColor plug-in thread entry]
-'''In the pipe:'''
-- Bugfixes (if any).
-- Adding/removing/fixing guild colors as requested.
-==StationSpin==
-'''Description:''' Causes the station the player is docked at to spin in the background. If the player is in a capship, nothing happens.
-'''Created by:''' MSKanaka
-'''CLI:''' /stationspin [on|off] -- Turns the spinning on or off.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219482 StationSpin plug-in thread entry]
-'''In the pipe:''' Bugfixes (if any).
-==TargetBinds==
-'''Description:''' A simple plugin which allows you to send your current target's information to either Guild or Group chat.
-Example:
-(guild) [Deneb B-12] <Omega 0> Current target: Hokanes Harolus, piloting a Serco SkyCommand Prometheus with 38% armour.
-'''Created by:''' slime73
-'''CLI:'''
-/grouptarget -- Sends your target's info to Group chat.
-/guildtarget -- Sends your target's info to Guild chat.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439#219489 TargetBinds plug-in thread entry]
-==TargetLess 1.60==
-'''Description:''' Advanced targetting plugin for Vendetta-Online. Provides a HUD display with multi-target details, and lets you quickselect targets (player/npc/asteroids) with key binds.
-'''Created by:''' drazed
-[[image:tlsbomber.jpg|left|thumb|TargetLess HUD]]{{br}}
-'''CLI:'''
-/targetls config --> Some settings and # key bind setup
-/targetls credits --> My contact info and credits to those who helped.
-'''Additional information & download:''' [http://trac.targetless.com/ TargetLess trac site].
-'''User comments:''' '' 'I longed for this functionality for a year (but was apparently never smart enough to actually request it). Suddenly, as if by magic (or possibly industrial espionage) there was a plug-in which did all I had dreamt of, and today, I consider it the single most important addition available  to VO's HUD. An enormous aid in large battles.' '' - [[User:Ion|Ion]]
-==tempsafety==
-'''Description:''' Will automatically turn off mining beams if temperature exceeds preset value
-'''Created by:''' maq
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/18790 maq's plug-in thread]
-==ToasterCrush Plugin Suite==
-'''Description:''' A collection of mostly-combat use plugins, configurable through a GUI panel accessible from the options menu, as well as a modular framework for future plug-in development.
-'''Created by:''' Scuba Steve 9.0
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/19129 TCS forum thread]
-'''User comments:''' '' 'One of the absolute essential plug-in packages for any kind of plugged-in and modular VO fun. Download it, and go Make Friendsâ„¢' '' - [[User:Ion|Ion]]
-==TradeAssistant v.03==
-Descriptions: Keeps up with stations you visit and can show you the most profitable items between them.
-'''Created by:''' Vorgas
-'''CLI:''' Get help with /help or /ta.help.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/1/17439?page=2#231716 TradeAssistant plug-in thread entry]
-==vzoom==
-'''Description:''' Eldrad's [[Variable_zoom_bind|Variable Zoom]] alias made into a plug-in (mostly for ease of installation, there's no new functionality).
-'''Created by:''' Script by Eldrad, enhanced by Roguelazer, turned into a pug-in by maq.
-'''Additional information & download:''' [http://www.vendetta-online.com/x/msgboard/9/18790 maq's plug-in thread]