summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author྅༻ Ǭɀħ ༄༆ཉ <ozh@ozh.org>2019-10-27 14:04:41 +0100
committerGitHub <noreply@github.com>2019-10-27 14:04:41 +0100
commit3238e2a9eb10cef50aeea2e4f2ddb89ce3e877da (patch)
tree8e86d98e9dd9680c4832a5a5a31387673735c536
parent7dc979d2b49ff73201235cfe428bbeec94d44180 (diff)
Update readme with update instructions
-rw-r--r--README.md39
1 files changed, 34 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1204a42..9ffa3f0 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,39 @@
-cookieclicker
-=============
+# cookieclicker
-<img src="img/perfectCookie.png">
+<img src="img/perfectCookie.png" width="128">
The original game can be found at http://orteil.dashnet.org/cookieclicker/
-This copy for, errrr, like, educational purpose.
+This mirror for, errrr, like, educational purpose, either to download for your own offline education or to be played online from http://ozh.github.io/cookieclicker/ if you cannot "educate" yourself on the original URL
-Download a copy of this if you want to "educate" yourself offline, or go to http://ozh.github.io/cookieclicker/ if you cannot "educate" yourself on the original URL.
+### How to update
+
+If the original game updates, here is how you can update the mirror:
+
+#### 1. Fetch all new images :
+
+from the `/img/` directory :
+
+* `wget --convert-links -O index.html http://orteil.dashnet.org/cookieclicker/img/`
+* `grep -o 'href="[^/?"]*' index.html | sed 's/href="//' | sed 's/Thumbs.db//' | sed '/^[[:space:]]*$/d'> list.txt`
+* `wget -N -i list.txt -B http://orteil.dashnet.org/cookieclicker/img/`
+
+#### 2. Fetch all new sounds :
+
+Similarly, from the `/snd/` directory :
+
+* `wget --convert-links -O index.html http://orteil.dashnet.org/cookieclicker/snd/`
+* `grep -o 'href="[^/?"]*' index.html | sed 's/href="//' | sed 's/Thumbs.db//' | sed '/^[[:space:]]*$/d'> list.txt`
+* `wget -N -i list.txt -B http://orteil.dashnet.org/cookieclicker/snd/`
+
+#### 3. Update `js` and `html` files :
+
+From the root directory :
+
+* Fetch updated `js` files : `wget -N -i list.txt -B http://orteil.dashnet.org/cookieclicker/`
+* Fetch the updated `index.html` file
+* Scan `index.html` for any new `<script src` and also `main.js` for any new local javascript (eg `Game.last.minigameUrl`)
+
+#### 4. Report update here :)
+
+If you happen to update, please make a pull request for others to benefit, thanks!