0
0
mirror of https://git.citron-emu.org/Citron/Citron.git synced 2025-02-19 01:15:45 +00:00
1
Building For Android
Zephyron edited this page 2025-02-17 12:01:19 +00:00

Building Citron for Android

This guide will walk you through the process of building Citron for Android. These instructions are a work-in-progress, and additional resources are linked at the end.


Table of Contents

  1. Note
  2. Dependencies
  3. Cloning Citron with Git
  4. Building Citron for Android
  5. Additional Resources

Note

These build instructions are a work-in-progress and may be updated regularly. Please refer to the official Citron documentation for the most up-to-date details.


Dependencies

Required Software

  • Android Studio: The official IDE for Android development.
  • NDK 25.2.9519653 and CMake 3.22.1: For building Citron for Android.
  • Git: For version control.

Windows Only - Additional Dependencies

  • Visual Studio 2022 Community: Select the "Desktop development with C++" support during installation. Make sure to update to the latest version if it is already installed.
  • Vulkan SDK: Ensure you select the latest version of the SDK during installation.

Cloning Citron with Git

Clone the Citron repository, including its submodules, by running the following command:

git clone --recursive https://git.citron-emu.org/Citron/Citron.git

By default, Citron will be cloned to:

  • Windows: C:\Users\<user-name>\citron
  • Linux: ~/citron
  • macOS: In the directory you choose.

Building Citron for Android

Step-by-Step Guide

  1. Start Android Studio: Open Android Studio, and in the startup dialog, select Open.
  2. Open Citron Project: Navigate to the citron/src/android directory and click OK.
  3. Select Build Variant:
    • In Build > Select Build Variant, choose either release or relWithDebInfo as the Active build variant.
  4. Build the Project:
    • To build Citron for Android, go to Build > Make Project.
    • Alternatively, you can run the project on an Android device by selecting Run > Run 'app'.

Additional Resources

For more information, refer to the official Android development resources:


Additional Notes:

  • If you encounter issues or need further help with the build process, consult the Citron community or developer documentation.
  • Contributions to improve this guide are always welcome.