Giter VIP home page Giter VIP logo

aliucord's Introduction

Aliucord

Discord

GitHub Repo stars GitHub forks License

Aliucord is a modification for the Android Discord app inspired by desktop client modifications.

Unlike other Android Discord app modifications, you don't need to rebuild the APK when adding or removing plugins, because Aliucord hooks at runtime using the Pine java method hook framework.

📃 Table of contents

⚠️ Important Information

Supported Architectures

  • arm
  • arm64

Pine does not support x86 or x86_64 architectures, and thus Aliucord does not either.

Supported Android version(s)

  • 7.0+ (SDK 24+)

Supported Discord version(s)

  • 88.2 / Alpha 88202 (You don't need the apk, the installer will download it for you)

🎨 Features

  • Rootless! Aliucord itself does not require a rooted device in order to use it
  • Robust plugin system using Pine!
    • Allows swapping in and out your plugins without needing to rebuild Aliucord
    • Toggle on and off, configure or uninstall your plugins via the plugins page
    • Minimum Discord versions for plugins so no breaking changes are sent out to outdated Discord versions
  • In-app updater to keep Aliucord and your plugins up-to-date
  • Crash logging!
    • In-app crash log page to give a more native feel
    • Logs are also saved to Aliucord/crashlogs for easy access outside of the app

📲 Installation

GitHub Workflow Status GitHub Workflow Status
  1. Download and install Installer-release.apk from the builds branch
  2. Open the newly installed "Aliucord Installer" app from your app drawer
  3. Click "Install", then choose the "Download" option
    • ⚠️ DO NOT USE "From installed app" OR "From storage" UNLESS YOU KNOW WHAT YOU'RE DOING, OTHERWISE ALIUCORD WILL LIKELY NOT WORK CORRECTLY
    • If you get a 404 error change your dns to 1.1.1.1
  4. Wait for it to finish patching the Discord APK
  5. Click "Install" once prompted by Android and wait for Aliucord to finish installing
  6. If Google Play warns you about this application being unverified, ignore it as it triggers thanks to an unverified signature¹
  7. Open Aliucord, grant access to files (it needs this for finding plugins), log in to your account, and voila! Aliucord is at your fingertips!

¹ If you'd like, you can disable this warning by turning off Play Protect in Google Play's settings, it's mostly useless.

Play Protect can be turned off by tapping on your user icon in the top right of Google Play, tapping on "Play Protect," tapping on the cog icon in the top right, and finally toggling "Scan apps with Play Protect" to off. This may result in Google Play "nagging" you to re-enable it sometimes when sideloading apps.*

🔌 Plugin Installation

  1. Open your preferred file manager
  2. Navigate to your internal storage (likely /storage/emulated/0/ or /sdcard/)
  3. Look for the folder named "Aliucord" and open it
  4. Open the "plugins" folder, or if it doesn't exist, create it yourself. Remember: LOWERCASE "p"
  5. Either search GitHub or join our support server and visit the #plugin-links channel for plugins to download
  6. Visit the builds branch of any GitHub repositories you get linked to and download the ZIP files of the plugins you wish to load with Aliucord
  7. Once you've downloaded the plugins, move them into the Aliucord/plugins folder (Do not extract the zip)
  8. Open Aliucord, check the plugins tab and hopefully see your plugin(s) listed!

Hint: There is a PluginDownloader plugin that makes installing plugins a lot easier by adding download buttons to messages in either of the plugin channels

Troubleshooting

  • Try closing and then reopening Aliucord
  • Double check that Aliucord has permission to access files
  • Reinstall Aliucord, making sure to use the "Download" option

...and if none of these work, please visit our support server and go to #support for help!

🧱 Building from source

See .github/workflows/build.yml for all build steps.

⏭️ Porting Aliucord to the latest Discord version

  1. Acquire the version of the Discord APK you'd like to port Aliucord to
  2. Decompile it using Apktool
    • e.g apktool d discord-n.apk (replace n with build number)
  3. Apply manifest.patch to the AndroidManifest.xml file
  4. Rebuild the Discord APK using Apktool
    • e.g apktool b discord-n.apk (replace n with build number)
  5. Copy build/apk/AndroidManifest.xml to .assets/AndroidManifest.xml and to Aliucord/AndroidManifest.xml on your Android device
  6. Build Aliucord using ./gradlew make and copy it to Aliucord/Aliucord.zip on your Android device
  7. Open Aliucord > Settings > Updater > Top right settings > Use Aliucord.zip from storage
  8. Restart Aliucord
  9. Ensure you've got a logcat catcher ready to go
  10. Open Aliucord and fix any errors that show in logcat

aliucord's People

Contributors

aarondoet avatar hairyfred avatar js6pak avatar juby210 avatar sepruko avatar swishilicous avatar unxcepted avatar vendicated avatar wingio avatar wolfkid200444 avatar x1nto avatar zt64 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.