Differences

This shows you the differences between two versions of the page.

--- getting-started:start [2025-12-05 01:00] – created nimda
+++ getting-started:start [2025-12-06 03:10] (current) – nimda
@@ Line 1: / Line 1: @@
 ====== Getting Started ======
+Welcome to the LibreMatch developer documentation! This section will help you get started with building applications using the Worlds Edge Link API for Age of Empires games.
+===== What You Can Build =====
+The Worlds Edge Link API enables you to create:
+  * **Lobby Browsers** - Display and filter available game lobbies
+  * **Match Spectator Tools** - View and follow ongoing games
+  * **Player Tracking** - Monitor specific players' activities
+  * **Community Tools** - Custom integrations for your local gaming community
+  * **Statistics Dashboards** - Aggregate and visualize game data
+===== Choose Your Path =====
+==== I Want to Build a Lobby Browser ====
+Start here if you want to create a tool that displays game lobbies and matches.
+→ **[[getting-started:example-lobby-browser|Example: Building a Lobby Browser]]**
+This guide covers:
+  * Quick start with the [[rlink:community:start|public Community API (no authentication)]]
+  * Advanced features using the [[https://wiki.librematch.org/getting-started/example-lobby-browser#advancedgame_api_authenticated|authenticated Game API]]
+  * Code examples and best practices
+  * Response parsing and data handling
+==== I Have Questions ====
+Check our comprehensive FAQ for quick answers to common questions.
+→ **[[getting-started:faq|Frequently Asked Questions]]**
+Topics covered:
+  * General API questions
+  * Authentication and setup
+  * API usage and filtering
+  * Development tips
+  * Troubleshooting
+===== Quick Links =====
+==== API Endpoints ====
+^ Endpoint Type ^ Authentication ^ Use Case ^ Documentation ^
+| [[rlink:community:start|Community API]] | None required | Public lobby listings | [[getting-started:example-lobby-browser#quick_start_community_api|Quick Start Guide]] |
+| [[rlink:game:start|Game API]] | Steam required | Ongoing matches, detailed data | [[getting-started:example-lobby-browser#advanced_game_api_authenticated|Advanced Guide]] |
+==== Essential Resources ====
+  * **[[https://wiki.librematch.org/rlink/start|RLINK Documentation]]** - Complete API reference
+  * **[[https://discord.gg/MvuusBxtuB|Libre:Match Discord]]** - Community support and discussion
+==== Open Source Projects ====
+**LibreMatch Organization** - [[https://github.com/librematch|GitHub]]
+  * **[[https://github.com/librematch/librematch-collector|librematch-collector]]** - Polling, diffing, parsing and converting data from the Relic Link API for storing in Libre:Match Database
+  * **[[https://github.com/librematch/librematch-rlink_client|librematch-rlink_client]]** - Relic Link API-Client generated from OpenAPI
+  * **[[https://github.com/librematch/librematch-steam_auth|librematch-steam_auth]]** - Steam authentication proxy for use with Relic Link API
+  * **[[https://github.com/luskaner/ageLANServer|ageLANServer]]** - Open source LAN server implementation with model definitions
+===== Before You Begin =====
+**For Basic Lobby Browsers:**
+  * No special requirements - just make HTTP requests!
+  * Recommended: 5-second polling interval with caching
+**For Advanced Features (Spectating, Match Data):**
+  * Steam account with the game purchased
+  * Node.js or similar environment for authentication
+  * Understanding of Steam authentication flow
+===== Need Help? =====
+  * Browse the **[[getting-started:faq|FAQ]]** for common questions
+  * Check the **[[getting-started:example-lobby-browser|example implementations]]**
+  * Join the community on **[[https://discord.gg/MvuusBxtuB|Discord]]**
+  * Explore **[[https://github.com/luskaner/ageLANServer|open source projects]]** for working code
+===== Contributing =====
+Found something missing or incorrect? This documentation is community-maintained. Contributions are welcome to help fellow developers!
+----
+//Ready to start? Pick a guide above and begin building! //