This is an old revision of the document!
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.
→ Example: Building a Lobby Browser
This guide covers:
- Quick start with the public Community API (no authentication)
- Advanced features using the 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.
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 |
|---|---|---|---|
| Community API | None required | Public lobby listings | Quick Start Guide |
| Game API | Steam required | Ongoing matches, detailed data | Advanced Guide |
Essential Resources
- RLINK Documentation - Complete API reference
- aoe2lobby Discord - Community support and discussion
Open Source Projects
LibreMatch Organization - GitHub
- librematch-collector - Polling, diffing, parsing and converting data from the Relic Link API for storing in Libre:Match Database
- librematch-rlink_client - Relic Link API-Client generated from OpenAPI
- librematch-steam_auth - Steam authentication proxy for use with Relic Link API
- 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 FAQ for common questions
- Check the example implementations
- Join the community on Discord
- Explore 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!