2022-03-08 18:04:09 +08:00
|
|
|
[中文](https://github.com/FEX-Emu/FEX/blob/main/docs/Readme_CN.md)
|
2019-07-13 02:41:34 -07:00
|
|
|
# FEX - Fast x86 emulation frontend
|
2021-03-21 01:53:51 -07:00
|
|
|
FEX allows you to run x86 and x86-64 binaries on an AArch64 host, similar to qemu-user and box86.
|
|
|
|
|
It has native support for a rootfs overlay, so you don't need to chroot, as well as some thunklibs so it can forward things like GL to the host.
|
|
|
|
|
FEX presents a Linux 5.0 interface to the guest, and supports both AArch64 and x86-64 as hosts.
|
|
|
|
|
FEX is very much work in progress, so expect things to change.
|
|
|
|
|
|
2022-01-03 16:05:05 -08:00
|
|
|
|
|
|
|
|
## Quick start guide
|
|
|
|
|
### For Ubuntu 20.04, 21.04, 21.10, 22.04
|
|
|
|
|
Execute the following command in the terminal to install FEX through a PPA.
|
|
|
|
|
|
2022-02-09 14:01:48 -08:00
|
|
|
`curl --silent https://raw.githubusercontent.com/FEX-Emu/FEX/main/Scripts/InstallFEX.py --output /tmp/InstallFEX.py && python3 /tmp/InstallFEX.py && rm /tmp/InstallFEX.py`
|
2022-01-03 16:05:05 -08:00
|
|
|
|
|
|
|
|
This command will walk you through installing FEX through a PPA, and downloading a RootFS for use with FEX.
|
|
|
|
|
|
|
|
|
|
Ubuntu PPA is updated with our monthly releases.
|
|
|
|
|
|
|
|
|
|
### For everyone else
|
2022-03-29 11:27:43 +02:00
|
|
|
Please see [Building FEX](#building-fex).
|
2022-01-03 16:05:05 -08:00
|
|
|
|
2021-03-21 01:53:51 -07:00
|
|
|
## Getting Started
|
|
|
|
|
FEX has been tested to build and run on ARMv8.0, ARMv8.1+, and x86-64(AVX or newer) hardware.
|
|
|
|
|
ARMv7 and older x86 hardware will not work.
|
|
|
|
|
Expected operating system usage is Linux. FEX has been tested with Ubuntu 20.04, 20.10, and 21.04. Also Arch Linux.
|
2022-01-03 16:05:05 -08:00
|
|
|
|
2021-03-21 01:53:51 -07:00
|
|
|
On AArch64 hosts the user **MUST** have an x86-64 RootFS [Creating a RootFS](#RootFS-Generation).
|
2019-07-13 02:41:34 -07:00
|
|
|
|
2021-03-30 11:38:33 +03:00
|
|
|
### Navigating the Source
|
|
|
|
|
See the [Source Outline](docs/SourceOutline.md) for more information.
|
|
|
|
|
|
2021-03-21 01:53:51 -07:00
|
|
|
### Building FEX
|
2022-09-02 10:43:07 -07:00
|
|
|
Follow the guide on the official FEX-Emu Wiki [here](https://wiki.fex-emu.com/index.php/Development:Setting_up_FEX).
|
2021-03-21 01:53:51 -07:00
|
|
|
|
|
|
|
|
### RootFS generation
|
|
|
|
|
AArch64 hosts require a rootfs for running applications.
|
|
|
|
|
Follow the guide on the wiki page for seeing how to set up the rootfs from scratch
|
2022-09-02 10:43:07 -07:00
|
|
|
https://wiki.fex-emu.com/index.php/Development:Setting_up_RootFS
|
2019-07-13 02:41:34 -07:00
|
|
|
|
|
|
|
|
|
