This is the repository for Mirobot apps, whick is hosted here. New apps are welcome, see below for how to get started.
Mirobot apps is a Jekyll project which means it's quite straightforward to add apps as you create them. Here's how to get started:
-
Fork the repository into your own GitHub account (just click the fork button at the top of the page)
-
Check out the repository from your account to your local computer
-
Optionally create a branch to work on your new app in (git checkout -b )
-
Add an app html file into the _apps directory like the others. It's easiest to just copy the point and click app as that's relatively simple
-
Create a directory in the assets/apps directory that mathces the name you gave your app - this can contain all of your assets like css and javascript files. At a minimum it should contain a 250px x 250px jpeg image called icon.jpg which will be used in the index listing.
-
Everything is static so you'll only be able to use Javascript but since that's what Mirobot uses to communicate that should be enough. There are two automatically included Javascript libraries which make your life easier. mirobot.js handles all communication with Mirobot and mirobot-app.js which sets up the connection and autoconfigures it based on the address in the URL. The way to set up your app is like this:
// This is your app ready to receive a mirobot object once it is set up var t = new Turtle(document.getElementById('turtle')); // MirobotApp sets up the connection to mirobot and hands you an object once it's done var app = new MirobotApp(function(mirobot){ t.setMirobot(mirobot); });
-
Ideally, users should be able to use your app without a mirobot connection to get a feel for what it does so try not to wait until it has connected to do all of the setup. See the other examples.
-
Once you're happy with your app, push it to your repository and submit a pull request to get it included.
-
Thanks for contributing to the Mirobot community!