big check in

Author: Duncan

LICENSE.txt

@@ -0,0 +1,201 @@
+# Some License Nonsense
+
+RetroCRT :: Utility suite to configure RetroPie for a CRT
+
+Copyright (C) 2019 Duncan Brown (https://github.com/xovox)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# RetroCRT
+
+Retro gaming with the $FREE [RetroPie](https://retropie.org.uk) Linux OS on a $35 [Raspberry Pi](https://www.raspberrypi.org) is pretty sweet, but instead of an HDTV... wouldn't you rather do it on a 20+ year old CRT?
+
+This project brings the above projects into one easy to swallow integration!
+
+NOTE: All games > 240p aren't currently supported since I'm focused on SD CRTs & progressive video
+
+# Supported Hardware
+
+* [RetroTink Ultimate](http://www.retrotink.com) is a board for the Raspberry Pi that gives you every analog connection you could want, in true 24-bit RGB color!
+  * Component & RGB work well
+  * S-Video & composite do not work 100%
+
+# Future Supported Hardware
+
+* Raspberry Pi built-in composite out (untested)
+* VGA666 (untested)
+
+# Pre-Built Images
+
+[The release page](https://github.com/xovox/RetroCRT/releases) has any, and all, pre-built images ready to go.
+
+# See it in action!
+
+* Installation: [![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/QwixXT4_c-0/0.jpg)](https://www.youtube.com/watch?v=QwixXT4_c-0)
+
+# What You Get
+
+* Easy installation!
+* Pixel-perfect console emulation!
+* Pixel-perfect arcade emulation for most games!
+  * This is achieved with on-load screen resolution changes!
+* Automatic rotation for vertical games!
+* Installation of CRT Friendly EmulationStation themes!
+* No system messages on boot/shutdown/reboot!
+* No annoying EmulationStation yellow text!
+* 240p test suite roms for several platforms!
+* My unbridled enthusiasm about building this project!
+
+## Emulator Compatibility
+
+I'm aiming to cover everything available, but these are the only platforms I've thoroughly tested.
+
+* arcade
+* fba
+* mame-libretro
+* mastersystem
+* megadrive
+* n64
+* neogeo
+* nes
+* pcengine
+* psx
+* retropie
+* sega32x
+* segacd
+* snes
+* supergrafx
+
+# NTSC vs SECAM & PAL
+
+Sadly, I don't have a SECAM or PAL setup to test everything on, I'll need someone else to do that for me.
+
+# Installation
+
+I'm assuming you're able to SSH in, or have a monitor & keyboard. I typically connect my Pi via Ethernet when I'm first configuring it for ease.
+
+You can also do the initial configuration with a monitor hooked up to HDMI.
+
+* [Enabling SSH](https://www.raspberrypi.org/documentation/remote-access/ssh/) on the official Raspbian docs.
+  * This is best solved by putting your SD card in another machine and creating an empty file called 'ssh' in the boot partition.
+* [Wireless Connectivity](https://www.raspberrypi.org/documentation/configuration/wireless/README.md) is an option, but I prefer wired for simplicity.
+* SSH Clients
+  * [Windows](https://www.raspberrypi.org/documentation/remote-access/ssh/windows.md)
+  * [Linux & macOS](https://www.raspberrypi.org/documentation/remote-access/ssh/unix.md)
+
+You can cut & paste this into your terminal.
+
+```
+cd &&
+git clone https://github.com/xovox/RetroCRT &&
+cd RetroCRT &&
+/bin/bash ./retrocrt_setup.sh
+```
+
+# TV Compatibility
+
+## NTSC
+
+| Make 		| Model 	| Tested 	| Issues	| Tested By
+|------		|-------	|--------	|--------	|-----------
+| Panasonic	| CT-27D10	| Component	| None          | Duncan
+
+# Troubleshooting
+
+See the [troubleshooting doc](TROUBLESHOOTING.md).
+
+# Tasks
+
+* General
+- [ ] Reorganize repo, it grew too organically so things are scattered
+- [X] Build vanilla image people can directly write to their SD card
+  * [Releases](https://github.com/xovox/RetroCRT/releases)
+
+* Rotate Display
+- [X] Configured via standard config for RetroCRT.yml
+- [ ] Installs es-dev for vertical menuing
+- [X] ROM configs set for rotation
+- [ ] Template the ROM configs for custom rotation amount
+
+* S-Video Output
+
+This has been tested & we're only getting luma, not chroma.  This will hopefully be fixed.
+
+* 480i Output
+** I'm not sure that this is even possible, but it'd be great to have high res games working at native resolution
+** I've reached out to Mike Chi about this.
+
+* Menuing
+Menu won't be named "RetroCRT", but a more generic name for all of the other RetroPie tools I'm working on
+- [X] Launched from RetroPie menu
+- [X] Updates
+- [X] Monitor Orientation
+
+* Templatizing
+- [ ] ROM configs should be symlinks to a templated config
+
+* Scripts
+- [X] Work well with other RetroPie scripts I'm writing
+- [X] Get rid of env, everything should be discrete scripts in $HOME/RetroPie/scripts/ or something
+
+* On Start Script
+- [X] Use per-emulator timings
+- [X] Use per-game timings
+
+* On End Script
+- [X] Revert to boot's hdmi_timings
+
+* Script Installer
+- [X] Write installer wrapper
+
+* Ansible Installer
+- [X] Create config.txt using template
+- [X] Push RetroArch configs
+- [X] Limit what systems we play
+- [X] Remove notification text on game start
+- [X] Install SD friendly ES themes
+
+* Configs
+- [X] /boot/config.txt settings figured out
+- [X] Custom retroarch config for each rom
+
+* Video
+- [X] Collect NTSC timings
+- [ ] Collect PAL timings
+- [X] Custom hdmi_timings for each rom via runcommand-onstart
+
+# Footnotes
+
+I am not affiliated with Mike Chi & RetroTink.
+
+Shout out to [Vykran](https://github.com/Vykyan/retroTINK-setup) for the initial groundwork, though he seems to be PAL & I'm NTSC... which brought us to where we are now.
+
+```
+                                                       .
+                                                       ;\
+                                                      /  \
+                                                      `.  i          ,^^--.
+                                                   ___  i  \        /      \              ,',^-_
+                                                  /   \ !   \       |       |            / /   /
+                                                  \   /  \   \      |       ;      ,__. |    ,'
+                                                   4 |    \   `.    |      /      (    `   __>
+                                                 ,_| |_.   \    `-__>      >.      `---'\ /
+                                                /,.   ..\   `.               `.         | |
+                                                U |   | U     `.               \    ,--~   ~--.
+--~~~~--_       _--~~~~--_       _--~~~~--_       _--~~~~--_    \  _--~~~~--_   \  /_--~~~~--_ \
+         `.   ,'          `.   ,'          `.   ,'          `.  |,'          `.  \,'          `.
+           \ /              \ /              \ /              \ /              \ /              \
+```
+
+|  |

README.md

@@ -0,0 +1,181 @@
+---
+
+##############################################################################
+# This file is part of RetroCRT (https://github.com/xovox/RetroCRT)
+#
+# RetroCRT is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# RetroCRT is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with RetroCRT.  If not, see <https://www.gnu.org/licenses/>.
+##############################################################################
+
+- hosts: "all"
+  connection: "local"
+  become: "yes"
+  become_user: "root"
+
+  pre_tasks:
+
+    - name: "Reading Configs"
+      set_fact:
+        tv_region: "{{ lookup('env', 'tv_region') }}"
+        retrocrt_timings: "{{ lookup('env', 'retrocrt_timings') }}"
+        rotate_tv: "{{ lookup('env', 'rotate_tv') }}"
+        rotate_es: "{{ lookup('env', 'rotate_es') }}"
+        rotate_ra: "{{ lookup('env', 'rotate_ra') }}"
+        segasixteen: "{{ lookup('env', 'segasixteen') }}"
+        necsixteen: "{{ lookup('env', 'necsixteen') }}"
+
+    - name: "Set Default Timings"
+      set_fact:
+        default_timings: "{{ lookup('file', '{{ retrocrt_timings }}/default') }}"
+        
+#    - name: "Are we NTSC"
+#      set_fact:
+#        segasixteen: "genesis"
+#        segasixteenfull: "Genesis"
+#      when: tv_region == "ntsc"
+
+#    - name: "Are we PAL"
+#      set_fact:
+#        segasixteen: "megadrive"
+#        segasixteenfull: "Mega Drive"
+#      when: tv_region == "pal"
+
+    - name: "Find / UUID"
+      command: "findmnt --noheadings --output PARTUUID /"
+      register: root_uuid
+
+    - name: "Find / Filesystem Type"
+      command: "findmnt --noheadings --output FSTYPE /"
+      register: root_fstype
+
+  tasks:
+
+    # vfat doesn't like the standard Ansible backup extension
+    - name: "Backup /boot Configs"
+      copy:
+        src: "/boot/{{ item }}"
+        dest: "/boot/{{ item }}.{{ ansible_date_time.epoch }}"
+      with_items:
+        - "cmdline.txt"
+        - "config.txt"
+
+    - name: "Update /boot Configs"
+      template:
+        src: "templates/{{ item }}.j2"
+        dest: "/boot/{{ item }}"
+      with_items:
+        - "cmdline.txt"
+        - "config.txt"
+
+    - name: "Update EmulationStation Startup"
+      template:
+        src: "templates/autostart.sh.j2"
+        dest: "/opt/retropie/configs/all/autostart.sh"
+
+    - name: "Create Menu Item"
+      copy:
+        src: "bin/RetroCRT.sh"
+        dest: "/home/pi/RetroPie/retropiemenu/RetroCRT.sh"
+        mode: 0755
+        owner: "pi"
+        group: "pi"
+
+    - name: "EmulationStation Systems List"
+      template:
+        src: "templates/es_systems.cfg.j2"
+        dest: "/etc/emulationstation/es_systems.cfg"
+        backup: "yes"
+        owner: "root"
+        group: "root"
+        mode: 644
+
+    - name: "Copy RetroArch Configs"
+      synchronize:
+        src: "configs/retropie/"
+        dest: "/opt/retropie/configs/"
+        rsync_opts:
+          - "--backup"
+          - "--suffix .{{ansible_date_time.epoch}}"
+
+    - name: "Copy RetroArch ROM Configs"
+      synchronize:
+        src: "configs/roms/"
+        dest: '/home/pi/RetroPie/roms/{{ item }}'
+        rsync_opts:
+          - "--backup"
+          - "--suffix .{{ansible_date_time.epoch}}"
+      with_items:
+        - "arcade"
+        - "fba"
+        - "mame-libretro"
+        - "mame-mame4all"
+
+    - name: "Disable RetroArch Notifications"
+      lineinfile:
+        dest: "/opt/retropie/configs/all/retroarch.cfg"
+        backup: "yes"
+        regexp: '^video_font_enable ='
+        line: 'video_font_enable = "false"'
+
+    - name: "Fix Permissions"
+      file:
+        path: "{{ item }}"
+        state: "directory"
+        owner: "pi"
+        group: "pi"
+        recurse: "yes"
+      with_items:
+        - "/opt/retropie"
+        - "/home/pi"
+
+    - name: "Install 240p Test Suite ROMs & ISOs"
+      synchronize:
+        src: "files/roms/"
+        dest: "/home/pi/RetroPie/roms/"
+        rsync_opts:
+          - "--exclude README.md"
+
+    - name: "Download Theme: Freeplay"
+      git:
+        repo: "https://github.com/rxbrad/es-theme-freeplay"
+        dest: "/etc/emulationstation/themes/Freeplay"
+
+    - name: "Download Theme: GBZ35"
+      git:
+        repo: "https://github.com/rxbrad/es-theme-gbz35"
+        dest: "/etc/emulationstation/themes/GBZ35"
+
+    - name: "Download Theme: GBZ35 Dark"
+      git:
+        repo: "https://github.com/rxbrad/es-theme-gbz35-dark"
+        dest: "/etc/emulationstation/themes/GBZ35-Dark"
+
+    - name: "Download Theme: TFT"
+      git:
+        repo: "https://github.com/anthonycaccese/es-theme-tft"
+        dest: "/etc/emulationstation/themes/TFT"
+
+    - name: "Download Theme: Picade"
+      git:
+        repo: "https://github.com/anthonycaccese/es-theme-picade"
+        dest: "/etc/emulationstation/themes/Picade"
+
+    - name: "Download Theme: Bubblegum"
+      git:
+        repo: "https://github.com/xovox/es-theme-bubblegum"
+        dest: "/etc/emulationstation/themes/Bubblegum"
+
+    - name: "Download Theme: Honey"
+      git:
+        repo: "https://github.com/xovox/es-theme-honey"
+        dest: "/etc/emulationstation/themes/Honey"

RetroCRT.yml

@@ -0,0 +1,15 @@
+# Video Issues
+
+## Image is too wide
+
+You're not changing the horizontal resolution before starting the emulator, this is an issue with the /opt/retropie/configs/all/runcommand-onstart.sh script.
+
+## Image is too narrow
+
+RetroArch is ignoring our custom_viewport_width setting, and probably the height as well.  This happens when you run the RetroPie updater.
+
+# Sound Issues
+
+## No Sound
+
+You don't have audio set to go out the 3.5mm jack.  This is set in RetroCRT's config.txt, it must have been overwritten.