The simple, cooperative, non-committal drawing tool for /r/place and pxls.space.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
code
LICENSE
README.md

README.md

auto-placer

The simple, cooperative, non-committal drawing tool for /r/place and pxls.space.

What?

First things first, check out /r/place and pxls.space. If you haven't heard of them yet, they're these neat sort of territorial drawing experiments initially started by Reddit.

Secondly, auto-placer is a potential solution to the problem of how to coordinate people into placing tiles to create interesting designs. It does this through a mostly passive system that doesn't require you to install any extra software, and runs on the browser that you're already running. There aren't any servers or connections to manage, configuration is easy, and distribution can be done with a simple bookmarklet.

Configuration

auto-placer needs three things for it to start working:

  • A link to a raw source image (string)
  • An x coordinate (integer)
  • A y coordinate (integer)

The This image is used as a template for where everyone will draw their tiles. Its pixels will literally be converted one-to-one into tiles, so it's a good idea to keep sizes small. Also, don't worry about making sure image's pixels match up with the allowed color palette. Theres a handly conversion method that will try to find the closest color in the palette.

The coordinates define where the image will be created on the board. Specifically, they define where the top-left corner of the image will be placed.

Execution

After configuration, there are two main ways of running it:

  • Via a bookmarklet
  • Via manually pasting code into the developer console

Below is an example of a simple bookmarklet

javascript:
	/* Change these three lines */
	let imageUrl = "https://i.imgur.com/AxKGmnJ.jpg";
	let leftX = 50;
	let topY = 580;
	/* Change these three lines */

	let context = window.App;
	if(window.location.hostname.includes("reddit.com")){
		context = this.r.place;
	}

	$.getScript("https://rawgit.com/naschorr/color-converter/master/code/converter.js", function(){
		$.getScript("https://rawgit.com/naschorr/auto-placer/master/code/auto-placer.js", function(){
			new AutoPlacer(context, imageUrl, leftX, topY);
		});
	});

Below is an example of a preconfigured script for the developer console.

let context = window.App;
$.getScript("https://rawgit.com/naschorr/color-converter/master/code/converter.js", function(){
	$.getScript("https://rawgit.com/naschorr/auto-placer/master/code/auto-placer.js", function(){
		new AutoPlacer(context, "https://i.imgur.com/AxKGmnJ.jpg", 50, 580);
	});
});

Obviously, you can convert the bottom example into a bookmarklet with a javascript: line at the top, and likewise the upper example can be pasted into the developer console if the javascript: line at the top is omitted.

When executed, the above examples will start placing the tiles needed to create a 24x24 Javascript logo whose top-left corner is at coordinates (50, 580).

Lastly, in Chrome, bookmarklets can be made by pressing ctrl-D, clicking on 'Edit...' and then pasting the code inside the URL box.

Anything Else?

This was mostly hacked together in between working on other things, so it's pretty much in its most basic state. I'd like to add some test cases, and make the whole thing a bit more robust for the internet, but I'm not sure how long this thing (event?) will last. I'm also not very satisfied with the current bookmarklet, but it works okay enough.

Tested and working on Chrome 56. I'd guess that other modern browsers will work just fine.