README.md

[![Build status](https://github.com/decaf-emu/decaf-emu/workflows/C%2FC%2B%2B%20CI/badge.svg)](https://github.com/decaf-emu/decaf-emu/actions?workflow=C%2FC%2B%2B+CI)

# decaf-emu
Researching Wii U emulation. Licensed under the terms of the GNU General Public License, version 3 or later (GPLv3+).

You can find us for developer discussion:
- on discord using https://discord.gg/tPqFBnr

<p float="left">
  <img src="https://user-images.githubusercontent.com/1302758/147675484-c0308d89-55a9-4927-8665-1826ee5d4771.png" width="250" />
  <img src="https://user-images.githubusercontent.com/1302758/147674695-d8baf6ac-87e2-487c-8358-ef1588c5e5bf.png" width="250" />
  <img src="https://user-images.githubusercontent.com/1302758/147674704-17767241-e0b4-497e-8841-aa968d14c8e3.png" width="250" />
</p>

## Requirements
- Windows with Visual Studio 2019 or newer
- Linux with a modern C++17 friendly compiler
- 64 bit only
- CMake v3.2+
- Vulkan 1.1.106.0+

## Support
- None, this is an in-development project and user support is not provided.

## Binaries
The latest Windows binaries are available via [Actions artifacts](https://github.com/decaf-emu/decaf-emu/actions).

Linux binaries are not provided.

## Running

Run the `decaf-qt` executable, it is recommended to run the emulator from the root git directory so that it is able to access `resources/fonts/*`.  Alternatively, set `resources_path` in the configuration file to point to the resources directory.

Configuration files can be found at:
- Windows - `%APPDATA%\decaf`
- Linux - `~/.config/decaf`

On Linux, a "Bus error" crash usually indicates an out-of-space error in the temporary directory.  Set the `TMPDIR` environment variable to a directory on a filesystem with at least 2GB free.

Additionally there is an SDL command line application which can be used by `./decaf-sdl play <path to game>`

## Building from Source

See [BUILDING.md](BUILDING.md)
Update README.md add a badge badges are very very important look cool very nice very professional 2019-09-27 08:21:15 +01:00			`[![Build status](https://github.com/decaf-emu/decaf-emu/workflows/C%2FC%2B%2B%20CI/badge.svg)](https://github.com/decaf-emu/decaf-emu/actions?workflow=C%2FC%2B%2B+CI)`

Because it's not a fancy project unless it has a fancy name. 2015-10-21 20:10:10 +01:00			`# decaf-emu`
New JIT implementation using libbinrec. 2017-04-01 17:04:30 +01:00			`Researching Wii U emulation. Licensed under the terms of the GNU General Public License, version 3 or later (GPLv3+).`
Create README.md 2015-07-09 00:24:04 +01:00
Updated README with Discord link. 2019-01-02 02:27:29 -08:00			`You can find us for developer discussion:`
			`- on discord using https://discord.gg/tPqFBnr`
Update README.md 2016-06-18 11:44:13 +01:00
Update README.md 2021-12-29 15:06:19 +00:00			`<p float="left">`
Update README.md 2021-12-29 15:07:30 +00:00			`<img src="https://user-images.githubusercontent.com/1302758/147675484-c0308d89-55a9-4927-8665-1826ee5d4771.png" width="250" />`
			`<img src="https://user-images.githubusercontent.com/1302758/147674695-d8baf6ac-87e2-487c-8358-ef1588c5e5bf.png" width="250" />`
			`<img src="https://user-images.githubusercontent.com/1302758/147674704-17767241-e0b4-497e-8841-aa968d14c8e3.png" width="250" />`
Update README.md 2021-12-29 15:06:19 +00:00			`</p>`

Create README.md 2015-07-09 00:24:04 +01:00			`## Requirements`
Update README.md 2021-12-29 15:06:19 +00:00			`- Windows with Visual Studio 2019 or newer`
Update README to reflect change to C++17 2017-09-20 08:36:15 +01:00			`- Linux with a modern C++17 friendly compiler`
Update README.md 2021-12-29 15:06:19 +00:00			`- 64 bit only`
Update README.md 2017-02-20 19:28:33 +00:00			`- CMake v3.2+`
Bump required cmake version to support new layer validation 2020-11-16 00:18:06 +01:00			`- Vulkan 1.1.106.0+`
Update README.md Add some basic build instructions. Also building on OS X works now with homebrew clang... cute :). 2016-02-22 13:15:28 +00:00
Update README.md 2016-09-01 15:46:38 +01:00			`## Support`
			`- None, this is an in-development project and user support is not provided.`

			`## Binaries`
Update README.md 2019-09-26 17:35:15 +01:00			`The latest Windows binaries are available via [Actions artifacts](https://github.com/decaf-emu/decaf-emu/actions).`
Update README.md 2016-09-01 15:46:38 +01:00
Update README.md 2021-12-29 15:06:19 +00:00			`Linux binaries are not provided.`
Update README.md 2016-08-05 15:20:00 +01:00
Update README.md 2021-12-29 15:06:19 +00:00			`## Running`
Update README.md 2016-08-05 15:20:00 +01:00
Update README.md 2021-12-29 15:06:19 +00:00			Run the `decaf-qt` executable, it is recommended to run the emulator from the root git directory so that it is able to access `resources/fonts/*`. Alternatively, set `resources_path` in the configuration file to point to the resources directory.
Update README.md 2016-08-05 15:20:00 +01:00
			`Configuration files can be found at:`
			- Windows - `%APPDATA%\decaf`
			- Linux - `~/.config/decaf`
posix: Use TMPDIR instead of shm_open for memory backing files. The amount of memory available for shm objects is limited on some systems, so use a normal file instead of an shm object as the backing store for emulated memory. Also document the cause and workaround for SIGBUS crashes. 2017-04-24 17:54:08 +09:00
			On Linux, a "Bus error" crash usually indicates an out-of-space error in the temporary directory. Set the `TMPDIR` environment variable to a directory on a filesystem with at least 2GB free.
Move build instructions to BUILDING.md 2018-12-15 10:12:20 +00:00
Update README.md 2021-12-29 15:06:19 +00:00			Additionally there is an SDL command line application which can be used by `./decaf-sdl play <path to game>`

Move build instructions to BUILDING.md 2018-12-15 10:12:20 +00:00			`## Building from Source`

			`See [BUILDING.md](BUILDING.md)`