Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Meorge authored Sep 11, 2019
1 parent bdd8dc8 commit 0a47e97
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,23 @@ Sneaksters is a game about using teamwork to steal treasure! Players must take u


## Download the Alpha
Sneaksters is currently in alpha. There's likely to be a lot of bugs and issues with the game.
You can find the latest builds of Sneaksters at https://github.com/Meorge/sneaksters-testing/releases.
Note: Sneaksters is currently in alpha. There's likely to be a lot of bugs and issues, some of which may be game-breaking (although they should NOT pose any threat to your computer).


## Report Bugs and Suggestions
Use this repository's Issue Tracker to report bugs and give gameplay suggestions!
Please submit bug reports and suggestions at https://github.com/Meorge/sneaksters-testing/issues.

### What to include in a bug report
In order to help us diagnose the problem, please include:
- The operating system you played the game on when the bug occurred (Windows, macOS, or Linux)
- What you were doing when the bug occurred
- Screenshots of the bug (if it is visual)
- Player log files
- Windows: `C:\Users\username\AppData\LocalLow\ZenithPoint\Sneaksters\Player.log`
- macOS: `~/Library/Logs/Zenith Point/Sneaksters/Player.log`
- Linux: `~/.config/unity3d/ZenithPoint/Sneaksters/Player.log`
- Before you send a log file, you may want to skim through it and confirm that there is no personally identifying information (such as your name from a file path).

### Note regarding suggestions
We'll try to look at every suggestion that comes in. It's possible that a suggestion may go against the spirit of the game as we see it or be too much work to implement, and as such we won't include it. Alternatively, we may already have plans to implement something before you suggest it! As such, there's no guarantee that suggestions will be included or attributed to you.

0 comments on commit 0a47e97

Please sign in to comment.