These instructions are for installing only Ignition Plugin. If you're interested in using all the Ignition libraries, check out this Ignition installation.
We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible.
The Source Installation instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.
Ubuntu
Prerequisites
Ignition Plugin version 1 requires Ubuntu Bionic, while version 0 can be used with Ubuntu Xenial.
If you don't already have the lsb-release
package installed, please do so now:
Setup your computer to accept software from packages.osrfoundation.org:
Setup keys:
Binary Installation
On Ubuntu systems, apt-get
can be used to install ignition-plugin
:
Source Installation
- Install required Ignition dependencies sudo apt-get install libignition-cmake2-dev
- Install Ignition Tools if you want to use the
ign plugin
command line tool:bash git clone https://github.com/ignitionrobotics/ign-pluginsudo apt-get install ignition-tools2. Clone the repositorybash cd ign-plugin mkdir build cd build cmake .. make3. Configure and buildbash sudo make install4. Optionally, installbash ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"# macOS## PrerequisitesIgnition Plugin and several of its dependencies can be installed on macOSwith [Homebrew](http://brew.sh/) using the [osrf/simulationtap](https://github.com/osrf/homebrew-simulation). Ignition Plugin version 1requires macOS High Sierra (10.13) or later, while version 0 supportsSierra (10.12) or later.## Binary Installation1. Install Homebrew, which should also prompt you to install the XCode command-line toolsbash brew tap osrf/simulation brew install ignition-plugin12. Run the following commandsbash brew tap osrf/simulation brew install ignition-plugin1 –only-dependencies## Source Installation1. Install dependenciesbash git clone https://github.com/ignitionrobotics/ign-plugin2. Clone the repositorybash cd ign-plugin mkdir build cd build cmake .. make3. Configure and buildbash sudo make install4. Optionally, installbash conda create -n ign-ws conda activate ign-ws# Windows## PrerequisitesFirst, follow the [ign-cmake](https://github.com/ignitionrobotics/ign-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment.Navigate to `condabin` if necessary to use the `conda` command (i.e., if Conda is not in your `PATH` environment variable. You can find the location of `condabin` in Anaconda Prompt, `where conda`).Create if necessary, and activate a Conda environment:bash conda install libignition-plugin<#> –channel conda-forge## Binary Installationbash conda search libignition-plugin* –channel conda-forge –infoBe sure to replace `<#>` with a number value, such as 2 or 3, depending onwhich version you need.## Source InstallationThis assumes you have created and activated a Conda environment while installing the Prerequisites.1. Install Ignition dependencies:You can view available versions and their dependencies:bash conda install libignition-cmake<#> –channel conda-forgeInstall dependencies, replacing `<#>` with the desired version:bash2. Navigate to where you would like to build the library, and clone the repository.
Optionally, append <tt>-b ign-plugin#</tt> (replace # with a number) to check out a specific version
git clone https://github.com/ignitionrobotics/ign-plugin
bash cd ign-plugin mkdir build cd build cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install cmake –build . –config Release
bash cmake –install . –config Release
bash sudo apt-get install doxygen
bash git clone https://github.com/ignitionrobotics/ign-plugin
bash cd ign-plugin mkdir build cd build cmake .. make doc
bash firefox doxygen/html/index.html
bash make test
bash cmake .. -DBUILD_TESTING=false
bash sudo apt-get install lcov
bash cd build/ cmake .. -DCMAKE_BUILD_TYPE=coverage make
bash make test
bash make coverage
bash firefox coverage/index.html ```