ACKNOWLEDGEMENTS & LICENSE
Icon made by Freepik from www.flaticon.com.  Original software in this package is covered by the MIT License (license file can be found in this archive in mit_license.txt).


OVERVIEW
This package contains three applications:

* Turn on Overclock (overclock to 2GHz, set cpu scaling to max performance)
* Turn off overclock (return to stock settings - max frequency 1.7GHz, no overclock)
* Dolphin Emulator replacement app to start overclocking before Dolphin and return to stock settings when you exit Dolphin

Note that this package does NOT install the full dolphin emulator.  You will need to install that before installing this application.  It only augments Dolphin with the overclocking changes described above.

While overclocking for short periods of time should not harm your Switch, you are explicitly doing things with the hardware that Nintendo didn't intend.  I TAKE NO RESPONSIBILITY IF YOU HARM YOUR DEVICE BY USING THESE APPLICATIONS.


INSTALLATION INSTRUCTIONS:
* extract the contents of this entire archive in your home directory.  Assuming you saved overclock_scripts.tgz in your home directory (/home/[your username]), extract it by opening a terminal window and typing 'tar -xzf overclock_scripts.tgz'

* optional (but recommended), if you are installing the dolphin app: back up your existing non-overclocked dolphin desktop app by typing 'sudo cp /usr/share/applications/dolphin-emu.desktop $HOME/' and enter your password if prompted.  This will allow you to restore the non-overclocked version if it turns out that you want to revert to that behavior.

* if you are installing the dolphin app: type 'sudo cp overclock_scripts/extras/dolphin-emu.desktop /usr/share/applications/'.  Enter your password if prompted.

* Restart Linux for these changes to take effect.

You have now installed the applications.  You can find them as usual by clicking on the Ubuntu icon at the top of the launcher and typing 'overclock on', 'overclock off', or 'dolphin'.  If you want to add the icons to the launcher, simply search for them and then use the mouse to drag them to where you want them to live on the launcher.

USAGE:
Usage of these applications is straightforward.  To start or stop overclocking manually, simply click on the 'overclock on' or 'overclock off' icon.  If you are asked for your password, enter it.  The terminal window will stay open briefly to show the new settings, after which it will close automatically.

To use the Dolphin app, start it in exactly the same way as you would the stock Dolphin app (i.e. use search to find it or click on it in your launcher bar).  You may be prompted to enter your password either before or after dolphin is running; enter it if so.  Make sure you do this after Dolphin exits, or your Switch will remain in an overclocked state!

FAQs

1. Is there any way to set this up so that I don't need to keep enterng my password?
  * Unfortunately no.  This is a limitation of how you set up overclocking on Linux.  You need root permissions to alter the clock speed, and that requires you to enter your password each time.  

2. Is there a way I can enter my password less frequently?
  * Sort of. If you want your Switch to simply stay overclocked all the time (and don't mind the risks that come with that), you can run the overclock app when you start Linux and just leave it on.  This will require you to enter your password only the single time that you run the app (at least  until you shut down Linux).  If you choose to do this I would recommend NOT installing the Dolphin app from this package, as that would require you to keep entering your password on each Dolphin launch (as well as turning off overclocking each time it exits).

3. Is there a way to automatically turn on overclocking whenever I boot Linux?
  * Yes - there is a guide on GBATemp that will show you how to permantently overclock your Switch in Linux.  I have not personally done this (and I don't wish to), so I can't provide any further guidance than that.  If you choose to do that, you don't need any of the applications from this package.

4. Can I modify the overclock settings that these scripts use?
  * yes, if you know what you're doing and want to read up about how you tweak clock speed settings on Linux.  The scripts are in $HOME/overclock_scripts, and they are overclock_max.sh and remove_overclock.sh.

5. Is it possible to create more apps like the Dolphin app that start overclocking right before the app launches and stop it when the app closes?
  * Yes.  The general steps to do this are below and assume you have a working knowledge of navigating and editing files in Linux.
  * Find the desktop application you want to overclock in /usr/share/applications. If your application is called 'foo', then the desktop application file will be called something like 'foo.desktop'.
  * copy this file to your home directory.
  * make a backup copy of it just in case you want to restore non-overclocked functionality or screw anything up.
  * open this file and look for the line starting with "Exec=...".  Copy everything after the equals sign.  You will need this below.
  * In that same file, replace this whole line with 'Exec=sh -c "$HOME/overclock_scripts/[your application name]_overclock.sh"'.  In our example you would replace [your application name] with 'foo'.  Save this file.
  * copy overclock_scripts/overclock-dolphin.sh to a new file corresponding to your app (in our example, overclock_scripts/foo_overclock.sh).  This should match the name of the file from the previous step.
  * open the new file you just created and replace the whole line starting with "env QT_QPA_PLATFORM" with the line you copied from the .desktop file above.  Save this file.
  * Copy the updated .desktop file you created above back to /usr/share/applicatins.  You will need to do this as sudo.
  * Update the application database either by using the two commands in the installation instructions above, or just restart Linux.
  * Your Switch should now be overclocked when your app launches and returned to stock settings when it exits.
