└── README.md /README.md: -------------------------------------------------------------------------------- 1 | # Totentanz 2 | 3 | Totentanz is a project preserving *Magia Record: Puella Magi Madoka Magica Side Story* and making it playable after End of Service. 4 | 5 | --- 6 | 7 | ## How to Play 8 | 9 | 1. **Download the APK:** 10 | Get the latest [release](https://github.com/Puella-Care/client-apk/releases). 11 | 12 | 2. **Install on Android:** 13 | Follow your device's standard instructions to install APKs. 14 | 15 | 3. **Launch and Enjoy:** 16 | Jump straight into the game with all features unlocked. 17 | 18 | --- 19 | 20 | ## How to Contribute 21 | 22 | Contributions in any of the following areas are welcome. There are several overlay repositories: 23 | - Downloadable assets overlay: [`Puella-Care/en-download`](https://github.com/Puella-Care/en-download) 24 | - Image web assets overlay: [`Puella-Care/en-image_web`](https://github.com/Puella-Care/en-image_web) 25 | - Text web assets overlay: [`Puella-Care/en-text`](https://github.com/Puella-Care/en-text) 26 | - Server-side data overlay: [`Puella-Care/en-data`](https://github.com/Puella-Care/en-data) 27 | 28 | For bug reports or anything else, open [issues](https://github.com/Puella-Care/totentanz-meta/issues). 29 | 30 | --- 31 | 32 | ## How to Support 33 | 34 | Totentanz is a project maintained on a non-commercial basis. While it's free for everyone: 35 | - **Financial Support:** Consider donating to cover domain, development, and hosting costs. 36 | - Boosty: https://boosty.to/PuellaCare/donate 37 | - BTC: `bc1qlz0azz0mq32mt3ja30gzd9h5t9tk4zzr207aqv` 38 | - LTC: `LNUNTsqG9S4PqQwqMPL5sD3ciPxNPS8CFd` 39 | - ETH: `0xB14ad0d9c20f083e90Ae9c14E6F231E6Fa1EE2A2` 40 | - USDT: `0xB14ad0d9c20f083e90Ae9c14E6F231E6Fa1EE2A2` 41 | - XMR: `46w6fcnMy4kdtxwLSxXZqYbVAHp4Cu47HPiQfzrqM761Qbj7xMJojmkEPhhc3jT98VDw746hgRQHgDh7RtHEnB3iSMu482T` 42 | - For any other ways, contact via `livia@cirno.name` or open an issue in this repository. 43 | - If you want to be credited as sponsor, contact via same email. 44 | - **Spread the Word:** Share Totentanz with your community. 45 | There are no limitations or restrictions on spreading the info and links. 46 | 47 | --- 48 | 49 | ## How to Contact 50 | 51 | For legal or official matters, do not hesitate to contact via: `9@cirno.name` 52 | 53 | For everything else, contact via: `livia@cirno.name` 54 | 55 | To make sure your email gets through, please include `Totentanz` in the subject or body. Spam filters are stupid, but this word is explicitly allowlisted. 56 | 57 | --- 58 | 59 | ## FAQ 60 | 61 | **Q: Do I need an account to play?** 62 | A: No, Totentanz is fully unlocked from the start. This includes stories, M-Girls, doppels, memorias, etc. 63 | 64 | **Q: Is there in-app purchasing?** 65 | A: No, the game is entirely free. 66 | 67 | **Q: Which platforms are supported?** 68 | A: Currently, Totentanz is available only on Android. An iOS version may follow. 69 | 70 | **Q: How do I report a bug?** 71 | A: Please open an issue on this GitHub repository, provide steps to reproduce your problem and screenshots. 72 | 73 | **Q: How can I contribute to translations or assets?** 74 | A: Visit the GitHub repos listed in above and submit a pull request. 75 | 76 | **Q: Can this be played offline?** 77 | A: No, the game requires connection to the server to work. 78 | 79 | **Q: Can this be played on PC?** 80 | A: Yes, by using virtual machine with Android installed. 81 | 82 | **Q: Will installing it overwrite the original game?** 83 | A: No, the game will be installed separately. 84 | 85 | **Q: Is server-side code open source?** 86 | A: For several reasons it is not. This may change in the future. 87 | 88 | **Q: What language is used for API server?** 89 | A: JavaScript, the only dependency is [`fastify`](https://github.com/fastify/fastify). 90 | 91 | **Q: I do [something] but my progress is not saved, why?** 92 | A: The server operates in stateless mode. 93 | 94 | **Q: What does stateless mode mean?** 95 | A: It means that for most methods, the changes are not preserved. 96 | To improve the gameplay experience, there are a few exceptions: 97 | - `user` data such as login name, etc. 98 | - `gameUser` data such as M-Girl on homescreen, background, comment, etc. 99 | - `userDeck` data with user-defined decks. 100 | - `userQuestBattleResult` data which allows playing quests. 101 | - Patrols subsystem works on shared basis rather than per-user. 102 | 103 | All of these are preserved in memory only, i.e. changes can be wiped after timeout or server restart. 104 | 105 | **Q: What is required for persistent storage?** 106 | A: Async `node:sqlite/promises` API. 107 | 108 | **Q: What are differences between this APK and the one from Google Play?** 109 | A: The client part is basically [`magiatranslate`](https://github.com/rayshift/magiatranslate) using different servers. 110 | 111 | **Q: Where do I find history of scenario translations and credits for the translators?** 112 | A: The current scenario translations are in the [`Puella-Care/en-download`](https://github.com/Puella-Care/en-download) repository. 113 | All previous contributions were made to the MagiaTranslate project, and can be found in the [`kamihama/magia-assets`](https://git.rayshift.io/kamihama/magia-assets) repository. 114 | 115 | **Q: Why can I play auto and x3 speed in battles that should not have it?** 116 | A: QoL improvement. 117 | 118 | **Q: How do I import my account data?** 119 | A: If you have account backup made with latest version of `connect`, it might be possible in the future. 120 | 121 | **Q: How do I access the tutorial?** 122 | A: The prologue story can be found in the archive. The tutorial battles are not accessible at the moment. 123 | 124 | **Q: The texts are in Japanese, how to read?** 125 | A: Contribute to the translation overlay to make them show in English. 126 | 127 | **Q: The texts are in English, is there a Japanese version?** 128 | A: It might come in the future. 129 | 130 | **Q: Is there any region restriction or country code?** 131 | A: No. 132 | 133 | **Q: I have problem during asset downloading, what do I do?** 134 | A: Make sure your connection is stable, continue download in case of error, and be patient. 135 | 136 | **Q: I have connection problems, what do I do?** 137 | A: Fix your connection. 138 | 139 | **Q: I found a typo or image error, how do I fix it?** 140 | A: Open pull request to the corresponding overlay repository. 141 | 142 | **Q: How likely is iOS version?** 143 | A: Easy if someone manages to make `magiatranslate`-patched version of iOS client app. Impossible otherwise. 144 | 145 | **Q: I heard that it was feasible with vanilla `v3.1.9`, is that still true?** 146 | A: Not anymore. Vanilla app now points to the `Capricieux` server. See [#12](https://github.com/Puella-Care/totentanz-meta/issues/12) and [#18](https://github.com/Puella-Care/totentanz-meta/pull/18). 147 | 148 | **Q: What is `Capricieux`?** 149 | A: Separate server in Tokyo designed to strictly separate Archive App from this project. See [`Puella-Care/capricieux`](https://github.com/Puella-Care/capricieux) repository. 150 | 151 | **Q: The M-Girl transformation videos are not playing, how to fix?** 152 | A: Make sure to enable High Quality Videos in Settings -> Manage Data. 153 | Low Quality Videos are also available, but not recommended. 154 | 155 | **Q: The story that was supposed to be voiced is not voiced, how to fix?** 156 | A: Make sure to download full voices. 157 | Only full download is available, per-story download might be available later. 158 | 159 | **Q: Why only a few events are available?** 160 | A: Event availability is limited to the data collected. If you have data for more events, feel free to share. 161 | 162 | **Q: There were changes to the web overlays, but I don't see them ingame, how to fix?** 163 | A: Clear app cache (do not clear all data). 164 | 165 | **Q: Why are enemy waves in quest battles always constant?** 166 | A: The data is limited and wave generation is difficult to implement in efficient way. 167 | 168 | **Q: Why is the total power of arena deck not calculated properly?** 169 | A: Performance considerations: user arena matches are generated synchronously, whereas retrieving the actual arena deck must be done asynchronously. 170 | 171 | **Q: I need a real game with gacha and 3D models, what do I do?** 172 | A: Play [Madoka Magica Magia Exedra](https://play.google.com/store/apps/details?id=com.aniplex.magia.exedra.en) 173 | 174 | **Q: I am content owner and I want some files to be removed, what do I do?** 175 | A: Open pull request or issue; or contact via email for legal and official matters. 176 | 177 | --- 178 | 179 | ## Sponsors 180 | 181 | Notes: 182 | The list is updated manually, sometimes there might be a delay. If you feel like your name must be here, or if you wish it to be changed, or if you wish it to be removed, please open a PR or contact me. 183 | The list is sorted alphabetically, case-insensitive. 184 | 185 | | ![Antimony](https://images.boosty.to/user/40383229/avatar?croped=1&mh=64&mw=64) | ![Axel Katsuragi](https://images.boosty.to/user/40386153/avatar?croped=1&mh=64&mw=64)| ![Destroyer068](https://images.boosty.to/user/40393353/avatar?croped=1&mh=64&mw=64) | ![igi](https://images.boosty.to/user/40384011/avatar?croped=1&mh=64&mw=64) | ![IzunaMoon](https://cdn.discordapp.com/avatars/644342720755925002/b782ba38066f22df493aec7fbcdac6ee.webp?size=64) | ![Izzy](https://cdn.discordapp.com/avatars/322449352721301504/48bd27a219b16e46815f4dbe4ab01582.webp?size=64) | ![Pontiff](https://images.boosty.to/user/40748117/avatar?croped=1&mh=64&mw=64) | ![VirusLord](https://images.boosty.to/user/40383226/avatar?croped=1&mh=64&mw=64) | 186 | |:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| 187 | | Antimony | Axel Katsuragi | Destroyer068 | igi | IzunaMoon | Izzy | Pontiff | VirusLord | 188 | 189 | --- 190 | 191 | ## Acknowledgements 192 | 193 | Thanks to `Magica Quartet/Aniplex・Magia Record Partners` and everyone involved in Magia Record for the game itself. 194 | 195 | Thanks to everyone who contributed to the [`magiatranslate`](https://github.com/rayshift/magiatranslate) project that made translated version possible. 196 | 197 | Thanks to everyone who contributed to all assets repositories (both here and in [`kamihama/magia-assets`](https://git.rayshift.io/kamihama/magia-assets)), expanding the translation far beyond what NA version had. 198 | 199 | Thanks to everyone who helped with the [`puella historia`](https://github.com/LiviaMedeiros/puella-historia) project that made exhaustive implementation possible. 200 | 201 | Thanks to `sisyphus888` who provided server for the downloadable assets. 202 | 203 | --- 204 | 205 | ## Copyright notice 206 | 207 | © 2025 [LiviaMedeiros](https://github.com/LiviaMedeiros). 208 | 209 | Based on [Magia Record: Puella Magi Madoka Magica Gaiden](https://magireco.com/) - Copyright by Magica Quartet/Aniplex, Magia Record Partners 210 | --------------------------------------------------------------------------------