Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sungwoncho/pixel-explorer
Explore the screen and look for the pixels with the desired color.
https://github.com/sungwoncho/pixel-explorer
Last synced: 15 days ago
JSON representation
Explore the screen and look for the pixels with the desired color.
- Host: GitHub
- URL: https://github.com/sungwoncho/pixel-explorer
- Owner: sungwoncho
- License: mit
- Created: 2015-09-28T13:02:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-25T22:00:56.000Z (about 9 years ago)
- Last Synced: 2024-12-12T15:02:15.977Z (22 days ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pixel Explorer
[](https://travis-ci.org/sungwoncho/pixel-explorer)
Explore the screen and look for the pixels with the desired color. Optionally draw the output.
## Installation
npm install pixel-explorer
## API
### find(x, y, size, color)
Finds the pixels with the desired `color`. Search through all pixels in a
rectangle whose sides are of length `size`. The rectangle begins at `x` and `y`
of the screen.
Returns an array of objects containing x and y coordinates of the
pixels.
```javascript
var pixelExplorer = require('pixel-explorer');
pixelExplorer.find(350, 400, 6, '423c42');
// => [{x: 351, y: 400}, {x: 351, y: 401}, {x: 355, y: 400},
// {x: 352, y: 409}, {x: 352, y: 403}]
```
### explore(x, y, size)
Explores the rectangle from `x` and `y` whose sides are of length `size`.
Returns an array of objects containing x and y coordinates, and the colors
of the pixels.
```javascript
var pixelExplorer = require('pixel-explorer');
pixelExplorer.explore(350, 400, 6);
// => [{x: 350, y: 406, color: '423c42'}, {x: 351, y: 402, color: 'fafafa'},
// {x: 355, y: 403, color: '0f840f'}, {x: 352, y: 409, color: '000000'},
// {x: 354, y: 400, color: 'fafafa'}]
```
### draw(x, y, size, color)
Find the specific color in the rectangle specified by the arguments and draws
the result in the console.
*Limitation: the output may not fit in the console depending on the size*
```javascript
var pixelExplorer = require('pixel-explorer');
pixelExplorer.draw(350, 400, 6, '423c42');
// => Output
// ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┐
// │ │ 350 │ 351 │ 352 │ 353 │ 354 │ 355 │
// ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
// │ 400 │ │ X │ │ │ │ X │
// ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
// │ 401 │ │ X │ │ │ │ │
// ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
// │ 402 │ │ │ X │ │ │ │
// ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
// │ 403 │ │ │ x │ │ │ │
// ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
// │ 404 │ │ │ │ │ │ │
// ├─────┼─────┼─────┼─────┼─────┼─────┼─────┤
// │ 405 │ │ │ │ │ │ │
// └─────┴─────┴─────┴─────┴─────┴─────┴─────┘
```
## Contributing
Open issues with bugs or feature requests.
### Run test
npm test
### Roadmap
* Better draw using node-canvas and png output
* Compare the explored output with pre-set values
## License
MIT