Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fionnfuchs authored Mar 26, 2019
1 parent 717922e commit 16bed7e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@

*Very early in development!*

This is a javascript framework for drawing monospace ascii on a canvas. In the future functionality for game development is planned.
This is a javascript framework for drawing monospace ascii on a canvas. In the future functionality for game development is planned.

### Take a look
**Currently only Browsers supporting JavaScript modules are supported!**

## Take a look
You can see a small demo of functionality at **https://fionnfuchs.github.io/ascii-canvas-js/**

### Features
## Features
- Draw single characters on grid
- Draw boxes of characters on grid
- Draw horizontal and vertical strings on grid
- Draw from file (e.g. .txt) source

All functionality is contained in ascii-canvas.js and pretty self explanatory.

### Tutorial
## Tutorial
You can use ```main.js``` as a starting point. Use ```drawObject(obj,x,y,color)``` from the ```renderer``` to draw any string at position (x,y). Objects that have multiple lines can be drawn by just placing \n in the string. Then it will go to the next line (y) and to the first x relatively.

0 comments on commit 16bed7e

Please sign in to comment.