Skip to content

Commit 919a42d

Browse files
committed
Minor corrections to SDL build/install instructions.
1 parent 8252a94 commit 919a42d

File tree

3 files changed

+22
-10
lines changed

3 files changed

+22
-10
lines changed

INSTALL

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
To compile and install FCEUX for SDL, follow the instructions in the README-SDL.md file.
1+
To compile and install FCEUX for SDL, follow the instructions in the README file.
22

33
Users of Microsoft Visual Studio can use the solution files within the vc directory. The Windows XP toolset is required to open and build this solution. If it
44
is not installed, go to "Tools" > "Get Tools and Features". Select "Individual Components" and then install "C++ Windows XP Support for VS 2017 (v141) tools".
55
These solution files will compile FCEUX and some included libraries for full functionality.
66

77
The SDL port build tool of choice has come full circle back to Cmake. The cmake build tool will compile the new Qt version of the SDL GUI.
8-
The scons build tool will build the older GTK based GUI which currently only builds on Linux.
8+
Building of the SDL fceux no longer supports use of the scons build tool.
99

README

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Updated By mjbudd77
77

88
http://www.fceux.com
99

10-
Last Modified: July 12, 2020
10+
Last Modified: October 21, 2020
1111

1212
Table of Contents
1313
-----------------
@@ -22,7 +22,7 @@ Table of Contents
2222

2323
1 - Requirements
2424
----------------
25-
* sdl2 - Version >= 2.0
25+
* sdl2 - Version >= 2.0 (sdl2 >= 2.8 recommended)
2626
* cmake - Required to build fceux.
2727
* qt5 OR gtk3 - (qt version >= 5.11 recommended) (gtk3 >= 3.22 recommended)
2828
* liblua5.1 (optional) - Will statically link internally if the system cannot provide this.
@@ -37,15 +37,19 @@ The old scons build system is no longer supported.
3737
Fceux can be compiled and built using the cmake build system. To compile, run:
3838

3939
mkdir build; cd build;
40-
cmake -DCMAKE_BUILD_TYPE=Release .. # For a release build
40+
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release .. # For a release build
4141

4242
To build a binary with debug information included in it:
43-
cmake -DCMAKE_BUILD_TYPE=Debug ..
43+
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug ..
4444

4545
The Qt version of the GUI builds by default and this is the preferred GUI for use.
4646
For those who must have GTK/Gnome style,
4747
the GTK version of the GUI can be selected to build with:
48-
cmake -DCMAKE_BUILD_TYPE=Release -DGTK=1 .. # Release build using GTK GUI
48+
cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DGTK=1 .. # Release build using GTK GUI
49+
50+
The Qt version GUI by far exceeds the GTK gui in capability and performance.
51+
I HIGHLY RECOMMEND USING THE Qt GUI instead of the GTK. See the TODO-SDL file for
52+
a capability matrix that compares what the two GUIs can do.
4953

5054
To do the actual compiling:
5155
make
@@ -58,9 +62,8 @@ After a sucessful compilation, the fceux binary will be generated to
5862

5963
sudo make install
6064

61-
You can optionally define a install prefix when running cmake from the previous step:
62-
63-
cmake -DCMAKE_INSTALL_PREFIX=/usr/local install
65+
By default cmake will use an installation prefix of /usr/local.
66+
The recommended installation prefix is /usr (this is where the installed fceux.desktop file expects everything to be)
6467

6568
You can choose to install the lua scripts (located in output/luaScripts) to a directory of your choosing:
6669

@@ -88,6 +91,13 @@ OpenGL options:
8891
For Linux builds, the OpenGL library preference can be either GLVND or LEGACY (default).
8992
To use GLVND OpenGL, add a -DGLVND=1 on the cmake command line.
9093

94+
Qt Styling Options:
95+
The Qt GUI can use custom Qt widget styling by providing it a Qt stylesheet file. At startup, the GUI will look
96+
for an environment variable named FCEUX_QT_STYLESHEET that must contain the full path to the file. If the variable
97+
is defined and the file is readable by the program, then the styling settings will be used by the GUI.
98+
Bash Shell Setup Example:
99+
export FCEUX_QT_STYLESHEET=/home/me/myQt.stylesheet
100+
91101
5 - LUA Scripting
92102
-----------------
93103
FCEUX provides a LUA 5.1 engine that allows for in-game scripting capabilities. LUA is enabled either way. It is just a matter of whether LUA is statically linked internally or dynamically linked to a system library.

TODO-SDL

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Priorities
44
* GTK GUI was not cross-platform. A Qt5 version of the GUI has been created to meet this need.
55
I will keep the GTK GUI around for Linux users who prefer it, but when it comes to adding new features
66
the Qt GUI is where I plan to add them first (if at all).
7+
* The Qt GUI has by far exceeded the capabilities of the older GTK version. Below is a GUI capability
8+
matrix showing the differences between the two. I HIGHLY RECOMMEND USING THE Qt GUI.
79
* Code cleanup. Lots of compiler warnings with newer GCC. Maybe I'm OCD... but these warnings bother me.
810

911
Features

0 commit comments

Comments
 (0)