mirror of
https://github.com/flyinghead/flycast.git
synced 2026-11-07 09:16:10 -10:00
vkedwardli
b777c15fdc
Document install commands for stable, master, and nightly dev channels. Link to tap instructions and adjust installation section formatting. [ci skip]
108 lines
4.7 KiB
Markdown
108 lines
4.7 KiB
Markdown
# Flycast
|
|
|
|
[](https://github.com/flyinghead/flycast/actions/workflows/android.yml)
|
|
[](https://github.com/flyinghead/flycast/actions/workflows/c-cpp.yml)
|
|
[](https://github.com/flyinghead/flycast/actions/workflows/switch.yml)
|
|
[](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml)
|
|
[](https://github.com/flyinghead/flycast/actions/workflows/bsd.yml)
|
|
|
|
<img src="shell/linux/flycast.png" alt="flycast logo" width="150"/>
|
|
|
|
**Flycast** is a multi-platform Sega Dreamcast, Naomi, Naomi 2, and Atomiswave emulator derived from [**reicast**](https://github.com/skmp/reicast-emulator).
|
|
|
|
Information about configuration and supported features can be found on [**TheArcadeStriker's flycast wiki**](https://github.com/TheArcadeStriker/flycast-wiki/wiki).
|
|
|
|
Join us on our [**Discord server**](https://discord.gg/X8YWP8w) for a chat.
|
|
|
|
## Downloads      
|
|
|
|
Get builds for your system from the [**builds page**](https://flyinghead.github.io/flycast-builds/) or [**GitHub Releases**](https://github.com/flyinghead/flycast/releases).
|
|
|
|
- **Latest master builds:** regular builds from the `master` branch with recent fixes and updates.
|
|
- **Nightly dev builds:** experimental builds with the latest features and changes.
|
|
- **Stable tagged releases:** versioned release builds published on GitHub Releases.
|
|
|
|
Automated test results are available from the builds page as well.
|
|
|
|
## Install
|
|
|
|
### Android 
|
|
|
|
 Install Flycast from [**Google Play**](https://play.google.com/store/apps/details?id=com.flycast.emulator).
|
|
|
|
### Flatpak (Linux )
|
|
|
|
1. [Set up Flatpak](https://www.flatpak.org/setup/).
|
|
|
|
2. Install Flycast from [Flathub](https://flathub.org/apps/details/org.flycast.Flycast):
|
|
|
|
 `flatpak install -y org.flycast.Flycast`
|
|
|
|
3. Run Flycast:
|
|
|
|
 `flatpak run org.flycast.Flycast`
|
|
|
|
### Homebrew (macOS )
|
|
|
|
1. [Set up Homebrew](https://brew.sh) or run `brew update` if already installed.
|
|
|
|
2. Choose one channel:
|
|
|
|
| Channel | Install command |
|
|
| -------------------- | ------------------------------------------------------- |
|
|
| Master (recommended) | `brew install --cask flyinghead/flycast/flycast@master` |
|
|
| Stable | `brew install --cask flyinghead/flycast/flycast` |
|
|
| Nightly dev | `brew install --cask flyinghead/flycast/flycast@dev` |
|
|
|
|
3. Run Flycast from your Application folder
|
|
|
|
 See the <a href="https://github.com/flyinghead/homebrew-flycast#readme">Flycast tap</a> for updating, uninstalling, and switching channels.
|
|
|
|
### iOS
|
|
|
|
 Due to persistent harassment from an iOS user, support for this platform has been dropped.
|
|
|
|
### Xbox One/Series 
|
|
|
|
 Grab the latest build from [**the builds page**](https://flyinghead.github.io/flycast-builds/), or the [**GitHub Actions**](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml). Then install it using the **Xbox Device Portal**.
|
|
|
|
## Build from source
|
|
|
|
### macOS
|
|
|
|
 Right-click the bootstrap script and choose **Open**:
|
|
|
|
 `shell/apple/generate_xcode_project.command`
|
|
|
|
### Windows
|
|
|
|
 Double-click the bootstrap script:
|
|
|
|
 `shell\windows\generate_vs_project.bat`
|
|
|
|
### Linux
|
|
|
|
#### Dependencies
|
|
|
|
- **C/C++ compiler toolchain** (e.g. `gcc`/`g++`)
|
|
- **CMake**
|
|
- **make**
|
|
- **libcurl** (development headers)
|
|
- **libudev** (development headers)
|
|
- **SDL2** (development headers)
|
|
- **Graphics API**: Vulkan, OpenGL
|
|
|
|
#### Build
|
|
|
|
```
|
|
$ git clone --recursive https://github.com/flyinghead/flycast.git
|
|
$ cd flycast
|
|
$ mkdir build && cd build
|
|
$ cmake ..
|
|
$ make
|
|
```
|
|
|
|
## Packaging status
|
|
|
|
[](https://repology.org/project/flycast/versions)
|