Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seleb committed Jun 9, 2018
1 parent 666fad5 commit 034005f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# Better-Minimal-WebGL-Template

Minimal WebGL build template.

## Features

- Scales canvas to fit the window horizontally + vertically while maintaining aspect ratio (can be disabled)
- Centers canvas in window
- Customizable background

## To use

1. Download and unzip
2. Copy the `WebGLTemplates` folder into your project's `Assets` folder
3. File -> Build Settings... -> WebGL -> Player Settings... -> Select the `BetterMinimal` template
4. (Optional) Customize colour in the `Background` field; enter `false` in the `Scale to fit` field to disable scaling

Ideal for embedding on sites like itch.io which provide an external full-screen button.

0 comments on commit 034005f

Please sign in to comment.