Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WispBart committed Mar 4, 2021
1 parent 6e3ad2b commit 39a6d2f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#ChangeLog
# ChangeLog

##[0.6.0-preview] - 2021-03-04
## [0.6.0-preview] - 2021-03-04
* Initial Release
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# Butler Window for Unity
An Unity Editor Window for uploading builds to Itch.io
A Unity Editor Window for uploading builds to Itch.io

![itch io window](meta/itchiowindow.png)

This tool downloads & wraps [Butler](https://itch.io/docs/butler/) so you can build & upload your project to itch.io with a single button. It's ideal for rapidly sharing the latest iteration of your game, prototype or other without having to leave your Editor.

##Requirements
## Installation & Use

In the Unity Package Manager (window -> Package Manager), select the + and 'Add package from git URL' and type https://github.com/WispBart/ButlerWindow.git
After the package is successfully installed, you can find Butler Window under 'window -> Upload to itch.io'.

After letting the tool install Butler, Add the account and project name of an itch.io project you have access to. Click on the link to check if they are correct. Click Build & Share to build and upload your game.

## Requirements
Butler Window was tested with Unity 2019.4 and 2020.2. Butler Window currently only builds to WebGL (by choice), so you need to have the WebGl Build module installed.

##Supported Platforms
## Supported Platforms
Butler Window / Upload to itch.io currently only supports the UnityEditor on Windows, although it can be safely shared with Linux/macOS machines.

##Security
## Security
Butler Window uses Butler for authentication, so no passwords are stored by the package.

0 comments on commit 39a6d2f

Please sign in to comment.