Jump to content

Instaling Lua Add-Ons on PSOBB - Guide


Recommended Posts

This guide will teach you step by step how to install Lua Add-Ons on your PSOBB.


What Are Lua Add-Ons?

Lua Add-Ons are scripts that can read arbitrary memory from PSOBB and present it in a 'readable way'. It allows players to read information about monster dropped items, their inventory without highlighting the menu, read banks without going to the Bank Lady, monsters Health Points, player coordinates, how much time until next mag feeding is available and much more.


Is there any risk I could be banned by using those Add-Ons? Are they considered cheating?

Lua Add-ons can only read game memory, so it doesn't have enough control to hack the game in any way. All of the currently released Add-Ons are considered safe to use on Ultima server, usage of them are not considered cheating!


1. Requirements

You must have Microsoft Visual C++ Redistributable for Visual Studio 2015 installed, accordingly to the version of your Windows.

Download here.

Choose the x86 version of package.


2. Installing Eidolon's Add-Ons Plugin

Download Soly's PSOBB Addon Plugin here (bbmod.zip)

The original Eidolon's version can be found here (bbmod.zip). Outdated, does not work with some addons 

Note: Soly's version includes changes to support the global theme editor and the timer addon.
These changes will (hopefully) eventually be merged into Eidolon's main repository but until then, they are available with Soly’s version.

Open bbmod.zip, extract the folder addons and the file dinput8.dll into your PSOBB folder. It should look like this now.


Both things mentioned must be placed in the Ultima PSOBB directory. This is what enables the Lua Add-Ons to run through PSOBB.

You can run PSOBB to check if everything was installed correctly. If you see a menu like the one seen in the picture below, well, congratulations! The first step is done, you installed the Add-On. Now you can proceed to the next step, which will explain how to install the useful add-ons that will enhance your gameplay experience ;) 


If your game is crashing right after launching, make sure you installed the correct version of Microsoft Visual C++ Redistributable for Visual Studio 2015.


3. Installing Add-Ons

Download Soly's PSOBB Addons Here.

Extract every directory into the newly installed addons folder in your PSOBB directory (you can ignore files like .gitignore, LICENSE and README)

Note: All addons are installed more or less in the same way, but some might require a custom version of dinput8.dll, in such cases, it will be noted. This might cause conflicts if multiple dinput8.dll versions are created for different addons so until they are merged into the main version of the dll, you will have to choose the one that fits better for the addons you want to use.

Your addons folder should look like this:



If you have placed every folder in the right addons directory, you should now have 4 windows inside the game client itself, they are Main, Monsters, Player Reader, and Character Reader. When you run PSOBB with add-ons for the first time, you may want to resize and reposition them using mouse cursor. Drag title bars to your preferred place, resize add-ons by clicking and dragging the tiny white triangle located on bottom right corner of each window. If you close Main Menu accidentally, press ~ (tilde) to reopen the Main Menu.




4. A little introduction to Character Reader add-on

