From 39a6d2f7dac21d20ee5109a151539d23cc9d8fba Mon Sep 17 00:00:00 2001 From: Bart Heijltjes Date: Thu, 4 Mar 2021 18:41:26 +0100 Subject: [PATCH] Updated Readme --- CHANGELOG.md | 4 ++-- README.md | 15 +++++++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0421219..753ae11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -#ChangeLog +# ChangeLog -##[0.6.0-preview] - 2021-03-04 +## [0.6.0-preview] - 2021-03-04 * Initial Release \ No newline at end of file diff --git a/README.md b/README.md index e572ec3..0e113fa 100644 --- a/README.md +++ b/README.md @@ -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.