Commit graph

183 commits

Author SHA1 Message Date
Leon Styhre 6a547c978b Updated the documentation regarding running on a Mac with an M1/ARM CPU. 2021-06-20 16:17:12 +02:00
Leon Styhre 5d8d3473bb Updated some information about tested operating systems. 2021-05-14 19:13:27 +02:00
Leon Styhre 9e24121855 Small documentation update. 2021-05-14 15:08:43 +02:00
Leon Styhre 57a5e1ccb3 Documentation update. 2021-05-14 11:01:55 +02:00
Leon Styhre 0a1ea25779 Updated the download links for v1.0.1 in README.md 2021-05-02 12:51:58 +02:00
Leon Styhre e8e668b5aa Fixed an incorrect download link to the Windows version in README.md 2021-04-20 21:37:37 +02:00
Leon Styhre 0dd7e4c8e9 Updated the download links for v1.0.0 in README.md
Also added the release date to CHANGELOG.md
2021-04-20 21:35:45 +02:00
Leon Styhre a8284bea5c Updated the download links to the macOS release of v1.0.0-rc
Also made some other documentation updates, mostly related to macOS.
2021-04-07 19:48:52 +02:00
Leon Styhre 2c7ef502cd Updated the download links for v1.0.0-rc in README.md
Also changed the documentation to reflect that the architecture is now added to the installer and package filenames.
2021-04-05 16:01:08 +02:00
Leon Styhre 629dd9649f Added links to the ES-DE YouTube channel to the documentation files. 2021-04-03 13:30:48 +02:00
Leon Styhre 4d0120d24a Updated the download links for v1.0.0-beta3 in README.md 2021-03-26 21:41:46 +01:00
Leon Styhre c438b34dbf Updated the download links for beta2 in README.md 2021-03-14 16:06:34 +01:00
Leon Styhre e319a5362e Small documentation update. 2021-03-14 10:19:01 +01:00
Leon Styhre 6cacd22858 Documentation update. 2021-03-05 19:49:31 +01:00
Leon Styhre 10d947aa63 Added download links to v1.0.0-beta1 to README.md 2021-03-03 19:30:43 +01:00
Leon Styhre ef9fc4dd28 Removed the assets created by the Recalbox community after their change to a more restrictive license.
These assets were added by mistake a few commits ago as I was not aware that they had changed their Creative Commons license in 2018 to a NoDerivatives license. The assets now retained were either released under the old ShareAlike license, or is freely available graphics such as system logos.
2021-02-10 00:27:57 +01:00
Leon Styhre aaa63b7069 Documentation update. 2021-01-31 11:40:23 +01:00
Leon Styhre 05fbb3934b Renamed RELEASES.md to CHANGELOG.md to make the GitLab project link work. 2021-01-03 11:56:15 +01:00
Leon Styhre 606a79d075 Small documentation update. 2021-01-03 11:29:01 +01:00
Leon Styhre fb9576a94a Minor documentation update. 2020-12-30 23:23:30 +01:00
Leon Styhre 11ccba9d19 Updated README.md. 2020-12-30 11:53:49 +01:00
Leon Styhre 407d2ad374 Minor documentation update. 2020-12-26 22:31:05 +01:00
Leon Styhre 2274995404 Documentation update. 2020-12-26 21:41:26 +01:00
Leon Styhre bbb8158885 Large documentation update. 2020-12-26 16:22:33 +01:00
Leon Styhre 7a437a44e5 Documentation update. 2020-12-24 11:58:30 +01:00
Leon Styhre 6b43cdf5d6 Documentation update. 2020-12-16 19:27:51 +01:00
Leon Styhre b0366cfe49 Documentation update. 2020-12-14 17:18:35 +01:00
Leon Styhre b093a13ad1 Documentation update. 2020-11-29 20:35:33 +01:00
Leon Styhre 7f1efe14fb Small documentation update related to macOS. 2020-11-27 22:14:14 +01:00
Leon Styhre 19edfd1690 Added support for FreeBSD, NetBSD and OpenBSD. 2020-11-26 18:53:00 +01:00
Leon Styhre c71170d64a Small documentation update. 2020-11-20 16:56:56 +01:00
Leon Styhre 8cebe12b6c Small update to the README.md file and features screenshots. 2020-11-19 19:09:20 +01:00
Leon Styhre 48b44d6e25 Added some application features screenshots. 2020-11-19 18:39:25 +01:00
Leon Styhre 442aeb5038 Documentation update. 2020-11-19 17:16:23 +01:00
Leon Styhre 8aac36c9d3 Added a release plan to CONTRIBUTING.md. 2020-11-18 21:06:55 +01:00
Leon Styhre b8c6366349 (macOS) Made the game launching more seamless. 2020-08-23 18:41:08 +02:00
Leon Styhre 3c09082e3d Documentation update covering macOS. 2020-08-19 21:50:27 +02:00
Leon Styhre 2dc7884e37 Some documentation updates regarding building ES on macOS. 2020-08-17 22:12:25 +02:00
Leon Styhre 143a92cb8f Documentation update, including addition of a CONTRIBUTING.md file. 2020-07-11 17:54:30 +02:00
Leon Styhre 0387d515fb Update to fully support Clang/LLVM.
Also a general cleanup of CMakeLists.txt and many small code changes to satisfy Clang that complained quite a lot and actually wouldn't compile the binary at all at first.
2020-06-25 19:52:38 +02:00
Leon Styhre 3cfe2d8bcb Added a USERGUIDE.md document.
Also did some other minor changes to the information and documentation files.
2020-06-24 22:20:23 +02:00
Leon Styhre 6b62065595 Large code cleanup and code documentation update.
The initial code cleanup of es-app is now complete as of this commit.
2020-06-23 20:07:00 +02:00
Leon Styhre 672026632d Code cleanup and code documentation 2020-06-22 17:27:53 +02:00
Leon Styhre 67aa6b3dbd Huge code cleanup and code documentation update.
Includes lots of conversions from tabs to spaces. Only cosmetic code changes in this commit.
2020-06-21 14:25:28 +02:00
Leon Styhre 0e6b43a5a3 RBSimple-DE theme: Replaced the navigation sounds and made some other small changes.
Also added the navigation sounds to the resources directory and updated some information files.
2020-06-17 18:39:35 +02:00
Leon Styhre b0ec97007f Information and documentation files update.
Moved build and configuration information to INSTALL.md and updated several of the other info files.
2020-06-15 22:16:34 +02:00
Leon Styhre 43276ef855 Added default theme 'rbsimple-DE' and updated some information files. 2020-06-15 17:45:53 +02:00
Leon Styhre b7b4a851d3 Some small adjustments to the information and documentation files. 2020-06-14 13:16:51 +02:00
Leon Styhre 9f7d1c75c7 Updates to and additions of various information and license files.
Located all license files in a separate directory, added a preliminary coding style guide, updated the README file and created a NEWS file to track the most important changes for each release.
2020-06-14 12:55:31 +02:00
Leon Styhre fcfbbd3f2b Updated version info and documentation files 2020-05-15 18:31:59 +02:00
Cristi Mitrana 92db741c53 Define _DEBUG for Debug builds 2020-01-03 12:17:43 +02:00
Tomas Jakobsson 9de16045c9 whitespace cleanup
fix faulty line endings
silence warnings on windows
2019-08-25 17:23:02 +02:00
Cristi Mitrana 9d2f3de8a6 Minor documentation formatting and updates 2019-02-14 09:41:26 +02:00
tminit e7bc6f7006 Changed Audio settings to be much more flexible
Changed the selectable options for EmulationStation audio mixer
(called AudioDevice in EmulationStation) to be a greater range of
selectable options within Linux and RPi so that it is a lot more
flexible and will work with any aftermarket add-on audio cards and
RPi Audio HATs. Hopefully this gives people the flexibility that
they need in order to avoid the issues people have with unusual RPi
audio setups.

