Updated Readme for better understanding and easier development.

README.md

@@ -1,31 +1,75 @@
+
 # Waddle Penguins Desktop
 
-# This client has been originaly created for Cozy Penguin, and it no longer connects to Cozy Penguin's game servers -  as the game has closed. You can feel free to use this client for your own CPPS, as long as you attribute AltoDev.
+Client for Waddle Penguins (a CPPS) that makes playing the Flash game possible after January 12, 2021. This client does not connect to Waddle Penguins anymore, due to Waddle Penguins Classic's closure.
+Thank you for playing. You can use this client for your own CPPS, as long as you add the same acknowledgements as here.
+
+
+## Features
+
+- Automatically clearing the users' cache when the application is launched (parties and features update instantly!),
+- Discord Rich Presence support. Have a shiny Discord status when playing,
+- Embedded (Pepper) Flash Player. There's no need to install Flash manually,
+- Cross platform - works on Windows and macOS.
+
+
+## User Installation
+
+NOTE: This part was used for user installation when Waddle Penguins was still an open CPPS. If you're looking to develop a client for your own CPPS based on this source, please read "Development".
+
+Visit https://waddlepenguins.tk/play/ and follow the instructions for your PC.
+
+## Development
+
+To create a client for your CPPS using this source you will need: Git, Node.js.
+
+1. Clone the repository:
+
+```bash
+  git clone https://github.com/waddlepenguins/waddlepenguins_app
+```
+
+2. Install Node dependencies:
+
+```bash
+  npm install
+```
+
+3. Edit the files. You need to:
+- Replace the URL of mainWindow.loadURL in main.js to your own play page or landing page,
+- Replace the clientId and details of the Discord RPC in main.js. You will find helpful notes inside the file.
+- Change "waddlepenguins" in name in files: package.json, package-lock.json and "Desktop client for waddlepenguins.tk" in description in package.json. You are required to leave "Created by AltoDev" intact.
+- Change appId ("com.waddlepenguins.desktop") and product name ("Waddle Penguins Desktop") in package.json to your CPPS.
+
+4. Test your client:
+
+```bash
+  npm start
+```
 
-# This client does not connect to Waddle Penguins, due to Waddle Penguins Classic closure. Thank you for playing. You can use this client for you CPPS,  as long as you attribute AltoDev.
-The app has many functions such as:
-- Automatically clearing the users' cache when the application is launched (parties and features update instantly!)
-- Discord Rich Presence support. Have a shiny Discord status when playing
-- Embedded (Pepper) Flash Player. There's no need to install Flash manually.
-- Automatic client updates to add new fuctionality
-# User Installation
-Visit ~~https://waddlepenguins.tk/play/~~ and follow the instructions for your PC
-# Development Installation
-`git clone https://github.com/waddlepenguins/waddlepenguins_app`
+5. If everything functions as you wish, build the client:
 
-`npm install`
+Windows: 
+```bash
+  npm run-script build
+```
+macOS:
+```bash
+  npm run-script build-mac
+```
 
-Customise the files to your liking then test it with
+6. After the clients build, open the folder called `dist` and you will find a .exe installer for Windows and .pkg for macOS. You can share those for your users to download and install.
+## Acknowledgements
 
-`npm start`
+Originally created by AltoDev.
 
-To publish and create an executable file
+Adopted by Waddle Penguins and adapted for waddlepenguins.tk.
 
-Windows: `npm run-script build`
+Licensed under the Creative Commons Zero v1.0 Universal license.
 
-macOS: `npm run-script build-mac`
+If you wish to develop a client for your own CPPS using this code you are required to leave the acknowledgements here and inside the client unchanged.
+## Updates & Support
 
+This application is no longer maintained or updated by the publisher. Issues created might not be fixed, bug fixes will not be released. Please research the dependencies and update them if needed.
 
-Then open the folder `dist` and run either the .exe for Windows or .pkg for macOS
-# License
-Please attribute AltoDev and leave all attribution in it's original state.
+Application last updated: Feb 22, 2021

main.js

@@ -43,9 +43,11 @@ function createWindow () {
 
   mainWindow.setMenu(null);
   clearCache();
-  mainWindow.loadURL('https://waddlepenguins.tk/launcher/');
+  mainWindow.loadURL('https://waddlepenguins.tk/launcher/'); // Replace https://waddlepenguins.tk/launcher/ with your play page (ex. play.your.cpps) or a landing page like a home page.
 
   // RICH PRESENCE START
+
+  // Change 796476157415522354 with your own application ID. You can register an application at https://discord.com/developers/applications. Remember to change waddlepenguins.tk in details. Otherwise your Discord RPC will show it as the detail link.
   const clientId = '796476157415522354'; DiscordRPC.register(clientId); const rpc = new DiscordRPC.Client({ transport: 'ipc' }); const startTimestamp = new Date();
   rpc.on('ready', () => {
     rpc.setActivity({

package.json

@@ -10,18 +10,11 @@
     "appveyor-build": "electron-builder build --win --publish onTagOrDraft"
   },
   "bugs": {
-<<<<<<< HEAD
     "url": "https://github.com/WaddlePenguins/waddlepenguins_app/issues"
   },
   "homepage": "https://github.com/WaddlePenguins/waddlepenguins_app#readme",
   "repository": "https://github.com/WaddlePenguins/waddlepenguins_app",
-=======
-    "url": "https://github.com/cozy-penguin/client/issues"
-  },
-  "homepage": "https://github.com/cozy-penguin/client#readme",
-  "repository": "https://github.com/cozy-penguin/client",
->>>>>>> parent of 176b50a (Added all files.)
-  "author": "Waddle Penguins / AltoDev (the original version)",
+  "author": "Waddle Penguins / AltoDev",
   "license": "CC0-1.0",
   "devDependencies": {
     "electron": "^6.1.2",