Skip to content

Commit

Permalink
didn't mean to revert readme commit ffs
Browse files Browse the repository at this point in the history
  • Loading branch information
angelolz committed Jan 5, 2022
1 parent 70e7c6e commit 21d8b04
Showing 1 changed file with 15 additions and 17 deletions.
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
# Cookie Clicker Rich Presence Creator
This Cookie Clicker mod will allow you to share your game stats with everyone on Discord!

## Requirements
- CCSE
- The Rich Presence Cookie Clicker mod
- The Rich Presence Java Client
- [Java 8](https://java.com/en/download/) (or higher, although the exe might prompt you to install Java 8 for some reason)

## Mod Installation (Steam)
You can download this mod at the Steam Workshop **[here](https://steamcommunity.com/sharedfiles/filedetails/?id=2708959340)**.
Unfortunately, you won't be able to have a small icon like the browser version of the mod does, but it does allow you to
cycle through all the possible information that the mod provides :)

## Installation (Browser)
Run the executable program. Upon running the program, it should automatically open the Cookie Clicker website for you.

Copy this code and save it as a bookmark.
```javascript
javascript: (function () { Game.LoadMod('https://angelolz.dev/mods/ccrpc/main.js'); }());
```
## Installation (Browser)
### Requirements
- [Java 8](https://java.com/en/download/) (or higher, although the exe might prompt you to install Java 8 for some reason)

## Enabling Rich Presence
### Windows
### Running the program
**Windows**
- Just launch the executable program!

### macOS / Linux
**macOS / Linux**
- Open a terminal and navigate to where the jar file is stored using the `cd` command.
- Type the command: `java -jar *.jar`.

Upon running the program, it should automatically open the Cookie Clicker website for you.

Copy this code and save it as a bookmark.
```javascript
javascript: (function () { Game.LoadMod('https://angelolz.dev/mods/ccrpc/main.js'); }());
```

If everything was installed correctly, you should see the below output and your rich presence on Discord!
![It's working! :D](https://i.imgur.com/JAIsMk4.png)

# Bugs/Feedback
There are times where I might've left a nasty bug in there, that's my bad! My JavaScript skills aren't the best, since I don't have a lot of experience with it. With that said, if you do spot a bug or have any issues, please [open an issue](https://github.com/angelolz1/CookieClickerRPC/issues)!
There are times where I might've left a nasty bug in there, that's my bad! My JavaScript skills aren't the best, since I don't have a lot of experience with it. With that said, if you do spot a bug or have any issues, please [open an issue](https://github.com/angelolz1/CookieClickerRPC/issues)!

# Dependencies Used:
- [Vatuu/discord-rpc](https://github.com/Vatuu/discord-rpc) for the Java implementation of Rich Presence
Expand All @@ -44,6 +42,6 @@ There are times where I might've left a nasty bug in there, that's my bad! My Ja
MIT

---
Cookie Clicker and its icons are owned by Orteil. Thank you Orteil for creating such an amazing game!
Cookie Clicker and its icons are owned by Orteil. Thank you Orteil for creating such an amazing game!

If you want to support me for my work, feel free to give me a [Ko-Fi](https://ko-fi.com/angelolz)!

0 comments on commit 21d8b04

Please sign in to comment.