CI/README.md

# 🍋 The Official Citron-CI

[![GitHub Downloads](https://img.shields.io/github/downloads/citron-neo/CI/total?logo=github&label=GitHub%20Downloads)](https://github.com/citron-neo/CI/releases/latest)
[![Build Citron (Nightly)](https://github.com/citron-neo/CI/actions/workflows/build_nightly.yml/badge.svg)](https://github.com/citron-neo/CI/actions/workflows/build_nightly.yml)
[![Build Citron (Stable)](https://github.com/citron-neo/CI/actions/workflows/build_stable.yml/badge.svg)](https://github.com/citron-neo/CI/actions/workflows/build_stable.yml)

## Star History

<a href="https://www.star-history.com/#citron-neo/CI&type=date&legend=top-left">
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=citron-neo/CI&type=date&theme=dark&legend=top-left" />
   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=citron-neo/CI&type=date&legend=top-left" />
   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=citron-neo/CI&type=date&legend=top-left" />
 </picture>
</a>

---

This repository makes Nightly builds for **x86_64** (Standard), **x86_64_v3** (CPU's that are from 2013+) & **aarch64** on Linux, and also Windows, Android & macOS builds! These builds are all produced @ 12 AM UTC every single day.

Would you like to submit a compatibility report for the emulator? You can do so here:

* [Submit Compatibility Report](https://github.com/citron-neo/Citron-Compatability)

---

Direct links for other information you may need can also be found below:

* [Latest Commits Can Be Found Here](https://github.com/citron-neo/emulator/commits/main)

* [Latest Android Nightly Release](https://github.com/citron-neo/CI/releases/tag/nightly-android)

* [Latest Linux Nightly Release](https://github.com/citron-neo/CI/releases/tag/nightly-linux)

* [Latest Windows Nightly Release](https://github.com/citron-neo/CI/releases/tag/nightly-windows)

* [Latest macOS Nightly Release](https://github.com/citron-neo/CI/releases/tag/nightly-macos)

---

# READ THIS IF YOU HAVE ISSUES

If you are on wayland (specially GNOME wayland) and get freezes or crashes, you are likely affected by this issue that affects all Qt6 apps: https://github.com/citron-neo/CI/issues/50

To fix it simply set the env variable `QT_QPA_PLATFORM=xcb`

**Also, are you looking for AppImages of other emulators? Check:** [AnyLinux-AppImages](https://pkgforge-dev.github.io/Anylinux-AppImages/) 

----

AppImage made using [sharun](https://github.com/VHSgunzo/sharun), which makes it extremely easy to turn any binary into a portable package without using containers or similar tricks.

**These AppImages bundle everything and should work on any Linux distro, even on musl based ones.**

It is possible that the AppImages may fail to work with appimagelauncher, we recommend these alternatives instead: 

* [AM](https://github.com/ivan-hc/AM) `am -i citron` or `appman -i citron`

* [dbin](https://github.com/xplshn/dbin) `dbin install citron.appimage`

* [soar](https://github.com/pkgforge/soar) `soar install citron`

These AppImages works without fuse2 as it can use fuse3 instead, it can also work without fuse at all thanks to the [uruntime](https://github.com/VHSgunzo/uruntime)

<details>
  <summary><b><i>raison d'être</i></b></summary>
    <img src="https://github.com/user-attachments/assets/d40067a6-37d2-4784-927c-2c7f7cc6104b" alt="Inspiration Image">
  </a>
</details>

**The following information above and the creation of the AppImages Citron currently creates & distributes derives from Pkgforges previous work. You can find their repository here: https://github.com/pkgforge-dev/Citron-AppImage**

---

Thank-you for being apart of & using Citron, we value all members of the community whom help shape the emulator into what it is today!
- The Citron Team