From 175db55359a17e411ba86e4378c66eb6102ba678 Mon Sep 17 00:00:00 2001 From: "Squishy (C6H12O6+NaCl+H2O)" <106439598+SweetSea-ButImNotSweet@users.noreply.github.com> Date: Mon, 27 May 2024 10:16:18 +0700 Subject: [PATCH] Update README --- README.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1cf1375..c4ec3f2 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ # Tromi (ANDROID port) -A old-fashioned but modern block-stacking game. Made with love by [mycophobia](https://mycophobia.org/tromi).
+A old-fashioned but modern block-stacking game. Made with :heart: by [mycophobia](https://mycophobia.org/tromi).
Ported to Android (mobile and TV) 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 ## For mobile ### 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 +1. In the [Releases tab](https://gitea.com/SweetSea-ButImNotSweet/tromi_mobile/releases) and click on ``Source code (zip)`` +2. Extract the folder inside to somewhere you can easy to navigate +3. Open the folder ``tromi_mobile``, select all files, then add to a ``zip`` archive and pick a name that easy to remember, example: ``tromi_moblie.zip`` +4. Rename the file extension, from ``zip`` to ``love`` (``tromi_mobile.zip`` to ``tromi_mobile.love``) +5. Download [``LÖVE for Android``](https://love2d.org) (You should get version 11.5) +6. 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) +7. 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`` +2. Navigate to where you put the game file, example ``tromi_mobile.love`` 3. Pick the file and enjoy ## For TV @@ -21,16 +24,16 @@ Ported to Android (mobile and TV) by SweetSea with on-screen control (with some > If you can, **plug in a keyboard or gamepad** and play the original Tromi instead of this one.
> You can still use the remote, but remember that it ***is not designed for gaming***. And if you lose before the speed hits 20G, I implore you ***not to throw the remote at your TV and then curse me because your performance is worse than when you play on the keyboard***. ### Installion -1. Install this file manager on your TV: https://play.google.com/store/apps/details?id=com.alphainventor.filemanager. Once you installed, you should see [this icon](https://play-lh.googleusercontent.com/9PzlG2XGr5sQDf5925tlZhqluOreI2cwzp-FOZiuj545Kt1Gk5EE9J4IdGsD7e5xWw=w240-h480-rw) -2. Opening the application, click on ``Access from...`` (network/other devices/etc.) -3. Now download both Tromi and LÖVE for Android on other devices (like on mobile) +1. On other device, do the step 1 - 5 in ``Install for mobile`` part +2. Install this file manager on your TV: https://play.google.com/store/apps/details?id=com.alphainventor.filemanager. Once you installed, you should see [this icon](https://play-lh.googleusercontent.com/9PzlG2XGr5sQDf5925tlZhqluOreI2cwzp-FOZiuj545Kt1Gk5EE9J4IdGsD7e5xWw=w240-h480-rw) +3. Opening the application, click on ``Access from...`` (network/other devices/etc.) 4. Transfer 2 downloaded files to TV -5. Install LÖVE for Android application -6. *(First time only)*open the ``tromi_mobile.love``. When the file manager asks you to open the file as what. Select ``Other``, then select ``LÖVE for Android`` and select ``Always`` +5. Install LÖVE for Android application (see step 6 in ``Install for TV`` section) +6. *(First time only)* Open the ``tromi_mobile.love``. When the file manager asks you to open the file as what. Select ``Other``, then select ``LÖVE for Android`` and select ``Always`` 7. Once you are in the key configuration scene, type ``88663366``. An predefined keybind will be set automatically, but you can now make a different one if you'd like to ### Launch -Navigate to where you put ``tromi_mobile.love`` in the File manager (the one you downloaded from the link in Install part), just opening and Tromi should be launched. +Navigate to where you put ``tromi_mobile.love`` in the File manager (the one you downloaded from the link in Install for TV section), just opening and Tromi should be launched. # Differences from original Tromi > This is required, to follow the used license (GNU GPL v3) @@ -49,7 +52,7 @@ Navigate to where you put ``tromi_mobile.love`` in the File manager (the one you # TODO -- [ ] Add a way to export replay for Android > 11 +- [ ] Add a way to export ~~replay~~ data for Android > 11 - [x] Revert ``bitser`` with ``binser`` (if and only if I can make it works) - [ ] Design a new on-screen buttons skin (the current one is come from [C₂₉H₂₅N₃O₅](https://github.com/C29H25N3O5), I am aware that it's not fit to Tromi's design language) - [ ] (Low priority) Design a new menu screen @@ -62,4 +65,16 @@ A small note about the music: > > I sent an email about this issue (not mentioning about this game), but I haven't got any replies from them (I checked both my main inbox and spam too, nothing)
> -> Both me and mycophobia can't give you a sub-license if you ask. What can I do is suggesting you to send an email about this (there is a chance that you may not receive any replies, but it's better than do nothing) \ No newline at end of file +> Both me and mycophobia can't give you a sub-license if you ask. What can I do is suggesting you to send an email about this (there is a chance that you may not receive any replies, but it's better than do nothing) + +# Special thanks +* mycophobia for writing the original Tromi +* MrZ_26 for the base of ``VCTRL`` module (yea I stole from him his code ;-;) +* C₂₉H₂₅N₃O₅ for his virtual key design, I used it during developing when I hadn't made my own yet + +# Don't forget to check +* [Original Tromi](https://mycophobia.org/tromi) +* [Leaderboard](https://mycophobia.org/) + +* [Cambridge](https://github.com/Cambridge-stacker/Cambridge) +* [Techmino](https://github.com/26F-Studio/Techmino) \ No newline at end of file