Skip to content

Commit

Permalink
Updated Readme.md to match 1.2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
TheAshenWolf committed Jun 7, 2024
1 parent 51a481e commit 57abb0c
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# WakaTimeForUE

![plugin version](https://img.shields.io/badge/version-1.2.4-blue) ![Unreal Engine version](https://img.shields.io/badge/Unreal%20Engine%20version-4.26+-blue) ![Platform support](https://img.shields.io/badge/Platform_support-Windows-blue)
![plugin version](https://img.shields.io/badge/version-1.2.5-blue) ![Unreal Engine version](https://img.shields.io/badge/Unreal%20Engine%20version-4.26+-blue) ![Platform support](https://img.shields.io/badge/Platform_support-Windows-blue)

---

### Setting up the plugin
1. Download WakatimeForUE.zip from the releases
1. Download WakaTimeForUE.zip from the releases
2. Extract the plugin into your editor plugins folder (Commonly C:\Program Files\Epic Games\UE_4.xx\Engine\Plugins)
2.1. Your folder structure should be ...\Engine\Plugins\WakaTimeForUE\
2.2. Within this folder resides WakaTimeForUE.uplugin and other files
3. Run the engine
4. If you already used wakatime elsewhere, your api key gets loaded. If not, you get prompted by a window.
4.1. In recent changes, API key on the website appears in format `waka_[apiKey]`, in order for this to work, remove the `waka_` prefix.
4. If you already used WakaTime elsewhere, your api key gets loaded. If not, you get prompted by a window.

### Notice
This is my first ever project in C++, so it is definitely not perfect.
Expand All @@ -25,7 +24,14 @@ Q: **I have regenerated my api key, how do I change it in the editor?**
A: There is a WakaTime icon in the main toolbar. When you click this icon, you can change the api key. Just remember to hit save!

Q: **Does this plugin work on both Unreal Engine 4 and 5?**
A: Short answer: Yes. Long answer: It should. You might need to rebuild the plugin from your IDE, or use it as a project plugin, but it will work.
A: Since the version 1.2.5, the main target version is Unreal Engine 5, however, the plugin should work on Unreal Engine 4.26+ as well.

Q: **The plugin says "Heartbeat successfully sent" but I don't see any data on the website.**
A: You might be using an old version of the CLI, which doesn't support API keys in the `waka_[apiKey]` format.
You may try to remove the `waka_` prefix to see if that works, but the recommended solution is to update the CLI.
The latest CLI can be found [on this link](https://github.com/wakatime/wakatime-cli/releases/latest).
The exe you need to replace is located in `C:\Users\[USER]\.wakatime\[wakatime].exe`.


---
## Contributors
Expand Down

0 comments on commit 57abb0c

Please sign in to comment.