Skip to content

Building & Installation

Jump to bottom Edit New page
Mathieu Guindon edited this page Sep 27, 2015 · 6 revisions

The easiest way to use Rubberduck is to download the latest installer from our releases page. If you want to contribute to the project, however, you will need to take a few steps to ensure a successful build.

If you don't have the full office suite, you may need to download and install the Microsoft Office Primary Interop Assemblies(PIAs).

Rubberduck is a COM Add-In, so it needs to be registered with the VBA Editor.

For 32-bit Office, you need to create this registry key:

HKCU/Software/Microsoft/VBA/VBE/6.0/Addins/Rubberduck.Extension

For 64-bit Office, you need to create the same key, albeit under the Addins64 key instead:

HKCU/Software/Microsoft/VBA/VBE/6.0/Addins64/Rubberduck.Extension

Here are the values to create for that key:

  • Description (string value): Rubberduck VBE Add-in
  • FriendlyName (string value): Rubberduck
  • CommandLineSafe (DWORD): 0
  • LoadBehavior (DWORD): 3

In order to be configurable, you will also need to create a Rubberduck directory in your roaming profile, and copy the default configuration file (rubberduck.config) from the resources directory into that new directory. Note that if you use the installer, this directory and file are installed along with the add-in.

C:\Users\[username]\AppData\Roaming\Rubberduck\rubberduck.config

##System Requirements

  • Windows Vista, 7, or 8
  • .Net Framework 4.5
  • Microsoft Office 2007 or higher

###Building the Parser

When changes are made to the VBA.g4 grammar, the following steps should be taken:

  • Amend the "Change log" section (add a bullet to the "v1.4 Rubberduck" section)
  • Save changes
  • (turn off ReSharper solution-wide analysis)
  • Delete the following generated files under Rubberduck.Parsing.Grammar:
    • VBABaseListener.cs
    • VBABaseVisitor.cs
    • VBALexer.cs
    • VBAListener.cs
    • VBAParser.cs
    • VBAVisitor.cs
  • (toggle 'Show all files' in VS Solution Explorer)
  • Delete the following generated files under Rubberduck.Parsing.obj if they exist:
    • VBABaseListener.cs
    • VBABaseVisitor.cs
    • VBALexer.cs
    • VBAListener.cs
    • VBAParser.cs
    • VBAVisitor.cs
    • VBA.tokens
    • VBALexer.tokens
  • Set 'Build Action' of VBA.g4 grammar file to "Antlr4"
  • Right-click the grammar file and select 'Run custom tool'
  • Copy the following generated files from Rubberduck.Parsing.obj to Rubberduck.Parsing.Grammar:
    • VBABaseListener.cs
    • VBABaseVisitor.cs
    • VBALexer.cs
    • VBAListener.cs
    • VBAParser.cs
    • VBAVisitor.cs
  • Set 'Build Action' of VBA.g4 grammar file to "None"
  • (turn ReSharper solution-wide analysis back on)

Twitter @rubberduckvba

  • Meta meta meta
Clone this wiki locally