Skip to content

Commit 92b5846

Browse files
authored
Merge pull request #426 from deployor/patch-1
2 parents f5b6f66 + cee240c commit 92b5846

File tree

1 file changed

+62
-14
lines changed

1 file changed

+62
-14
lines changed

docs/editors/roblox-studio.md

Lines changed: 62 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,77 @@
1-
# Roblox Studio Setup Guide
1+
# Set Up Hackatime with Roblox Studio
22

33
![Roblox Studio](/images/editor-icons/roblox-studio-128.png)
44

5-
Follow these steps to start tracking your game development in Roblox Studio with Hackatime.
5+
This guide will walk you through setting up **Hackatime** to automatically track your game development time in **Roblox Studio**.
66

7-
## Step 1: Log into Hackatime
7+
---
88

9-
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
9+
## Step 1: Log In to Your Hackatime Account
1010

11-
## Step 2: Run the Setup Script
11+
First, make sure you have a **Hackatime account** and are logged in. If you don't have an account, you can create one at [hackatime.hackclub.com](https://hackatime.hackclub.com).
1212

13-
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
13+
---
1414

15-
## Step 3: Install Roblox Studio Plugin
15+
## Step 2: Install the Hackatime Roblox Studio Plugin
1616

17-
Follow the detailed plugin installation instructions on the [WakaTime Roblox Studio page](https://wakatime.com/roblox-studio).
17+
Next, you'll need to install the Hackatime plugin directly within Roblox Studio:
1818

19-
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
19+
1. Open **Roblox Studio**.
20+
2. Navigate to the **Toolbox**.
21+
3. In the Toolbox search bar, select **"Plugins"** from the dropdown filter.
22+
4. Search for **"HackaTime Roblox"**.
23+
5. Install the plugin published by **"ThisWhity"**.
24+
25+
![Toolbox filter showing Plugins selected](https://github.com/user-attachments/assets/65931fad-fa16-4df6-9a07-eadf1e2aaf07)
26+
*Filter the Toolbox by "Plugins"*
27+
28+
![Toolbox search results showing HackaTime Roblox plugin](https://github.com/user-attachments/assets/13233bf7-b876-4c29-b690-9ebbcb796488)
29+
*Install the "HackaTime Roblox" plugin by ThisWhity*
30+
31+
---
32+
33+
## Step 3: Configure the Plugin with Your API Key
34+
35+
Now, you'll connect the plugin to your Hackatime account using your unique API key:
36+
37+
1. Get your API key by visiting [hackatime.hackclub.com/my/wakatime_setup](https://hackatime.hackclub.com/my/wakatime_setup). It will look something like this: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.
38+
39+
![Screenshot showing API Key on Hackatime website](https://github.com/user-attachments/assets/635cab06-36cb-4351-819b-62403b6c6885)
40+
*Your API key from the Hackatime website*
41+
42+
2. In Roblox Studio, open the **Hackatime plugin**. You'll usually find it under the "Plugins" tab in the Ribbon bar.
43+
44+
![Screenshot showing the Hackatime plugin tab with API key input](https://github.com/user-attachments/assets/c241dbe2-6f9a-44bf-adb9-f0b4780227db)
45+
*Open the Plugin*
46+
47+
4. Paste your API key into the API key box. And hit "Save API Key"
48+
49+
---
2050

2151
## Troubleshooting
2252

23-
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
24-
- **Plugin not working?** Try restarting Roblox Studio after installation
25-
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-v2 channel)
53+
### ERR\_NETWORK: Plugin Cannot Connect to Hackatime
54+
55+
If you see an **ERR\_NETWORK** message, it means the plugin can't connect to Hackatime. This is likely due to you not allowing HTTP request from the plugin:
56+
57+
1. Open the "Manage Plugins".
58+
2. Hit the edit icon.
59+
3. Ensure that **"hackatime.hackclub.com"** is enabled.
60+
61+
![Screenshot showing Game Settings with Security tab open and Allow HTTP Requests highlighted](https://github.com/user-attachments/assets/c3533d87-2b06-4ba8-a1c5-7416332578e9)
62+
*Open Plugin Managment*
63+
64+
![Screenshot showing Allow HTTP Requests enabled](https://github.com/user-attachments/assets/86bea3e2-dbbe-496f-acd4-f5963c208767)
65+
*Allow HTTP requests*
66+
67+
### Still Stuck?
68+
69+
If you're still experiencing issues, don't hesitate to ask for help in the **#hackatime-v2 channel** on the [Hack Club Slack](https://hackclub.slack.com).
70+
71+
---
72+
73+
## What's Next?
2674

27-
## Next Steps
75+
Once the plugin is successfully configured, your Roblox Studio activity time will automatically start appearing on your [Hackatime dashboard](https://hackatime.hackclub.com).
2876

29-
Once configured, your activity time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy game developing!
77+
Happy game developing!

0 commit comments

Comments
 (0)