Major overhaul for ogs core

Author: dudewheresmycode

Gemfile

@@ -7,4 +7,5 @@ gem 'github-pages', group: :jekyll_plugins
 group :jekyll_plugins do
   # gem "jekyll-feed"
   gem "jekyll-seo-tag"
+  gem "jekyll-tabs"
 end

Gemfile.lock

@@ -167,6 +167,8 @@ GEM
     jekyll-sitemap (1.4.0)
       jekyll (>= 3.7, < 5.0)
     jekyll-swiss (1.0.0)
+    jekyll-tabs (1.2.1)
+      jekyll (>= 3.0, < 5.0)
     jekyll-theme-architect (0.2.0)
       jekyll (> 3.5, < 5.0)
       jekyll-seo-tag (~> 2.0)
@@ -281,8 +283,8 @@ PLATFORMS
 DEPENDENCIES
   github-pages
   jekyll
-  jekyll-feed
   jekyll-seo-tag
+  jekyll-tabs
   just-the-docs
 
 BUNDLED WITH

README.md

@@ -1,6 +1,6 @@
 The main website and documentation for our apps. Any changes pushed to this repo should be automatically published to the site.
 
-[https://opengolfsim.com](https://opengolfsim.com)
+[https://help.opengolfsim.com](https://help.opengolfsim.com)
 
 
 The site uses GitHub pages, which uses jekyll under-the-hood to generate the static site files. You can write documents in markdown or html.

_config.yml

@@ -3,12 +3,15 @@ repository: OpenGolfSim/opengolfsim.com
 # theme: just-the-docs
 logo: "/assets/logo-clear-white.svg"
 color_scheme: ogs
+plugins:
+  - jekyll-tabs
 
 footer_content: 'Copyright &copy; 2025 OpenGolfSim LLC - <a href="/privacy">Privacy</a> - <a href="/terms">Terms and Conditions</a>'
 last_edit_timestamp: true
 last_edit_time_format: "%b %e %Y"
 
 show_excerpts: true
+enable_copy_code_button: true
 
 aux_links:
   # Shop:
@@ -25,6 +28,9 @@ mermaid:
   version: "10.6.1"
 
 callouts:
+  tip:
+    title: Tip
+    color: green
   note:
     title: Note
     color: blue

_includes/api-example-js.md

@@ -0,0 +1,45 @@
+```javascript
+const net = require('net');
+
+const PORT = 3111;
+const ADDRESS = '127.0.0.1';
+
+const client = new net.Socket();
+
+function sendData(data) {
+  client.write(JSON.stringify(data));
+}
+
+client.connect(PORT, ADDRESS, () => {
+  console.log('Connected to OpenGolfSim!');
+
+  // send device ready
+  console.log('Sending device ready event...');
+  sendData({
+    type: 'device',
+    status: 'ready'
+  });
+
+  console.log('Sending test shot...');
+  // send a shot
+  sendData({
+    type: 'shot',
+    shot: {
+      ballSpeed: 135.0, // mph
+      verticalLaunchAngle: 11.1, // degrees
+      horizontalLaunchAngle: 1.2, // degrees
+      spinAxis: -2.5, // degrees, positive = hook/left, negative = slice/right
+      spinSpeed: 4800 // ball RPM 
+    }
+  });
+
+});
+
+client.on('data', (data) => {
+  console.log('Received data from OpenGolfSim: ' + data);
+});
+
+client.on('close', () => {
+  console.log('Connection was closed');
+});
+```

_includes/api-example-python.md

@@ -0,0 +1,53 @@
+```python
+import socket
+import json
+
+def sendData(sock, payload):
+  payload_bytes = (json.dumps(payload) + '\n').encode('utf-8')
+  sock.sendall(payload_bytes)
+  print(f"Sent: {payload_bytes}")
+
+
+def main():
+    host = '127.0.0.1'  # or replace with your server's IP
+    port = 3111
+
+    with socket.create_connection((host, port)) as sock:
+        # Send device ready event
+        sendData(sock, {
+          "type": "device",
+          "status": "ready"          
+        })
+        
+        # Send shot data event
+        sendData(sock, {
+          "type": "shot",
+          "shot": {
+            "ballSpeed": 135.0,
+            "verticalLaunchAngle": 11.1,
+            "horizontalLaunchAngle": 1.2,
+            "spinAxis": -2.5,
+            "spinSpeed": 4800
+          }
+        })
+
+        buffer = ''
+        while True:
+            data = sock.recv(4096)
+            if not data:
+                break
+            buffer += data.decode('utf-8')
+
+            # Handle multiple messages (delimited by '\n')
+            while '\n' in buffer:
+                msg, buffer = buffer.split('\n', 1)
+                if msg.strip():
+                    try:
+                        json_msg = json.loads(msg)
+                        print(f"Received JSON: {msg}")
+                    except json.JSONDecodeError:
+                        print(f"Received non-JSON: {msg}")
+
+if __name__ == "__main__":
+    main()
+```

_includes/footer_custom.html

@@ -0,0 +1,6 @@
+<p>
+  Copyright &copy; 2025 OpenGolfSim LLC 
+  - <a href="/privacy">Privacy</a> 
+  - <a href="/terms">Terms and Conditions</a>
+</p>
+<script src="/assets/javascript/tabs.js"></script>

_includes/head_custom.html

@@ -5,7 +5,20 @@
 {{ content }}
 
 
-{% assign tools = site.pages | where:"category","tools" %}
+<h2 class="post-list-heading">Documentation</h2>
+<ul class="tool-list">
+  <li>
+    <a class="post-link" href="/desktop/">
+      OpenGolfSim Desktop
+    </a>
+  </li>
+  <li>
+    <a class="post-link" href="/mobile/">
+      OpenGolfSim Mobile Control
+    </a>
+  </li>
+</ul>
+<!-- {% assign tools = site.pages | where:"category","tools" %}
 {% if tools.size > 0 %}
 <h2 class="post-list-heading">Products</h2>
 <ul class="tool-list">
@@ -22,10 +35,10 @@ <h3>
   </li>
 {% endfor %}
 </ul>
-{% endif %}
-
+{% endif %} -->
 
 
+<!-- 
 {% if site.paginate %}
 {% assign posts = paginator.posts %}
 {% else %}
@@ -76,4 +89,4 @@ <h3>
   </div>
 {%- endif %}
 
-{%- endif -%}
+{%- endif -%} -->

_layouts/home.html

@@ -1,14 +1,14 @@
 ---
-title: GSPro DIY Button Box
+title: DIY Golf Simulator Button Box
 layout: post
 # parent: Articles
 last_modified_date: 2024-11-15
 thumbnail: /assets/buttonbox/buttonbox_thumb.jpg
 ---
 
-After seeing a few other cool DIY boxes online, I decided to try my hand at building my own button box for GSPro. I had some spare arcade parts leftover from a previous project. So after a couple quick cuts and drilling a few holes, I had a prototype button box of my own.
+After seeing a few other cool DIY boxes online, I decided to try my hand at building my own floor button box for my golf simulator. I had some spare arcade parts leftover from a previous project. So after a couple quick cuts and drilling a few holes, I had a prototype button box of my own.
 
-The box connects to the PC via an arcade USB encoder (I'd love to upgrade to a wireless version). It appears on the PC as a joystick device, not a normal keyboard. So I needed to write a few scripts and tools for connecting the buttons with actions on GSPro.
+The box connects to the PC via an arcade USB encoder (I'd love to upgrade to a wireless version soon). It appears on the PC as a joystick device, not a normal keyboard. So I needed to write a few scripts and tools for connecting the buttons with actions on the sim. (That's actually when OpenGolfSim was born!)
 
 <img src="/assets/button_box_01.jpg" />
 
@@ -19,9 +19,9 @@ The box connects to the PC via an arcade USB encoder (I'd love to upgrade to a w
 
 ## Building the Box
 
-Building the box is fairly easy, you could use anything from a cardboard box to a masterpiece crafted out of burled walnut. Mine fell somewhere in the middle. I used some spare furring strips and chip-board I had laying around
+Building the box is fairly easy, you could use anything from some cardboard to something crafted out of burled walnut. Mine fell somewhere in the middle. I used some spare furring strips and chip-board I had laying around.
 
-## Parts List
+## Bill of Materials
 
 | Qty. | Item                                                                | Price  |
 | ---- | ------------------------------------------------------------------- | ------ |
@@ -32,7 +32,7 @@ Building the box is fairly easy, you could use anything from a cardboard box to
 
 ### Steps
 
-1. You'll first need to determine which buttons you want to know how many buttons to place on the board. I decided on 4 arrow buttons to move the aim point, and 6 other function buttons.
+1. You'll first need to determine which actions you'll want easy access to, so you know how many holes to place on the board. I decided on 4 arrow buttons to move the aim point, and 6 other function buttons that I would program later.
 
    - Left/Right/Down/Up
    - Mulligan (most used button by far)
@@ -54,12 +54,5 @@ Building the box is fairly easy, you could use anything from a cardboard box to
 
 1. Attach the other buttons to the usb encoder board slots K1-K12. These are for any type of push button.
 
-1. Plug the usb encoder into your computer and launch our [GSPro Button Box](https://github.com/dudewheresmycode/gspro-button-box) app to setup your box.
+1. Plug the usb encoder into your computer and launch our [OpenGolfSim Desktop](/desktop/) app to setup your box.
 
-## Handling Drops
-
-GSPro doesn't seem to have a key commands for drop or re-hit (that I could find), or a keyboard way to move between the drop options or menus. So, I had to get creative if I wanted to have that option available on a button.
-
-I decided to try and take a screenshot, and then use OCR (Optical Character Recognition) library to find the position of any text displayed on screen. This way we can find the drop / re-hit buttons when they're presented.
-
-The only downside is that the process takes about a second, which isn't ideal when a user presses a button. You'd want it to be instant. So I added some on screen text that says "Attempting Drop" instantly when you press the button. This way you know it received the button press and is working on finding the right option.