| Both sides previous revision Previous revision Next revision | Previous revision |
| es-webserver [2021/09/05 06:42] – added note about rebooting atari | es-webserver [2024/10/14 16:20] (current) – New UI and features in 41 lbrpdx |
|---|
| ====== EmulationStation Web Server ====== | ====== EmulationStation Web Server ====== |
| | |
| Emulation has an embedded webserver, mainly used internally by other services like the Content Downloader to update/refresh the games lists. | Emulation has an embedded web server, mainly used internally by other services like the Content Downloader to update/refresh the games lists. |
| |
| Starting with Batocera v32, there are some interesting features you can also take advantage of, with this embedded web server. | Starting with Batocera v32, there are some interesting features you can also take advantage of, with this embedded web server. |
| |
| ===== Setup ===== | ===== Setup ===== |
| First of all, you need to enable the webserver to accept request from your web browser. By default, it accepts only requests from your Batocera machine itself, and you won't be able to access it with a web browser. To enable it, from the main menu go to **SYSTEM SETTINGS** -> **DEVELOPER** -> **ENABLE PUBLIC WEB ACCESS**. You will need to reboot your Batocera machine. | First of all, you need to enable the web server to accept request from your web browser. By default, it accepts only requests from your Batocera machine itself, and you won't be able to access it with a web browser. To enable it, from the main menu go to **SYSTEM SETTINGS** -> **FRONTEND DEVELOPER OPTIONS** -> **ENABLE PUBLIC WEB ACCESS**. You will need to reboot your Batocera machine. |
| |
| Once this is enabled, you can point your favorite web browser to ''http://batocera:1234'' and get access to the web services menu. If this isn't working, you can try to use the IP address of your Batocera machine directly instead of the hostname ''batocera''. | Once this is enabled, you can point your favorite web browser to ''http://batocera:1234'' and get access to the web services menu. If this isn't working, you can try to use the IP address of your Batocera machine directly instead of the hostname ''batocera''. |
| When you correctly connect to ''http://batocera:1234'', you should see a screen like this one: | When you correctly connect to ''http://batocera:1234'', you should see a screen like this one: |
| |
| {{::es-webserver.png?direct&800|}} | {{::es-webserver-41.png?direct&800|}} |
| | |
| | Starting with Batocera 41, there is a refreshed UI for the web server, responsive for mobile devices and desktop screens. |
| | |
| | This UI is designed to get notifications, and to enable them, you need to go to **SYSTEM SETTINGS** -> **SERVICES** -> **ES_WEB_NOTIFIER**. Currently, it displays which game is currently running in the web UI. |
| |
| From there, you can do several actions from this web menu: | From there, you can do several actions from this web menu: |
| |
| * On the left column, you can select the Batocera system for which you want to browse games. Games are refreshed on the right side of the screen. | * The ''Systems'' button will display/hide the bar at the bottom to select systems |
| * On the right side, you can see the games that are available for the system selected. You can click on ''Play'' to launch the corresponding game on your Batocera machine. | * The ''Current'' button will display/hide the notifications box at the top |
| * The game plays on your Batocera, as if it was launched from the regular UI. You can play with your controller as usual, nothing changes here. You can also quit from your Batocera system with the usual ''[hotkey]''+''[start]'' combination, or you can also use the ''Kill running emulator'' link on the upper menu of the ES web services screen. | * Once the cards for the games are loaded, you can click on ''Play'' to launch the corresponding game on your Batocera machine (not in the browser window). |
| * If, for whatever reason, a game or an emulator is stuck, it's worth trying to use this ''Kill running emulator'' function from ES web services to get you unblocked. | * The game plays on your Batocera, as if it was launched from the regular UI. You can play with your controller as usual, nothing changes here. You can also quit from your Batocera system with the usual ''[hotkey]''+''[start]'' combination, or you can also use the ''Kill'' button in the upper bar of the ES web services screen. |
| * You can also ''Reload games'' and ''Exit EmulationStation'', the same way you would do those actions directly from the ES menu. | * If, for whatever reason, a game or an emulator is stuck, it's worth trying to use this ''Kill running emulator'' function from ES web services to get you unblocked -- reload the page in your browser if this doesn't work at once. |
| | * You can also ''Reload'' the games in EmulationStation from the menu, the same way you would do it directly from the ES menu. |
| |
| ===== Additional notes ===== | ===== Additional notes ===== |