Skip to content

Commit

Permalink
Update README with badges for release version, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
cmilr committed Jul 30, 2017
1 parent f37c40a commit 932419a
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
root = true

[*]
indent_style = tab
indent_size = 4
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
[![GitHub release][version-badge]][repo] 
[![GitHub issues][issues-badge]][issues] 
[![GitHub license][license-badge]][license] 
[![Code of Conduct][coc-badge]][coc] 
[![PRs Welcome][prs-badge]][prs]

# DeadSimple Pixel-Perfect Camera
The DeadSimple pixel-perfect camera is an easy-to-use orthographic camera script for producing crisp, clean pixel art at any resolution in Unity.

![](screenshot.png)
##### Art by Buch—http://opengameart.org/users/buch or Patreon.com https://www.patreon.com/buch.

## What This Script Does (and Doesn't)
This script will make sure your pixel art looks pretty at any screen size—in other words, every pixel in your original artwork will be displayed at the same size as every other pixel, so you won't get any weird non-square pixels/blobs (blech.)
This script will make sure your pixel art looks pretty at any screen size—in other words, every pixel in your original artwork will be displayed at the same size as every other pixel, so you won't get any weird non-square pixels/blobs (blech.)

What this script *won't* do is force your character sprites to only move in single-pixel increments. That is a function more suited to your controller.

Expand All @@ -30,7 +36,11 @@ To view your scene in pixel-perfect fashion in the Unity Editor, make sure you h

By the same token, you will want to turn off **Default is Full Screen** in the player settings of your build, otherwise, your game's display will be stretched-to-fit—ruining the hard work you put into your pixel art.

# Thanks for using DeadSimple Pixel-Perfect Camera!
## Release History
* 1.0.0
* First version

##

### Contact
- Email: [email protected]
Expand All @@ -43,3 +53,23 @@ By the same token, you will want to turn off **Default is Full Screen** in the p
The ***DSPixelPerfectCamera.cs*** script is distributed under the MIT license. See ``LICENSE`` for more information.

All ***artwork*** included in this repository is for example only, and is copyright Michele Bucelli. You can find more of Buch's great artwork at OpenGameArt.org http://opengameart.org/users/buch, or Patreon.com https://www.patreon.com/buch.

# Thanks for using DeadSimple Pixel-Perfect Camera!

<!--
Badge References
-->
[version-badge]:https://img.shields.io/github/release/cmilr/DeadSimple-Pixel-Perfect-Camera.svg
[issues-badge]:https://img.shields.io/github/issues/cmilr/DeadSimple-Pixel-Perfect-Camera.svg
[license-badge]:https://img.shields.io/github/license/cmilr/DeadSimple-Pixel-Perfect-Camera.svg
[coc-badge]:https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat
[prs-badge]:https://img.shields.io/badge/%E2%99%A5%EF%B8%8F%20pull%20requests-welcome-orange.svg

<!--
URL References
-->
[repo]:https://github.com/cmilr/DeadSimple-Pixel-Perfect-Camera/releases
[issues]:https://github.com/cmilr/DeadSimple-Pixel-Perfect-Camera/issues
[license]:https://github.com/cmilr/DeadSimple-Pixel-Perfect-Camera/blob/master/LICENSE
[coc]:https://github.com/cmilr/DeadSimple-Pixel-Perfect-Camera/blob/master/CODE_OF_CONDUCT.md
[prs]:http://makeapullrequest.com

0 comments on commit 932419a

Please sign in to comment.