Skip to content

Latest commit

 

History

History
117 lines (73 loc) · 3.34 KB

README.md

File metadata and controls

117 lines (73 loc) · 3.34 KB

Generate DRY modular overviews.

Release GitHub Actions

Don't die on patch day because you missed adding that new ship-type to one of your presets!

Description

Overview Pack

An exhaustive and customizable overview pack: download from the main site. For questions, submit a new GitHub issue.

I only update this pack when I'm actively playing EVE. If you would like me to release an update, please submit an issue.

Generator

Open in GitHub Codespaces

The EVE Online Overview Generator facilitates creating and maintaining overview packs.

Essentially, you define a common set of LEGO bricks and build your overviews with them.

First, create overviews out of game by editing a set of YAML files. Then, generate importable overview files by running the included Ruby script.

Rather than a single YAML file per overview, the various overview settings are split into many files which can be reused to create custom overviews based on a set of common groups, presets, settings, etc. The modular design makes updating, sharing, and customizing simple.

Visit the project site for full documentation.

Donate ISK

Installation

Download the pre-built overview YAML files under releases and import them into the EVE client (resetting the overview first is recommended).

Alternatively, clone or fork this project and build your own overviews.

Requirements

Ruby ≥ 2 with Bundler.

Usage

Install the required gems with

$ bundle

Build the overview files to the Overview directory with

$ rake

Development and Testing

Source Code

The source for EVE Online Overview Generator is hosted on GitHub. To clone the project run

$ git clone https://github.com/razor-x/eve-overview.git

Releasing a new version

$ bundle exec bump minor
$ git tag v1.2.3
$ git push --follow-tags

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

  1. Fork it (https://github.com/razor-x/eve-overview/fork).
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create a new Pull Request.

License

EVE Online Overview Generator is licensed under the MIT license.

All Eve Related Materials © CCP hf. All rights reserved. Used with permission.

Warranty

This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.