pso-matchmaker

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #android #linux #java #windows #cli #kubernetes #vue

(★ 9)

Pro Soccer Online matchmaker discord bot

pso-matchmaker Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Description

 <img src="./doc/images/logo.png" width="250" height="250"/>
 
 (Image credits: Reis)

**pso-matchmaker** is a Discord bot initially developped for the game [Pro Soccer Online](https://store.steampowered.com/app/1583320/Pro_Soccer_Online/).
 You are free to fork it and use it for your own purpose, by adapting some of the text content in the code.

The purpose of this bot is to help players looking for competitive games to find matches and build up their own team.
Use the **/help** command to see a list of useful commands and how to use the bot.

# Features

## Ranked mode
**pso-matchmaker** implements an **Elo ranking system** that rates both teams and players depending on their match results. 
The ratings are region-specific (5 regions exist so far: Europe, North America, South America, East Asia and Oceania). 
You can display the teams and players leaderboard by using the **/leaderboard** command. 
To see your own stats, use the **/player_stats** command. 
Every game mode supports ranked mode *(read [Game modes section](#game-modes) for more information)*. However, only the **official community discords** are allowed to create a ranked line-up.

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/leaderboard.png) 
*(Leaderboard)*

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/player_stats.png) 
*(Player stats)*

## Auto-matchmaking
If you want **pso-matchmaker** to automatically search for a match that is matching your team level, you can enable the auto-matchmaking feature when you create your line-up (active by default, and only available for the Team mode).

Once a match has been found, a message is sent in both the channel and each player DM. 
![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/search.png) 
*(Searching for a match)*

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/match_ready.png) 
*(Message sent in the channel once a match is found)*

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/match_ready_dm.png) 
*(Direct Message sent to the players when the match starts)*

## Team Management
**pso-matchmaker** lets you create your own team (wether it is competitive, a group of friends or a community !), and then manage it with many game modes and options.

The 2 most important things to understand are:
- **1 Discord Server (Guild) = 1 Team** 
- **1 Discord Channel = 1 Line-up**

A Team is made of 1 or multiple line-ups. 
To create your team, invite **pso-matchmaker** on your discord, then use **/register_team** command.
To create a new line-up, use **/setup_lineup**, **/setup_mix** or **/setup_mix_captains** commands depending on the game mode you want to play with this line-up *(read [Game modes section](#game-modes) for more information)*

Once you create your team, you can use the **/team_manage** command to edit various information.

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/team_manage.png) 
*(Example of team management)*

## Game modes
There are 3 different game modes available ! 
***Note**: At any time, if you want to display and interact with the line-up, you can use the **/status** command.*

### Team
The most interesting and competitive game mode is the **team mode**. 
To use this mode, you need to setup a channel with the **/setup_lineup** command. 
The team mode let you select a position and group up with your teamates, then either pick a team/mix to challenge by clicking the **Challenge** button, or simply click on **Search** and let **pso-matchmaker** find a match for you.

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/game_mode_team.png) 
*(Example of a team line-up)*

### Mix
This game mode brings up a **Red Team** and a **Blue Team** in the same channel. 
To use this mode, you need to setup a channel with the **/setup_mix** command. 
This is very interesting if you have a community discord server and want people to play against each other. 
When you create a mix line-up, you have an option called **allow_teams** which, if set to true, allow team line-ups to face the **Red Team** of the mix !

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/game_mode_mix.png) 
*(Example of a mix line-up)*

### Mix Captains (Draft mode)
This game mode brings up a single queue that players can join in. Once enough players have joined the queue, a draft starts and 2 captains are chosent to pick there players for there team.

![Example](https://raw.githubusercontent.com/grassehh/pso-matchmaker/main/doc/images/game_mode_captains.png) 
*(Example of a mix captains line-up)*

# Dependencies
- [NodeJS 17.9.1](https://nodejs.org/download/release/v17.9.1/)
- A [MongoDB](https://www.mongodb.com/) database

# Environment configuration
- Create a **.env** file in the project root directory with at least the following variables
```
CLIENT_ID=<BOT CLIENT ID>
TOKEN=<BOT TOKEN ID>
MONGO_URI=<MONGO URI>
GUILD_ID=<YOUR DISCORD TEST GUILD ID>

PSO_EU_REGION_LABEL=Europe
PSO_EU_DISCORD_GUILD_ID=<SAME AS GUILD_ID>

PSO_NA_REGION_LABEL=North America
PSO_NA_DISCORD_GUILD_ID=0000000000000000000

PSO_SA_REGION_LABEL=South America
PSO_SA_DISCORD_GUILD_ID=0000000000000000000

PSO_AS_REGION_LABEL=East Asia
PSO_AS_DISCORD_GUILD_ID=0000000000000000000

PSO_OC_REGION_LABEL=Oceania
PSO_OC_DISCORD_GUILD_ID=0000000000000000000
```

# How to build
- `npm run build`

# How to deploy the Discord commands
- `node build/scripts/deploy-commands.js` 
*Note: If **GUILD_ID** environment variable is defined, the commands will be deployed only the this guild*

# How to run with nodemon
- `npm run dev`

pso-matchmaker

pso-matchmaker Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pso-matchmaker

pso-matchmaker Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README