Added the ability to select the audio card as well, by surfacing
the audio card under the Audio Card setting. It was previously forced
to 'default' for all linux users, which was too restrictive in some
instances. This change now adds flexbility to support additional
Linux and RPi Audio Cards.

This option will only be available on Linux (and therefore RPi) as
Windows uses a different audio subsystem.

CHOOSING AUDIO ON LINUX AND RPi
You now select which ALSA Audio Card you want EmulationStation to use
by choosing the relevant AUDIO CARD option. If your one is not listed
then you can add a custom one in the es_settings.cfg file (see below).

You then select which ALSA Audio Mixer Control from that Audio Card
that you want EmulationStation to use, by choosing the relevant
AUDIO DEVICE option. (I kept the name AUDIO DEVICE as that what
EmulationStation previously used to describe an Audio Mixer.)
If your mixer name is not listed then you can add a custom one in
the es_settings.cfg file (see below).

ADDING A CUSTOM AUDIO CARD OR AUDIO DEVICE
In addition I added the ability to manually change the setting in
es_settings.cfg to add anything custom that you want. This will give
advanced users enough extra power that should avoid even the most
strange setups.

Step 1:

To add a custom Audio Card, edit the "AudioCard" setting and replace
the value with the name of your Audio Card. You can find this out by
opening a terminal window and running 'aplay -L'. This will generate a
list of Audio Cards similar to the one below:

