mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-22 14:15:38 +00:00
Updated the download links to the macOS release of v1.0.0-rc
Also made some other documentation updates, mostly related to macOS.
This commit is contained in:
parent
898a66aa14
commit
a8284bea5c
|
@ -10,10 +10,14 @@ And a thorough review of [es_systems.cfg_unix](resources/templates/es_systems.cf
|
||||||
|
|
||||||
As for rbsimple-DE there are quite some missing graphic files and other customizations for a number of game systems. Check out [MISSING.md](themes/rbsimple-DE/MISSING.md) for more details on what needs to be added or updated. Note that although rbsimple-DE is based on Recalbox Multi, it's only possible to use assets from this theme set created before its change to a more restrictive license, which happened in 2018. As such it's unfortunately necessary to recreate all the system graphics from scratch that have since been released by the Recalbox community.
|
As for rbsimple-DE there are quite some missing graphic files and other customizations for a number of game systems. Check out [MISSING.md](themes/rbsimple-DE/MISSING.md) for more details on what needs to be added or updated. Note that although rbsimple-DE is based on Recalbox Multi, it's only possible to use assets from this theme set created before its change to a more restrictive license, which happened in 2018. As such it's unfortunately necessary to recreate all the system graphics from scratch that have since been released by the Recalbox community.
|
||||||
|
|
||||||
|
Another area where help is really needed is for creation of installation instruction videos and similar. There are some rudimentary videos available at the ES-DE [YouTube channel](https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ), but proper videos with voice-over and similar are needed to help especially new ES-DE users. However the videos don't need to be located at this YouTube channel. I have zero interest in creating videos or maintaining a channel of my own, there's simply a need to have video instructions available somewhere. So if you can create good videos and prefer to use your own YouTube channel, I will link to them from this repository and from https://es-de.org.
|
||||||
|
|
||||||
The ES-DE development is tracked using a Kanban board which is publicly visible at the GitLab project site:
|
The ES-DE development is tracked using a Kanban board which is publicly visible at the GitLab project site:
|
||||||
|
|
||||||
[https://gitlab.com/leonstyhre/emulationstation-de/-/boards](https://gitlab.com/leonstyhre/emulationstation-de/-/boards)
|
[https://gitlab.com/leonstyhre/emulationstation-de/-/boards](https://gitlab.com/leonstyhre/emulationstation-de/-/boards)
|
||||||
|
|
||||||
|
You can contact me (Leon) via email, either at info@es-de.org or alternatively using the address I use for my code commits.
|
||||||
|
|
||||||
### High level release plan
|
### High level release plan
|
||||||
|
|
||||||
This plan is under constant review so expect it to change from time to time. Still it should give some feeling for which direction to move and what to work on first. These are only the larger topics, there are of course many smaller changes and improvements in addition to these.
|
This plan is under constant review so expect it to change from time to time. Still it should give some feeling for which direction to move and what to work on first. These are only the larger topics, there are of course many smaller changes and improvements in addition to these.
|
||||||
|
|
30
INSTALL.md
30
INSTALL.md
|
@ -371,7 +371,7 @@ Curl could optionally be installed too, but normally the version shipped with ma
|
||||||
|
|
||||||
Install VLC/libVLC as well:
|
Install VLC/libVLC as well:
|
||||||
```
|
```
|
||||||
brew cask install vlc
|
brew install --cask vlc
|
||||||
```
|
```
|
||||||
|
|
||||||
**Some additional/optional steps:**
|
**Some additional/optional steps:**
|
||||||
|
@ -422,13 +422,35 @@ export DYLD_LIBRARY_PATH=/Applications/VLC.app/Contents/MacOS/lib
|
||||||
|
|
||||||
**Note:** According to the SDL documentation, there could be issues with attempting to run ES-DE from the build directory when using a High DPI display as the required NSHighResolutionCapable key is not set as there is no Info.plist file available. In this case, doing a 'make install' and running from the installation folder would solve the problem. I've been unable to verify if this is really required though.
|
**Note:** According to the SDL documentation, there could be issues with attempting to run ES-DE from the build directory when using a High DPI display as the required NSHighResolutionCapable key is not set as there is no Info.plist file available. In this case, doing a 'make install' and running from the installation folder would solve the problem. I've been unable to verify if this is really required though.
|
||||||
|
|
||||||
|
Be aware that the approach taken for macOS has the limitation that you can't build for previous operating system versions. You can certainly set CMAKE_OSX_DEPLOYMENT_TARGET to whatever version you like, but the problem is that the Homebrew libraries will most likely not work on earlier macOS versions. In theory this can be worked around by building all these libraries yourself with a lower deployment target, but it's hardly worth the effort. It's better to build on the lowest OS version that should be supported and rely on forward compatibility.
|
||||||
|
|
||||||
|
**Code signing:**
|
||||||
|
|
||||||
|
Due to the Apple notarization requirement implemented as of macOS 10.14.5 a build with simple code signing is needed for versions up to 10.13 and another build with both code signing and notarization will be required for versions 10.14 and higher.
|
||||||
|
|
||||||
|
macOS code signing is beyond the scope of this document but a short summary is that signing works as intended and can be enabled by uncommenting the following lines in the es-app/CMakeLists.txt file:
|
||||||
|
```
|
||||||
|
# Uncomment the following lines and change to your certificate identity to enable code signing.
|
||||||
|
#set(CPACK_BUNDLE_APPLE_CERT_APP "Developer ID Application: <identity>")
|
||||||
|
#if(${CMAKE_OSX_DEPLOYMENT_TARGET} VERSION_GREATER 10.13)
|
||||||
|
# set(CPACK_BUNDLE_APPLE_CODESIGN_PARAMETER "--deep --force --options runtime")
|
||||||
|
#endif()
|
||||||
|
```
|
||||||
|
|
||||||
|
**Legacy build:**
|
||||||
|
|
||||||
|
Normally ES-DE is meant to be built for macOS 10.14 and higher, but a legacy build for earlier operating system versions can be enabled. This has been tested with a minimum version of 10.11 and it's unclear if it works with even older macOS versions.
|
||||||
|
|
||||||
|
To enable a legacy build, change the CMAKE_OSX_DEPLOYMENT_TARGET variable in CMakeLists.txt from 10.14 to whatever version you would like to build for. This will disable Hardened Runtime if signing is enabled and it will add 'legacy' to the DMG installer file name when running CPack.
|
||||||
|
|
||||||
|
You also need to modify es-app/assets/EmulationStation-DE_Info.plist and set the key SMinimumSystemVersion to the version you're building for.
|
||||||
|
|
||||||
**Installing:**
|
**Installing:**
|
||||||
|
|
||||||
As macOS does not have any package manager which would have handled the library dependencies, we need to bundle the required shared libraries with the application. Copy the following .dylib files from their respective installation directories to the emulationstation-de build directory:
|
As macOS does not have any package manager which would have handled the library dependencies, we need to bundle the required shared libraries with the application. Copy the following .dylib files from their respective installation directories to the emulationstation-de build directory:
|
||||||
|
|
||||||
```
|
```
|
||||||
libSDL2-2.0.0.dylib
|
libSDL2-2.0.0.dylib
|
||||||
libcurl.4.dylib
|
|
||||||
libfreeimage.dylib
|
libfreeimage.dylib
|
||||||
libfreetype.6.dylib
|
libfreetype.6.dylib
|
||||||
libpng16.16.dylib
|
libpng16.16.dylib
|
||||||
|
@ -436,6 +458,8 @@ libvlc.dylib
|
||||||
libvlccore.dylib
|
libvlccore.dylib
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The first four would normally be installed by Homebrew under /usr/local/lib and the VLC libraries should be installed under /Applications/VLC.app/Contents/MacOS/lib/
|
||||||
|
|
||||||
Note that the filenames could be slightly different depending on what versions you have installed on your system.
|
Note that the filenames could be slightly different depending on what versions you have installed on your system.
|
||||||
|
|
||||||
For libfreetype there is a dependency on libpng and you need to rewrite the rpath to point to the local directory, otherwise any generated installation package will not work on other computers. Make sure that you have write permissions to libfreetype.6.dylib before attempting to run this:
|
For libfreetype there is a dependency on libpng and you need to rewrite the rpath to point to the local directory, otherwise any generated installation package will not work on other computers. Make sure that you have write permissions to libfreetype.6.dylib before attempting to run this:
|
||||||
|
@ -446,7 +470,7 @@ install_name_tool -change /usr/local/opt/libpng/lib/libpng16.16.dylib @rpath/lib
|
||||||
install_name_tool -add_rpath @executable_path libfreetype.6.dylib
|
install_name_tool -add_rpath @executable_path libfreetype.6.dylib
|
||||||
```
|
```
|
||||||
|
|
||||||
Verify that it worked as expected by running `otool -L libfreetype.6.dylib`. You should see something like the following:
|
Verify that it worked as expected by running `otool -L libfreetype.6.dylib` - you should see something like the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
libfreetype.6.dylib:
|
libfreetype.6.dylib:
|
||||||
|
|
|
@ -5,7 +5,7 @@ EmulationStation Desktop Edition is a front-end for browsing and launching games
|
||||||
Web site:\
|
Web site:\
|
||||||
[https://es-de.org](https://es-de.org)
|
[https://es-de.org](https://es-de.org)
|
||||||
|
|
||||||
YouTube channel:\
|
YouTube channel with installation instruction videos:\
|
||||||
[https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ](https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ)
|
[https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ](https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ)
|
||||||
|
|
||||||
|
|
||||||
|
@ -23,6 +23,7 @@ The current version 1.0 has been tested on the following operating systems (all
|
||||||
* OpenBSD 6.8 (limited testing only)
|
* OpenBSD 6.8 (limited testing only)
|
||||||
* macOS 11 "Big Sur" (limited testing only)
|
* macOS 11 "Big Sur" (limited testing only)
|
||||||
* macOS 10.15 "Catalina" (limited testing only)
|
* macOS 10.15 "Catalina" (limited testing only)
|
||||||
|
* macOS 10.14 "Mojave" (limited testing only)
|
||||||
* macOS 10.11 "El Capitan"
|
* macOS 10.11 "El Capitan"
|
||||||
* Windows 10
|
* Windows 10
|
||||||
* Windows 8.1
|
* Windows 8.1
|
||||||
|
@ -43,7 +44,8 @@ The latest available release is v1.0.0-rc (release candidate) from 2021-04-05.
|
||||||
| :------------------ | :------------------------------------------------------ | :----------- | :------------- |
|
| :------------------ | :------------------------------------------------------ | :----------- | :------------- |
|
||||||
| Debian DEB package | Ubuntu 20.04 and 20.10, Linux Mint 20, possibly others | x64 (x86) | [emulationstation-de-1.0.0-rc-x64.deb](https://es-de.org/releases/beta/Linux/emulationstation-de-1.0.0-rc-x64.deb)|
|
| Debian DEB package | Ubuntu 20.04 and 20.10, Linux Mint 20, possibly others | x64 (x86) | [emulationstation-de-1.0.0-rc-x64.deb](https://es-de.org/releases/beta/Linux/emulationstation-de-1.0.0-rc-x64.deb)|
|
||||||
| Fedora RPM package | Fedora Workstation 33, possibly others | x64 (x86) | [emulationstation-de-1.0.0-rc-x64.rpm](https://es-de.org/releases/beta/Linux/emulationstation-de-1.0.0-rc-x64.rpm)|
|
| Fedora RPM package | Fedora Workstation 33, possibly others | x64 (x86) | [emulationstation-de-1.0.0-rc-x64.rpm](https://es-de.org/releases/beta/Linux/emulationstation-de-1.0.0-rc-x64.rpm)|
|
||||||
| macOS DMG installer | macOS 10.11 "El Capitan" to 11 "Big Sur" | x64 (x86) | [EmulationStation-DE-1.0.0-rc-x64.dmg](https://es-de.org/releases/beta/macOS/EmulationStation-DE-1.0.0-rc-x64.dmg)|
|
| macOS DMG installer | macOS 10.14 "Mojave" to 11 "Big Sur" | x64 (x86) | [EmulationStation-DE-1.0.0-rc-x64.dmg](https://es-de.org/releases/beta/macOS/EmulationStation-DE-1.0.0-rc-x64.dmg)|
|
||||||
|
| macOS DMG installer | Legacy macOS 10.11 "El Capitan" to 10.13 "High Sierra" | x64 (x86) | [EmulationStation-DE-1.0.0-rc-x64_legacy.dmg](https://es-de.org/releases/beta/macOS/EmulationStation-DE-1.0.0-rc-x64_legacy.dmg)|
|
||||||
| Windows installer | Windows 10 and 8.1 | x64 (x86) | [EmulationStation-DE-1.0.0-rc-x64.exe](https://es-de.org/releases/beta/Windows/EmulationStation-DE-1.0.0-rc-x64.exe)|
|
| Windows installer | Windows 10 and 8.1 | x64 (x86) | [EmulationStation-DE-1.0.0-rc-x64.exe](https://es-de.org/releases/beta/Windows/EmulationStation-DE-1.0.0-rc-x64.exe)|
|
||||||
|
|
||||||
Please refer to [CHANGELOG.md](CHANGELOG.md) for more information about this release, including known issues.
|
Please refer to [CHANGELOG.md](CHANGELOG.md) for more information about this release, including known issues.
|
||||||
|
|
Loading…
Reference in a new issue