Gakumas-Localify-EN/README.md

<img align="center" src=/Images/logo.png>


This is a *Gakuen iDOLM@STER* Localization Module.
It accomplishes this by modifying the localization file and Unity assets, aided additionally with the help of a modified version of [gakuen-imas-localify] made to support english translations.

This is based on the [Android] version of the game.  

# Previews

<img align="center" src=/Images/preview.png>

<div align="center">

# Video Preview

</div>

# Features
- UI translation
- Produce Mode
- Idol & Support cards
- Idol Bond Commus
- Main Story
- Event Commus
- Lyrics

# Disclaimer
Gakumas-Localify-EN is not affiliated with Bandai Namco and is purely a fan-community effort.  
Assets are edited only for the purpose of translation and it is *the maintainer's belief* this is harmless and unlikely to be an issue.  
Nonetheless such edits are of course against the relevant TOS so **proceed at your own risk**!  
No maintainer nor contributor will be responsible for any issues encountered as a result of use.

---

# Progress

[A more detailed translation progress can be seen here](https://docs.google.com/spreadsheets/d/101wE-LjNJL-lSzZB96ifQAj3X-WmmA1ZIXKFTFRFJGY/edit?usp=sharing)
[![Link](https://docs.google.com/spreadsheets/d/e/2PACX-1vQctXxwDqkSCNkFs_Ipgh4W0g4Z8dBoyTvJISN16lf7m-huOnfngVtnnNXmRe52oBp0sTtfxapFHN4y/pubchart?oid=847311911&format=image)](https://docs.google.com/spreadsheets/d/101wE-LjNJL-lSzZB96ifQAj3X-WmmA1ZIXKFTFRFJGY/edit?usp=sharing)
[![Link](https://docs.google.com/spreadsheets/d/e/2PACX-1vQctXxwDqkSCNkFs_Ipgh4W0g4Z8dBoyTvJISN16lf7m-huOnfngVtnnNXmRe52oBp0sTtfxapFHN4y/pubchart?oid=574536670&format=image)](https://docs.google.com/spreadsheets/d/101wE-LjNJL-lSzZB96ifQAj3X-WmmA1ZIXKFTFRFJGY/edit?usp=sharing)

# Setting up / Getting started
---
# Usage

- This is an Xposed Module.
- For Magisk users use [LSPosed](https://github.com/LSPosed/LSPosed).
- For Non-Root users use [LSPatch](https://github.com/LSPosed/LSPatch).

# Download

You can download the latest build from the GitHub Actions artifacts.

1. Go to the [GitHub Actions](https://github.com/NatsumeLS/Gakumas-Localify-EN/actions) page.
2. Find the most recent workflow run.
3. Click on the workflow run to view details.
4. In the "Artifacts" section at the bottom of the page, download the `GakumasLocalify` artifact.

# Localization

[Gakumas-Translation-Data-EN](https://github.com/NatsumeLS/Gakumas-Translation-Data-EN)

- Localization files are placed in `/app/src/main/assets/gakumas-local`

# Contributors

<a href="https://github.com/NatsumeLS/Gakumas-Localify-EN/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=NatsumeLS/Gakumas-Localify-EN" />
</a>

# Special Thanks

- [gakuen-imas-localify](https://github.com/chinosk6/gakuen-imas-localify)
- [GakumasTranslationData](https://github.com/chinosk6/GakumasTranslationData)
- [gkmasToolkit](https://github.com/kishidanatsumi/gkmasToolkit)
- [UmaPyogin-Android](https://github.com/akemimadoka/UmaPyogin-Android)
- [UnityResolve.hpp](https://github.com/issuimo/UnityResolve.hpp)

[gakuen-imas-localify]: https://github.com/chinosk6/gakuen-imas-localify/
[Android]: https://play.google.com/store/apps/details?id=com.bandainamcoent.idolmaster_gakuen