FrontiersForge

A framework for managing custom UI elements and accessing game data from EverQuest Online Adventures Frontiers (EQOA) on the PCSX2 emulator.

Overview

FrontiersForge is a Lua-based API designed to help developers create custom UI addons and access game data from EverQuest Online Adventures Frontiers as run on the Sandstorm Server using the PCSX2 emulator. This project piggybacks off the UiForge project, providing an easy way to interact with the game's internal structures and display that data via custom UI elements powered by ImGui.

Note: This is in a "pre-alpha" state. The implementation will likely change regularly. Expect large breaking changes to any mods created using these modules.

⚠️ WARNING:

Use this code at your own risk. UiForge injects code into the PCSX2 emulator and grants access to the game’s memory. Only place trusted scripts in the scripts and scripts/modules directory.

Requirements

• PCSX2: Tested on 64-bit versions of PCSX2 v2.0.2 and v2.2.0, running on Windows 11. Other versions may work, but they haven't been tested. This will almost certainly crash 32-bit version of PCSX2 (for now...).
• DirectX 11: Currently UiForge only supports DirectX 11, so be sure PCSX2 is using that for rendering.
• Windows OS: This definitely works on Windows 11 64-bit. I imagine it would also work on Windows 10 and maybe Windows 7.
• EQOA: Frontiers (US Version): This has only been tested on the US version of EverQuest Online Adventures: Frontiers.

Setup and Running

1. Clone the repository:

   git clone --recurse-submodules https://github.com/mmvest/FrontiersForge.git
   cd FrontiersForge

   If you already cloned without submodules, run:

   git submodule update --init --recursive

   Note: UiForge is included as a git submodule and built binaries (like uiforge_core.dll) are no longer distributed directly with the repo. Use the release zip files or build locally.

2. Make sure you have PCSX2 v2.0.0 or greater and EQOA: Frontiers (US Version) ISO.

3. Place your UI Lua scripts (dubbed ForgeScripts by the UiForge Project) in the scripts directory.

4. Run pcsx2-qt.exe, start EQOA, and then execute StartFrontiersForge.bat.

Once started, the UiForge settings icon should appear in the top-left corner. Click on it to see the UiForge menu. Click the settings icon again to close the UiForge menu.

To detach UiForge from the process and clean it up, press Ctrl+Shift+Alt+End (PCSX2 must be the focused window for the eject hotkey to work).

To enable a script, click the checkbox next to it. Scripts that create Lua Errors are disabled automatically.

To see script settings or debug stats, click on the script name. If it has any settings, the settings will appear in the settings tab. Debug stats can be viewed by clicking the debug tab.

Building (from source)

BuildFrontiersForge.bat builds the UiForge submodule and then updates this repo’s scripts/ by copying the latest scripts from UiForge/scripts into scripts/ (overwriting old versions).

1. Ensure you can build UiForge (see the UiForge repo for the requirements).
2. Run:

   BuildFrontiersForge.bat

To create a release zip:

BuildFrontiersForge.bat -zip -version 1.2.3

This writes releases/FrontiersForge-v1.2.3.zip.

Roadmap

• Current Work:

  • Finish Modules:
    • Ability bar module
    • Toolbelt module
    • Ability list module (accessing the abilities in your Abilities menu)

• Future Plans:

  • Inventory module for accessing inventory items
  • Developing a community-driven wiki for sharing findings and collaborating on reverse-engineering the game’s data structures.
  • Expand on the current modules
    • e.g. Reversing camera functionality to enable customization of its anchor point and unlock vertical movement.

Modules

frontiers_forge\camera.lua

Handles camera functionality, including retrieving the camera's current coordinates (x, y, z).

frontiers_forge\entity.lua

Manages in-game entities and allows you to fetch data like health, coordinates, and names of entities within the game.

frontiers_forge\input.lua

Provides access to controller input, including button states and analog stick movement.

frontiers_forge\player.lua

Exposes player-specific data, such as name, level, stats (strength, dexterity, etc.), health, and power.

frontiers_forge\ui.lua

Enables toggling of various UI elements such as the ability bar, chat window, health bar, etc.

frontiers_forge\util.lua

Includes utility functions for interacting with the game’s memory, converting strings, and calculating experience requirements.

imgui\imgui.lua

This is just a "meta" file to help enable intellisense and static analysis functionality for your code editor with regards to the imgui functions definitions that are made accessible through the uiforge_core.dll. DO NOT Require THIS IN YOUR SCRIPTS. That will break your Lua environment.

License

This project is licensed under the MIT License. See the LICENSE.txt file for more details.

Contributing

Contributions are welcome! If you want to help improve the project, open an issue or submit a pull request. Feel free to suggest features or report bugs.