Giter Club home page Giter Club logo

sails's Introduction

Sails

Sails is a simulator designed to test the AI of autonomous sailing robots. It emulates the basic physics of sailing a small single sail boat

Currently a large work in progress.

Build status: BuildStatus

Compiling

GNU/Linux

  1. Install the dependencies:

Fedora: sudo yum install cmake gtk3-devel librsvg2-devel

Debian/Ubuntu: sudo apt-get install cmake build-essential libgtk-3-dev librsvg2-dev

  1. Get source:
$ git clone https://github.com/kragniz/sails.git
  1. Compile:
$ cd sails
$ mkdir build
$ cd build
$ cmake ..
$ make
$ cd ..
  1. Run with:
$ ./build/sails

OS X

  1. Install Xcode (not command line utilities) and accept the license.
  2. Install JHBuild (a tool written for building large GNOME applications):
$ wget https://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh
$ sh gtk-osx-build-setup.sh
$ alias jhbuild="~/.local/bin/jhbuild"
$ jhbuild bootstrap
$ jhbuild build meta-gtk-osx-bootstrap
$ jhbuild build meta-gtk-osx-gtk3
  1. Now, JHBuild should be all ready to compile GTK+3 applications. To get a sane build environment, enter the jhbuild shell:
$ jhbuild shell
  1. In this shell, start building stuff:
$ git clone https://github.com/kragniz/sails.git
$ cd sails
$ mkdir build
$ cd build
$ cmake ..
$ make
$ cd ..
  1. Now run with:
$ ./build/sails

Windows

Install MinGW and add the bin directory (defaults to C:\MinGW\bin) to PATH.

Install GTK+ from the all-in-one bundle.

Install git.

Get a copy of the source (using git bash):

$ git clone https://github.com/kragniz/sails.git

Compile using make:

$ cd sails
$ make

Run with:

$ ./sails.exe

Usage

Currently, the only way to interact with the boat is via the keyboard. This will change once the API is implemented. Current controls are:

  • e and r - turn the rudder left and right
  • s - toggle whether the sail is held or relaxed
  • space - toggle camera mode from tracking and non-tracking

Licence

Copyright © 2014 Louis Taylor

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

sails's People

Contributors

kragniz avatar thip avatar

Watchers

 avatar

Forkers

phiros

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.