aineko-m/ivee-core

PHP engine for calculations of EVE Online industrial activities and CREST library

iveeCore

a PHP engine for calculations of EVE Online industrial activities and CREST library, _(*1)

Copyright (C)2013-2016 by Aineko Macx. All rights reserved., _(*2)

License

Unless otherwise noted, all files in this distribution are released under the LGPL v3. See the file LICENSE included with the distribution., _(*3)

Purpose and target audience

The goal of this project is to provide its users with a simple but powerful API to calculate industrial activities in EVE Online and get data such as bill of materials, activity costs and profits or skill requirements. iveeCore helps developers to quickly prototype their own scripts or develop full blown (web) applications without having to directly deal with the complexities and quirks of EvE's Static Data Export and CREST API., _(*4)

iveeCore will likely be most useful for developers with at least basic PHP knowledge creating their own industry related or CREST powered tools., _(*5)

These are a few example questions that can be answered with a few lines of code using iveeCore: - "What is the profit of buying this item in Jita and selling in Dodixie?" - "What do these items reprocess to? And what is it's volume sell value in Jita?" - "How much does this EFT fit cost? How much is this scanned cargo worth?" - "What is the job cost for building this item in this system? And if built in a POS in low sec?" - "What is the total bill of materials and the minimum required skills to build these Jump Freighters?" - "Is it more profitable to build the components myself or buy off the market?" - "What is the total profit for copying this Blueprint, inventing with it, building from the resulting T2 BPC and selling the result?" - "How do different Decryptors affect ISK/hour?" - "How do Blueprint ME levels impact capital ship manufacturing profits?" - "How much is a month of Unrefined Ferrofluid Reaction worth?", _(*6)

The iveeCrest portion of the engine allows you to do things like: - Access CREST endpoints for universe data (regions, constellations, systems, planets), inventory (types, groups, categories), live market data (orders and history), alliances, sovereignty, wars & killmails, alliance tournaments and industry related data. - Read and write to the private character endpoints for fittings, contacts and navigation., _(*7)

Technical features

• An API that strives to be "good", with high power-to-weight ratio
• Strong object oriented design and class model for inventory types
• Classes for representing manufacturing, copying, T2 & T3 invention, research and reaction activities, with recursive component building
• Realistic price estimation (based on CREST market order data), profit calculation & DB persistence
• Parsers for EFT-style and EvE XML ship fittings descriptions as well as cargo and ship scanning results
• Caching support for Memcached or Redis (via PhpRedis)
• Extensible via configurable subclassing
• A well documented and mostly PSR compliant codebase
• CLI tool for automated bulk market data updates

The CREST portion of the engine (formerly the iveeCrest library) can be used in conjunction with iveeCore or independently. Some of its features include: - Aims to be feature-complete and do things "the CREST way" as much as possible - Support for public and authenticated CREST including write access - Object oriented model for navigating the CREST endpoint tree, mapping CREST responses to specific classes - Gathering and re-indexing of multipage responses - Supports parallel GET requests with asynchronous response processing - Multilayer cache design - Includes a self-contained web-script to retrieve a refresh token, _(*8)

Documentation

• Release notes
• Installation and configuration
• iveeCore user guide
• iveeCrest user guide
• Extending iveeCore and future plans
• About caching in iveeCore
• Class diagram

If you find bugs, have feedback or are "just" a user, please post in this thread: EVE Online Forum: iveeCore., _(*9)

FAQ

Q: What were the beginnings of iveeCore? A: In early 2012 I began writing my own indy application in PHP. I had been using the Invention Calculator Plugin for EvEHQ, but with the author going AFG and the new EvEHQ v2 having a good but not nearly flexible enough calculator for my expanding industrial needs, I decided to build my own. The application called "ivee" grew over time and well beyond the scope of it's predecessor. In the end it was rewritten from scratch two and a half times, until I was happy with the overall structure. Eventually I decided to release the part of the code that provided general useful functionality, without revealing too much of ivee's secret sauce. So I put in some effort into separating and generalizing the code dealing with SDE DB interaction and Type classes into the engine which now is iveeCore. Later I started iveeCrest as a separate library but ended up merging it with iveeCore in July 2015., _(*10)

Q: What's the motivation for releasing iveeCore? A: I wanted to give something back to the eve developer community. I also see it as an opportunity to dip my toes into working on a Github hosted project, even if it is a small one, and it is a motivation to strive for better code quality., _(*11)

Q: Are you going to release ivee, the application that spawned iveeCore? A: No., _(*12)

Acknowledgements

EVE Online is a registered trademark of CCP hf., _(*13)