ScreenFlow

Open-Source Emulators Frontend, with full HyperSpin configuration support.

Chat Support

Windows	Linux	OSX

DESCRIPTION

ScreenFlow is a simple open-source games emulators frontend.

ScreenFlow is written in C++, using the famous Qt framework. It contains frontend standard and extra features :

• Navigate through several systems and games with animated menus.
• Each system and game can have their own animation theme.
• Themes, settings and databases are fully compatible with HyperSpin ones.
• Use FFmpeg for video and audio playback.
• Launch games in emulators with predefined configurations.
• User can remotely control the frontend using JSON-RPC protocol.

ScreenFlow uses Doxygen for online development documentation.

For more informations, please see the Wiki, or you can go to Official ScreenZone forum.

SYSTEM REQUIREMENTS

Windows	Linux	OSX	Android
32/64bits	32/64bits	64bits	ARMv7

RELEASE INSTALLATION

If you want to install from releases, go to Releases page.

SOURCES INSTALLATION

You may first need to install some additional development packages for your OS.

Get the source code

git clone https://github.com/ScreenZoneProjects/ScreenFlow.git
cd ScreenFlow
#Use the command below to work on last stable version commit
git checkout tags/latest
git submodule update --init --recursive

Build ScreenFlow

• Using qmake

qmake <options> -o Makefile ScreenFlow.pro

• Using cmake

cmake <options> -o Makefile ScreenFlow.pro

Build options

By default, the Makefile generated will be available to build ScreenFlow for your current system as release environment. The default destination directory is build/<YOUR_SYSTEM>/release. Here are the options to customize your Makefile generation:

• BUILD_DIR = (String) The build destination directory (default: build)
• WIN_DIR = (String) The Windows build directory (default: Windows)
• OSX_DIR = (String) The OSX build directory (default: MacOSX)
• LINUX_DIR = (String) The Linux build directory (default: Linux)
• DEBUG = (Boolean) Set debug environment (default: false)
• ARCH = (String x86_64 | x64) Set build archithecture. Works only with Windows/Linux builds, OSX is by default only in x64 and android only in armv7 (default: x86_64)
• INSTALL_DIR = (String) The installation directory (defaut: /usr/local for Linux, /Applications for OSX and C:\Program Files for Windows)

RUNNING

Just launch the ScreenFlow executable file, that's all !

OpenSpin has GUI, but also a Command-Line Interface :

Show help

$ ScreenFlow -h

Show application current version

$ ScreenFlow -v

JSON-RPC Configuration

WIP...

Launch a game using CLI

WIP...

DOCUMENTATION

If you're looking for some documentation about ScreenFlow, you can use :

• The wiki project section
• The auto-generated documentation from sources

CONTRIBUTE

If you'd like to contribute to ScreenFlow, start by forking the repo on GitHub:

http://github.com/ScreenZoneProjects/ScreenFlow

ScreenFlow uses the Git-flow as Git workflow model, so to add new features, follow theses steps:

1. Fork this repo from develop branch
2. Clone down your fork
3. Create a new personal feature branch "feature/your-branch"
4. Code !
5. Test your code using gmake
6. If the feature is really awesome, don't forget to add it in the README.md file
7. Don't change any version number, it will be made later by repo owners
8. Push the branch up to GitHub
9. Send a pull request to the ScreenZoneProjects/ScreenFlow project on develop branch

LICENSE

ScreenFlow is under GPLv3 license, for more informations you can read the LICENSE.txt file.