Add README file

This commit is contained in:
Squishy (C6H12O6+NaCl+H2O)
2024-05-25 22:20:33 +07:00
parent 9e1c8d4680
commit 837958e476
3 changed files with 32 additions and 7 deletions

25
README.md Normal file
View File

@@ -0,0 +1,25 @@
# Tromi (MOBILE port)
A old-fashioned but modern block-stacking game. Made with love by [mycophobia](https://mycophobia.org/tromi).<br>
Ported to Android by SweetSea with on-screen control (with some necessary changes)
# How to play
> :warning: There is no Android build (aka APK file) right now. If you see any pre-built APK files on the internet. Please be aware
## Install
1. Download Tromi from [Releases tab](https://gitea.com/SweetSea-ButImNotSweet/tromi_mobile/releases) and place ``tromi_mobile.love`` to somewhere you can easy to navigate
2. Download [love2d engine](https://love2d.org) (You should get 11.5 or above)
3. Install love2d engine (extra steps may require, you can read [this article from WikiHow](https://www.wikihow.com/Install-APK-Files-on-Android) if this is the first time for you to install app from APK file)
4. Now, press Home (or back to app launcher), you can see two icons: ``LÖVE for Android`` and ``LÖVE Launcher``. You should use the ``LÖVE Launcher`` to launch Tromi
## Launch
1. Launch ``LÖVE Launcher``, an file picker will appear
2. Navigate to where you put the bare ``tromi_mobile.love``
3. Pick the file and enjoy
# Differences from original Tromi
> This is required, to follow the used license (GPL v3 and later)
* No differences in gameplay
* Files will be saved into ``Android/data/org.love2d.android/tromi_mobile`` instead the location where the game files in
* All UIs are touch-able
* <detail><summary>Changes the way to input secret code to activate Pentominoes mode</summary>
<img title="This is where you should tap to input the Secret code" src="/screenshot/SPOILER_secret_code.png">
To insert the left arrow, tap on the left, so does to right arrow.
</detail>