pi@raspberrypi:~ $ aplay -L
null
    Discard all samples (playback) or generate zero samples (capture)
default:CARD=sndrpijustboomd
    snd_rpi_justboom_dac,
    Default Audio Device
sysdefault:CARD=sndrpijustboomd
    snd_rpi_justboom_dac,
    Default Audio Device
dmix:CARD=sndrpijustboomd,DEV=0
    snd_rpi_justboom_dac,
    Direct sample mixing device
dsnoop:CARD=sndrpijustboomd,DEV=0
    snd_rpi_justboom_dac,
    Direct sample snooping device
hw:CARD=sndrpijustboomd,DEV=0
    snd_rpi_justboom_dac,
    Direct hardware device without any conversions
plughw:CARD=sndrpijustboomd,DEV=0
    snd_rpi_justboom_dac,
    Hardware device with all software conversions

Select any one of the Audio Cards listed by using the first word on
the line in your AudioCard settings in the es_settings.cfg, e.g.

<string name="AudioCard" value="default" />

NOTE: If the AudioCard value is not listed, please either close and
reopen EmulationStation (the settings is created upon close if it
doesn't exist), or add it manually to the es_settings.cfg file.

Step 2:

To add a custom Audio Device (mixer), edit the "AudioDevice" setting
and replace the value with the name of your Audio Device. You can get
a list off avilable Audio Devices on the Audio Card by opening a
terminal window and running 'amixer scontrols -D <AudioCard>', where
<AudioCard> is replaced with the name of your Audio Card that you
found in Step 1.  This command will generate a list of Audio Devices
(mixers) that you can use in the AudioDevice setting in the
es_settings.cfg file, e.g.

pi@raspberrypi:~ $ amixer scontrols -D default
Simple mixer control 'DSP Program',0
Simple mixer control 'Analogue',0
Simple mixer control 'Analogue Playback Boost',0
Simple mixer control 'Auto Mute',0
Simple mixer control 'Auto Mute Mono',0
Simple mixer control 'Auto Mute Time Left',0
Simple mixer control 'Auto Mute Time Right',0
Simple mixer control 'Clock Missing Period',0
Simple mixer control 'Deemphasis',0
Simple mixer control 'Digital',0
Simple mixer control 'Max Overclock DAC',0
Simple mixer control 'Max Overclock DSP',0
Simple mixer control 'Max Overclock PLL',0
Simple mixer control 'Volume Ramp Down Emergency Rate',0
Simple mixer control 'Volume Ramp Down Emergency Step',0
Simple mixer control 'Volume Ramp Down Rate',0
Simple mixer control 'Volume Ramp Down Step',0
Simple mixer control 'Volume Ramp Up Rate',0
Simple mixer control 'Volume Ramp Up Step',0

Select any one of the Simple mixer controls listed by using the
name within the quotes within the AudioDevice setting in your
es_settings.cfg file, e.g.

<string name="AudioDevice" value="Digital" />

Using the example above, the following two settings within the
es_settings.cfg file will use the 'default' Audio Card to play
sounds, and will use the 'Digital' mixer (Audio Device) to
control the volume.

<string name="AudioCard" value="default" />
<string name="AudioDevice" value="Digital" />

NOTE: Any custom manually used settings will be overwritten if you
select any of the other options in the GUI and exit the Sound
Settings window, as the Sound Settings GUI window overwrites the
es_settings.cfg options when you exit the window.

Fix latest package renames

fonts-droid is now fonts-droid-fallback
vlc-nox is now vlc-bin

Fixed up whitespacing to project tab standard

Had not paid enough attention and had accidentally provided
whitespacing in spaces rather than the project standard of
tabs. This change fixes some additional use of spaces to
ensure all the code in the two files now uses tabs.

Vero4k autodetection and volume mixer fix
2018-08-19 21:40:49 +00:00
John Rassa bfddb95ba8
fix git submodule command 2018-04-24 23:33:03 -04:00
Tomas Jakobsson bb4c204e83 Fix the Fedora instructions 2018-02-09 18:37:40 +01:00
yodatak 5e40fb4237
Update instructions for Fedora compilation
Adding some command to compile EmulationStation on Fedora 27
2018-02-04 06:13:22 +01:00
Tomas Jakobsson 421e4a23df The final traces of boost has been eliminated 2018-01-30 19:21:09 +01:00
Benjamin Sinkula 528225a2f3 Update README to reflect Eigen3 dependency removal 2018-01-17 08:14:21 -06:00
Jools Wills 99c1ddb260 Merge pull request #235 from zigurana/KioskMode
Introducing Kiosk Mode, hiding certain menu items from the UI.
2017-09-28 18:55:14 +01:00
Jools Wills fecf345e11 added a note in the docs regarding git submodules 2017-09-28 08:34:45 +01:00
D. Polders 7a7550cde9 Introducing Kiosk UI mode, allowing users to hide menu items that might change system configuration settings. 2017-09-12 21:07:18 +02:00
Jools Wills 3d215a1f2f remove some references to old ES site and old RetroPie github from the README.md 2017-04-08 18:16:30 +01:00
fieldofcows 25e1067794 Add video view that is based on detail view but allows themes to include a video preview of the selected game along with a marquee image 2016-12-12 09:34:01 +00:00
Aloshi 08c2c561ca Merge branch 'master' of https://github.com/Aloshi/EmulationStation 2015-01-10 19:04:16 -06:00
Rob Loach a7396554bb Add SYSTEMS.md 2014-12-29 21:55:04 -05:00
Aloshi 7c48887ab3 Hide the console on Windows unless --debug is set. 2014-11-24 20:50:09 -06:00
Aloshi 9d2b7e5e66 Changed --vsync true to --vsync on.
Updated README.md.
2014-11-23 10:23:31 -06:00
Aloshi cefe9b6287 Merge branch 'utf8' into unstable 2014-11-23 09:55:57 -06:00
Aloshi 635b9f9327 FINALLY added vsync.
Defaults to on for all platforms except the RPi. Force it off with "--vsync 0".

Will try to use late swap tearing if supported on the current system.
2014-11-22 11:03:02 -06:00
Alec Lofquist dab1a12bc0 Require boost.locale. 2014-10-18 16:51:48 -05:00
Aloshi 71700bd0c9 Added <theme> tag to es_systems.cfg. 2014-06-15 12:34:22 -05:00
Aloshi ff2fd4ee80 Split gamelist.xml documentation into its own text file.
Removed signature in THEMES.md.
2014-06-05 19:00:16 -05:00
Aloshi b85876339b Removed --home-path argument.
I forgot, for weeks on end, that you can just manipulate environment variables.
2014-06-05 14:56:41 -05:00
Aloshi 28e7f357f7 Added support for multiple platforms in the <platform> tag.
You can also use any of the whitespace characters as extension delimiters now (", \n\r\t").
2014-06-03 19:42:01 -05:00
Aloshi 37db651ffa Added support for relative paths in gamelist.xmls.
Fixed default for the "rating" metadata value, so it no longer writes to the gamelist when the rating hasn't been set yet.
2014-06-02 13:13:30 -05:00
Aloshi cb54d8ae6d Changed "platform IDs" to just "platform", and now names are used instead of numerical IDs.
Check src/PlatformIds.cpp for a complete list.
2014-05-26 17:32:57 -05:00
Aloshi 78a3f94e1e Changed folder structure significantly.
The ~/.emulationstation folder is now organized into categories. Everything probably broke again.
Added support for "theme sets," instead of just one theme for each system.
Read the top of THEMES.md for more information.
Added support for reading from `/etc/emulationstation/` for themes,
gamelists, and es_systems.cfg.
Updated documentation to match.
2014-04-30 21:15:13 -05:00
Aloshi e842321b00 Removed dependency on libboost-regex.
It was kind of silly to pull in the entire lib for exactly one regular expression.
2014-04-16 12:32:40 -05:00
Aloshi 45ffbf978c Added --home-path [path] argument that redirects calls to getHomePath() to some directory [path].
Changed some existing command line arguments too:
-w and -h are now just --resolution [width] [height].
-h is now synonymous with --help.
2014-03-13 22:17:46 -05:00
Aloshi 6db26742ff Renamed all the internal "Settings" identifiers to be consistent in
capitalization style.  Probably should delete your old es_settings.cfg
file.
Removed --dimtime as an argument since you can set it internally now.
2014-03-08 13:00:18 -06:00
Aloshi fdbbf96d5e Added scrolling to ComponentList.
--no-exit works again.
Changed default screen dim time from 30 seconds to 120 seconds.
2014-03-02 10:41:02 -06:00
Aloshi 816247ac20 Changed scroll gradient to a radial gradient and made the display full
screen instead of just inside the list.
Embedded the OpenSans font as the default font instead of relying on a
platform-dependent system default.
2014-02-16 12:27:58 -06:00
Aloshi 8eb9800127 Added color tag to ImageComponent (for colorshift).
Changed TextComponent's truncation from ".." to "...".
Updated documentation.
2014-01-23 15:30:32 -06:00
Aloshi dca5467f7b Boost.Asio -> libcurl to hopefully fix the Linux bugs. 2013-10-10 13:11:01 -05:00
Aloshi e7135d869c Updated README.md and --help command. 2013-09-30 14:34:22 -05:00
Aloshi c807c98b4a Added HttpReq class based on Boost.Asio. 2013-09-15 12:56:47 -05:00
Aloshi 044619a2d3 Add ALSA package to dependency list.
Change name of example config from "NES" to "nes".
2013-08-28 14:39:29 -05:00
Aloshi a23e873f91 Update documentation to reflect move to SDL2. 2013-08-23 10:09:25 -05:00
Aloshi dbcb9aed37 Moved es_systems.cfg to use XML.
Updated README.md to reflect new format.
"descname" has been renamed to "fullname".
2013-08-13 01:56:10 -05:00
Aloshi 8bd87e162c Stop including Eigen directly in the project.
Update README.md for information on installing Eigen.
2013-07-16 22:41:39 -05:00
Bim Overbohm 4f8f2e6fa5 Update project description regarding RPI SD card issues 2013-07-10 13:31:57 +02:00
Bim Overbohm 65e65e1ac9 Update project description regarding G++ 4.7 2013-07-08 10:00:35 +02:00
Bim Overbohm 548b93dbd2 Update project description regarding issues 2013-07-05 11:23:21 +02:00
Aloshi e785a2dfe0 You can now mix and match game list detail levels.
Basically, only games that have a gamelist.xml will use the detailed view.
2013-07-02 02:04:52 -05:00
Aloshi 961fccc3f3 Updates to README.md
Somewhat better build instructions, links to Windows dependencies.
2013-05-27 15:23:25 -05:00
Aloshi 80e33849b5 Fixed a few crashes, better support for higan
Fixed AudioManager/InputManager unsigned vs signed comparison warnings.
Fixed a FolderData sorting crash (I can't believe nobody's reported
this).
Fixed a GuiTheme crash for empty paths.
Added the %ROM_RAW% tag, for the unescaped ROM name - useful for higan
on windows.
SystemData will now add folders that end in EXTENSION as GameDatas, and
not recurse through them.  Also useful for higan.
2013-05-27 12:13:38 -05:00
Bim Overbohm 30f5bf0dcf Update README
Update libraries and mention CMake and volume keys
2013-05-23 11:44:51 +02:00
Aloshi a119997ec7 Added page up/page down to the Input Config screen.
Updated the README.
2013-04-13 18:10:23 -05:00
Aloshi 0d7ac5a10a Added sleep mode/dimming. Use --dimtime [seconds] to change behavior. Default is 30, use 0 for never. 2013-03-19 09:29:44 -05:00