konsthol/shattered-pixel-dungeon-web-port
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

v2.0.0: updated readme and doc files

Browse Source
This commit is contained in:
Evan Debenham
2022-12-30 14:57:16 -05:00
parent 5e18481c26
commit cbc2cb468d
6 changed files with 117 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,12 +1,16 @@
# Shattered Pixel Dungeon
A Roguelike RPG, with randomly generated levels, items, enemies, and traps! Based on the [source code of Pixel Dungeon](https://github.com/00-Evan/pixel-dungeon-gradle), by [Watabou](https://www.watabou.ru).
[Shattered Pixel Dungeon](https://shatteredpixel.com/shatteredpd/) is an open-source traditional roguelike dungeon crawler with randomized levels and enemies, and hundreds of items to collect and use. Its based on the [source code of Pixel Dungeon](https://github.com/00-Evan/pixel-dungeon-gradle), by [Watabou](https://www.watabou.ru).
Shattered Pixel Dungeon currently compiles for Android, iOS and Desktop platforms. It is available from [Google Play](https://play.google.com/store/apps/details?id=com.shatteredpixel.shatteredpixeldungeon), [the App Store](https://apps.apple.com/app/shattered-pixel-dungeon/id1563121109), and right here on [GitHub](https://github.com/00-Evan/shattered-pixel-dungeon/releases).
Shattered Pixel Dungeon currently compiles for Android, iOS, and Desktop platforms. You can find official releases of the game on:
![Get it on Google Play](https://shatteredpixel.com/assets/images/gplay-badge.png)
![Download on the App Store](https://shatteredpixel.com/assets/images/appstore-badge.png)
![Steam](https://shatteredpixel.com/assets/images/steam-badge.png)
![Github Releases](https://shatteredpixel.com/assets/images/github-badge.png)
If you like this game, please consider [supporting me on Patreon](https://www.patreon.com/ShatteredPixel)!
There is an official blog for this project at [ShatteredPixel.com](https://www.shatteredpixel.com).
There is an official blog for this project at [ShatteredPixel.com](https://www.shatteredpixel.com/blog/).
The game also has a translation project hosted on [Transifex](https://www.transifex.com/shattered-pixel/shattered-pixel-dungeon/).
@@ -17,4 +21,4 @@ If you'd like to work with the code, you can find the following guides in `/docs
- **[If you plan to distribute on Google Play please read the end of this guide.](docs/getting-started-android.md#distributing-your-apk)**
- [Compiling for desktop platforms.](docs/getting-started-desktop.md)
- [Compiling for iOS.](docs/getting-started-ios.md)
- [Recommended changes for making your own mod.](docs/recommended-changes.md)
- [Recommended changes for making your own version.](docs/recommended-changes.md)