Add documentation
This commit is contained in:
37
README.md
37
README.md
@@ -1,2 +1,39 @@
|
||||
# BitBlaster
|
||||
|
||||
After years studying at the Arcane University, you've returned to Greenhill for summer break - only to find it overrun by the Legion of the Damned. With your small spellbook and quick reflexes, you're the village's last hope against the demonic invasion!
|
||||
|
||||

|
||||
|
||||
## Installation & Getting Started
|
||||
|
||||
### System Requirements
|
||||
|
||||
- OS: Windows 10/11 (64-bit)
|
||||
- Storage: 50MB available space
|
||||
- Input: Keyboard + Mouse
|
||||
|
||||
### Installation
|
||||
|
||||
1. Download the latest version from [releases](https://github.com/AndrewTrieu/BitBlaster/releases/tag/latest)
|
||||
2. Right-click the installer and select "Run as administrator"
|
||||
3. Follow the on-screen setup wizard
|
||||
4. Launch the game from your desktop shortcut or Start menu
|
||||
|
||||
### First Steps
|
||||
|
||||
The game will automatically launch the start menu. Hit Space to open the tutorial.
|
||||
|
||||
## Asset Credits & References
|
||||
| Type | Source |
|
||||
|----------|:-------------:|
|
||||
| General Guidance | [Peyton Burnham](https://www.youtube.com/@peytonburnham4316) |
|
||||
| Character & Item Sprites | [Zerie](https://zerie.itch.io/tiny-rpg-character-asset-pack) |
|
||||
| Tile Set | [Butter Milk](https://butterymilk.itch.io/tiny-wonder-forest) |
|
||||
| Spells & Spawner | [BDragon1727](https://bdragon1727.itch.io/free-effect-and-bullet-16x16) |
|
||||
| Explosive Crate | [Anokolisa](https://anokolisa.itch.io/free-pixel-art-asset-pack-topdown-tileset-rpg-16x16-sprites) |
|
||||
| Explosion Animation | [Pixel Frog](https://pixelfrog-assets.itch.io/tiny-swords) |
|
||||
| Fonts | [Google Fonts](https://fonts.google.com/) |
|
||||
| Background Music | [David Renda](https://www.fesliyanstudios.com/royalty-free-music/download/8-bit-adventure/2282) |
|
||||
| Hit Sound | [Homemade_SFX](https://pixabay.com/sound-effects/soft-body-impact-295404/) |
|
||||
| Healing & Item Pickup Sound | [Freesound Community](https://pixabay.com/sound-effects/080245-sfx-magic-84935/) |
|
||||
| Explosion Sound | [Ahmed_Abdulaal](https://pixabay.com/sound-effects/explosion-312361/) |
|
||||
|
||||
Reference in New Issue
Block a user