One of the biggest attractions of Add-On plugins is undoubtedly the Character Reader. Using it, you can read your inventory, bank (both Common and Character banks, depending on the last loaded bank when talking to Bank Lady NPC) and floor (dropped items on the area you're in). You can also check your inventory mags only, mostly used for feeding purposes.


(Credits to ★AGGREBEE★ for the gif)

It is possible to save a list of the current loaded items by clicking on Save to File button. The list will be saved at addons/Item Reader/inventory/date_saved_inventory.txt.



5. Other add-ons

Soly's PSOBB Addons

  • Theme Editor - Global theme editor, changes the style of all the windows of the plugin, currently it requires Soly’s version of dinput8.dll.
  • Item Reader - Allows items present on inventory banks and floors to be read.
  • Monster Reader - Shows each monster specific HP and displays a HP bar in an ordered list.
  • Player Reader - Shows the Health points, current Shifta/Deband/Jellen/Zalure level and Invincibility trigger timers for each player present in the party specific lobby players.
  • Timer - Timer and Stopwatch, the stopwatch has a split function, all actions can be performed with hotkeys (customizable in the addon options). This addon requires Soly’s version of dinput8.dll.

Esc's Chat Log Addon

Shows the chatlog in a separated window from default PSOBB Chatlog Menu.

Staphen's Kill Counter Addon

Tracks statistics on number of enemies defeated in PSOBB. Can be customized to show how many times a specific monster has been killed.

Tornupgaming's EXP Bar Addon

Adds an experience bar displaying the ammount of Experience needed for the next level up. Can be resized and combined with some custom HUDs like Echelon's ones.

Seth's Coordinate Viewer Addon

Displays player's x, y and z coordinates.


6. Other interesting features and troubleshooting

a. Some add-ons are crashing randomly/while exiting game

While Exiting Game (logging out) from the PSOBB Menu, there is a probability some of the add-on tools are gonna crash (and perhaps even the Main Menu). To fix this, open the Main Menu (if it was shut down, press ~ (tilde) to reload it) and click on the Reload button to re-enable all add-on windows that were closed upon logging out.

Note: If you want to help the developer of the addon, you can open the log first and take note of any output on it related to the addons that crashed and post them in the topic.


b. Changing and saving add-on windows positioning. One or more add-on windows positions were saved and got stuck in a border/corner.

Open the Main Menu, click on the button corresponding to the add-on you wish to change settings, make sure the Enable option is checked in General section. Check the following ► contractions to change a few options, you will find a Position and Size settings to mess with. You can use one of the anchoring presets or alternatively specify an exact X and Y position you want the add-on window to load (accordingly to the current resolution of your PSOBB window)

If your anchoring is not Default, the X and Y act as offsets from the anchoring position

You can also specify the Width and Height of the corresponding add-on window or set the window to auto resize (if available), which will make the window as small as possible.

Make sure the Enable option is checked on the corresponding add-on.


c. Changing other options

Some addons offer the options to customize the windows even further.
While on the Main Menu, click on the button corresponding to the add-on you wish to change settings. You will find the following options:

No title bar: Hides the colored title bar present on the top border of add-on window.

No resize: Prevents the resizing of the window from the bottom right corner, if available, you can change the window size from the Position and Size Width and Height options.

No move: Prevents windows from being dragged, if available, you can change the window size from the Position and Size Anchor, X and Y options.

Always auto resize: Makes the windows resize to fit their content.

Transparent window: Removes the window’s background color.


Title bar labels




Eidolon - for making the PSOBB Addon Plugin
Saber+7 - for collaborating with ideas for this guide and grammar reviewing.
Soly - for collaborating with ideas and pictures for this guide, his Character Reader Addon and continuously making numerous tools for the add-on and PSOBB.
★AGGREBEE★ - for writing a really good introduction guide for Add-ons on Ephinea which inspired to re-use some ideas, a very cool animation and to make my own guide.

And all other add-on developers.

If you have any issues or bugs with an add-on plugin itself presenting unexpected behaviors, make sure to check out Eidolon's original thread and maybe report about your issue. Bugs related to the tools, don't be afraid to contact the responsible authors.

  • Like 19
  • Thanks 6
Link to comment
Share on other sites

I was already going to do that, and also moving to Guide forum section.

  • Like 1
Link to comment
Share on other sites

This is a good guide.  Can I recommend linking to the github repositories instead of the the .zip files?  This will remove the necessity for you to update the guide with every new version.

  • Like 2
Link to comment
Share on other sites

I setup my repo so I can have a symbolic link to the addon's directories in all my instances of pso.

This means I can work on the addons without having to copy them to the repo folder to upload to github.
This also means downloading and dropping the contents of the zip file into your addons folders work right away as well.

The only thing that would have to get updated (so is better if you link to .../latest) is the DLL.

  • Like 1
Link to comment
Share on other sites

  • 4 months later...
On 7/4/2019 at 3:04 PM, Apostolos said:

after setting up LUA, for some reason, it wont let me type for chat anymore. if I hit space, the indicator to be able to type pops up, but I cant get it to actually type anything. any advice?

Strange, typing in game and Add-ons are not related in any form as far as I know.

Are you sure this option is disabled? If it is active, it will prevent you from typing in game if you don't have the propper keyboard setup. 

To access it, open your Launcher and go to Options menu.

Edited by Noob Saibot
Link to comment
Share on other sites

  • 5 months later...
  • 4 weeks later...

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Create New...