Automatically upload your evolve save to a gist
// ==UserScript==
// @name Automatic Evolve Save Upload to Gist
// @namespace https://github.com/Alistair1231/my-userscripts/
// @version 0.1.1
// @description Automatically upload your evolve save to a gist
// @author Alistair1231
// @match https://pmotschmann.github.io/Evolve/
// @icon https://icons.duckduckgo.com/ip2/github.io.ico
// @grant GM.xmlhttpRequest
// @grant GM.setValue
// @grant GM.getValue
// @license GPL-3.0
// ==/UserScript==
// https://greasyfork.org/en/scripts/490376-automatic-evolve-save-upload-to-gist
/*
## Why This?
I lost my save game 😞. To prevent this from happening again, I implemented a quick and dirty cloud backup using a GitHub Gist.
Only export is implemented and that will most likely stay so, importing is fast and pretty rare.
## What does it do?
It makes a backup on each page load and then every 30 minutes (adjustable at the bottom of the script). The save game will be written to a gist, that is defined by the user. By using a gist, you also get the benefit of versioning. So you can roll back to earlier saves. 😉
## Security Concerns
**The API token is saved as plaintext**, so be sure to only give it the gist scope and use a token for this purpose alone so you can revoke it if necessary. Better safe than sorry. If you are really paranoid, make a GitHub account only for this purpose. I don't want to implement encryption, that sounds like a hassle, and then you have the new issue of loosing that password as well as having to always enter it as saving the password next to the encrypted content pretty much defeats the purpose. 😁
## How to use?
On first setup you will need to manually create a GitHub API key and a Gist. That is described in an alert box when you first use the script, but since I think I remember Google having plans to remove those, I will put the description here as well.
Be aware, I usually forget to update these descriptions, so if in doubt look at the code.
Also, this is only tested on [Violenmonkey](https://violentmonkey.github.io/get-it/) and Firefox. The Browser should not matter, but some other Userscript managers might handle the GM functions differently. If something does not work, try to use Violentmonkey, or message me, if I have time I might try to help.
## Setup instructions
_(I updated the instruction last on v0.1.0)_
You will need a GistID and a Personal Access Token to use this.
Create a gist, the description does not matter, in it make a file called "save.txt" and add some random content so GitHub doesn't complain, you can do that here: https://gist.github.com
Afterwards, you can find the GistID in the URL: https://gist.github.com/{{Username}}/{{GistID}}
The Personal Access Token you have to create here: https://github.com/settings/tokens you only need the gist scope.
If you make a mistake you should be asked again, alternatively you can manually set these values in the Userscript storage.
## How does it work? (technical)
The script makes use of `GM.xmlhttpRequest` for the request and `GM.setValue`/`GM.getValue` for storing/retrieving the secrets. The timing is done with `setInterval`.
I hope I can prevent some people from loosing their save games, and allow for more easy switching between devices. 😊
*/
async function getSecrets() {
const secrets = {
gistId: await GM.getValue('gistId', ''),
token: await GM.getValue('token', '')
};
return secrets;
}
async function askForSecrets() {
// Explain to the user what's happening
alert('You will need a GistID and a Personal Access Token to use this. They will be saved as cleartext in the Userscipt storage!\n\nCreate a gist, the description does not matter, in it make a file called "save.txt" and add some random content so github doesn\'t complain, you can do that here:\nhttps://gist.github.com\nthen you can find the GistID in the URL: \nhttps://gist.github.com/{{Username}}/{{GistID}}\n\nThe Personal Access Token you have to create here: \nhttps://github.com/settings/tokens\n you only need the gist scope.\n\nIf you make a mistake you should be asked again, alternatively you can manually set these values in the Userscript storage.');
const gistId = prompt('Enter your Gist ID');
const token = prompt('Enter your GitHub Personal Access Token');
await GM.setValue('gistId', gistId);
await GM.setValue('token', token);
return await getSecrets();
}
async function tryGetSecrets() {
const secrets = await getSecrets();
if (!secrets.gistId || !secrets.token) {
return askForSecrets();
}
return secrets;
}
function makeRequest(url, payload, secrets) {
GM.xmlhttpRequest({
method: 'PATCH',
url: url,
data: payload,
headers: {
'Authorization': `token ${secrets.token}`,
'Content-Type': 'application/json',
'Accept': 'application/vnd.github.v3+json',
'X-GitHub-Api-Version': '2022-11-28'
},
onload: function (response) {
console.log('PATCH request successful:', response.responseText);
// if "message": "Bad credentials", then ask for secrets again
if (response.responseText.includes('Bad credentials')) {
askForSecrets();
}
},
onerror: function (error) {
console.error('Error making PATCH request:', error);
}
});
}
(async function () {
'use strict';
const saveString = unsafeWindow.exportGame();
// Define the payload for the PATCH request
const payload = JSON.stringify({
files: {
'save.txt': {
content: saveString
}
}
});
tryGetSecrets().then((secrets) => {
// Define the URL for the PATCH request
const url = `https://api.github.com/gists/${secrets.gistId}`;
// run every 30 minutes
setInterval(makeRequest(url, payload, secrets), 1000 * 60 * 30);
});
})();