Skip to content

AJXD2/erlc-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš“ ERLC API Wrapper πŸš’

License Python Version Contributions

Welcome to the ERLC API Wrapper – your go-to Python library for interacting with the Emergency Response: Liberty County API. Whether you're building bots, dashboards, or integrating with other systems, this wrapper makes it effortless to retrieve and manipulate game data.

✨ Features

  • πŸš€ User-Friendly: Simplified functions for every endpoint.
  • 🌐 Complete Coverage: Access every available API endpoint with ease.
  • ⚑ Robust Error Handling: Thoughtful error management to keep your app running smoothly.

πŸ“¦ Installation

Although this package isn't on PyPI yet, you can still get started by cloning the repository:

git clone https://github.com/AJXD2/erlc-api.git
cd erlc-api
poetry install

Make sure you have Poetry installed to manage dependencies.

πŸ› οΈ Usage

Dive right in with this sample code to see how the wrapper works:

from erlc import ErlcClient

client = ErlcClient()
server = client.get_server("...")

# πŸš“ Get Server Info
print(server)

# πŸ” Explore Join Logs
print(server.joinlogs)

# πŸ’₯ Retrieve Kill Logs
print(server.killlogs)

# πŸ›‘οΈ Access Command Logs
print(server.commandlogs)

# 🚨 View Mod Calls
print(server.modcalls)

# 🚷 Check Bans
print(server.bans)

# ⏳ See Queue
print(server.queue)

# πŸ‘₯ List Players
print(server.players)

# πŸš— Get Vehicles
print(server.vehicles)

# πŸ’» Run commands
server.run_command(":m Hello World!")

This is just a glimpse of what you can do! Whether you're managing a server or simply exploring the data, this wrapper has you covered.

πŸ“š API Reference

For full details on all the available endpoints, take a look at the official ERLC API documentation.

🀝 Contributing

Have an idea? Found a bug? Contributions are highly appreciated! Please submit issues or pull requests to help make this project better.

πŸ“œ License

This project is open-source under the MIT License. See the LICENSE file for more details.

πŸ™ Acknowledgments

Big thanks to the developers of Emergency Response: Liberty County for providing this API and creating an incredible role-playing experience.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages