Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 3.6 KB

README.md

File metadata and controls

82 lines (58 loc) · 3.6 KB
Raw

Open Vanilla

Open Vanilla is a compilation of multi-boxing software for EverQuest, nearly all based on MacroQuest with plugins and effort from the RedGuides community.

Not a gnome? ⚙️

The pre-built and supported version Very Vanilla🍦 is available for contributors and subscribers. If you're here to tinker, read on!

How To Build

Building Open Vanilla is the same as MacroQuest, the only difference is that you'll be using src/OpenVanilla.sln rather than src/MacroQuest.sln

Prererequisites

Check out the latest source code

Create the checkout. This will create the subfolder openvanilla that contains a copy of the project.

git clone https://github.com/RedGuides/openvanilla.git

Make sure that submodules are initialized. Move (cd) to the newly created openvanilla folder before executing this command. If you have run this step already, you can skip it

git submodule init

Update the submodules to the correct version. Ensure you are in the newly created openvanilla folder before executing this command.

git submodule update

Updating an existing checkout

MacroQuest is updated often, especially after a patch. Make sure before you build that you have the latest source code for MacroQuest and all of its dependencies.

If you already have the source, it is a good idea to make sure that you pull all the latest changes.

git pull --rebase

Update submodules. This ensures that dependencies have the latest code.

git submodule update

At this point, the source should be ready to compile. Proceed to building.

Build Steps

  1. Open the OpenVanilla.sln file in src.
  2. Select the Release configuration from the drop-down menu near the top of the window, and choose between Win32 and x64.
    1. If you're building for official servers, select x64
    2. If you're building for emulated servers, select Win32
  3. Select Build -> Build Solution from the menu.

The built files will be placed in build/bin/Release. To start MacroQuest, run MacroQuest.exe. This will launch the application to the tray, and install MacroQuest into any running EverQuest processes.

Adding Your Own Plugins

NOTE: If you have any custom plugins you want to build, put the sources for them in the plugins folder, for example: plugins/MQ2Foo/MQ2Foo.cpp. Do not put them in src/plugins - this path is reserved for the MacroQuest developers

To add any personal plugins to the solution:

  1. Right clicking the solution in solution explorer and clicking Add -> Add Existing Project....
  2. Select your .vcxproj file.
  3. Repeat as necessary

Directory Structure

Folder Name Purpose
build Build artifacts. This is where you can find the output when you compile MacroQuest and your plugins.
contrib Third-Party source code.
data Additional non-source code files used by MacroQuest.
extras Optional files that aren't required but may be useful. This includes sources for plugins that are no longer maintained.
include Public header files that are used for building MacroQuest and plugins.
plugins This folder is reserved for you to add your own personal plugins.
src The source code for MacroQuest and its core plugins.
tools Source code and additional tools that are used for MacroQuest development, but not part of the main project.