Skip to content

Commit

Permalink
improved readme and added example image assets
Browse files Browse the repository at this point in the history
  • Loading branch information
99oblivius committed Nov 8, 2024
1 parent e8b4f49 commit 5b9de1f
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,49 @@
# VALORS Match Making Bot

![PMM Logo](assets/pmm-logo.png)

A Discord-powered Match Making server for Pavlov VR with automated team formation, voting, and performance tracking.

[![License](badge-url)](#) [![Version](badge-url)](#)

## Features

### Queue Management
- Flexible queue joining with pingable role
- Automated team formation
- Interactive map voting and team side selection

### Performance Tracking
- Comprehensive player statistics
- Performance history visualization
![Performance Stats](assets/stats-example.png)
- Activity tracking and analysis
![Player Activity](assets/activity-example.png)

### Community Features
- Competitive leaderboards
![Leaderboard System](assets/leaderboard-example.png)
- Match history and scoreboards
![Match Scoreboard](assets/scoreboard-example.png)
- Steam account integration for in-game performance tracking

### Server Management
- Automated game server management
- Custom ELO calculation system taking into account personal past and current performance
- Comprehensive moderation tools:
- Multiple warning types
- Timeout functionality
- User blocking
- Member infraction tracking
- State system allows live updates of the bot
- On the fly configuration of queue, match settings, map-pool, and more


## Setup
- Deployed with VALORS-Bot-API's docker-compose.yaml configuration

## API Integration
This bot requires the [VALORS-Bot-API](https://github.com/99oblivius/VALORS-Bot-API) for full functionality.

## Contributing
I am open for any and all feedback. Feel free to create Pull requests.
Binary file added assets/activity-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/graph-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/leaderboard-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pmm-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/scoreboard-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/stats-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b9de1f

Please sign in to comment.