Git Product home page Git Product logo

scenery-poi-labels's Introduction

POI Labels on Scenery - Plugin for X Plane

This plugin for X Plane labels points of interest (POIs) on your scenery as you fly around. POIs are downloaded from OpenStreetMap automatically. These are the kinds of POIs the plugin labels:

  • Mountains
  • Rivers
  • Population centers
  • Airports

This plugin uses the SASL plugin framework. All of the logic is implemented in Lua. The Busted test-driven-development framework is used for testing.

Development

To setup your development environment, be sure to install Lua 5.1 so you're developing and testing with the same version of Lua that LuaJIT uses in X Plane (v5.1 as of X Plane 11.41). You'll also need Busted for running tests and LuaCov for test coverage analysis. Here's how I did it on my Mac (note: I tried an approach with Homebrew but was unsuccessful).

  1. Install hererocks: pip3 install hererocks . You'll need Python and Pip to install it.
  2. Make a directory somewhere for your installation of Lua, Luarocks, etc. (hererocks gave me an error for directories with a space in the path).
  3. In that directory, hererocks lua51 -l5.1 -rlatest to install Lua 5.1 with the latest luarocks.
  4. Activate that installation (add the necessary paths to your shell) with source lua51/bin/activate. You should also source this command in your .bashrc or .zshrc so that the paths are active each time you login.
  5. luarocks install busted
  6. luarocks install luacov

Running the tests

cd data/modules/Custom\ Module
busted

Reviewing the test coverage report

Again, in the data/modules/Custom\ Module directory:

luacov
cat luacov.report.out | more

scenery-poi-labels's People

Contributors

gitmitch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.