Giter Club home page Giter Club logo

decaf-emu's Introduction

Build status Build Status

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 at #wiiu-emu on freenode.

Requirements

  • Windows with Visual Studio 2017 Update 3
  • Linux with a modern C++17 friendly compiler
  • 64 bit
  • OpenGL 4.5
  • CMake v3.2+

Compatibility

  • None

Support

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

Binaries

The latest Windows AppVeyor build is available from:

Building from Source

This project makes use of submodules, please ensure you have cloned them properly using:

  • git submodule update --init

There are two decaf frontends:

  • decaf-sdl - Default emulator target using SDL for window creation and input.
  • decaf-cli - Command line only which will run games with no graphics or inputs, useful for test .rpx files.

Windows with VS2017

  • Use CMake to generate a solution

Linux

  • cmake ../decaf-emu && make
  • It is suggested (but optional) to use your system's zlib, sdl2 and glbinding
  • You can enable building with valgrind with -DDECAF_VALGRIND=ON, this requires valgrind to be installed on your system
  • Requires a modern gcc or clang which supports C++17 features

Running

./decaf-sdl play <path to game>

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.

decaf-emu's People

Contributors

achurch avatar adubbz avatar aliaspider avatar archshift avatar bleizo avatar brett19 avatar carlkenner avatar comex avatar cornytrace avatar creepermario avatar degasus avatar exjam avatar jlachniet avatar kinnay avatar l0ud avatar linkmauve avatar lioncash avatar mdeguzis avatar petmac avatar rozelette avatar sepalani avatar takhlaq avatar tilka avatar ttay24 avatar velocityra avatar zhuowei avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.