Skip to content

Commit

Permalink
update readme and to-do
Browse files Browse the repository at this point in the history
  • Loading branch information
webpashtet committed Apr 3, 2024
1 parent be6a94e commit eb127f4
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,37 @@
## Features
- Turn on/off music playback
- Enable/disable notifications at the end of the round
- Two sounds selection modes: **in order** and **random** (_"random_selection_mode"_ in config to _true_ for **random** or _false_ for **in order**)
- Listen to the last track
- Multi language (default English and Russian, but you can add new)
- Multi language (default English and Russian but you can add new)

## Commands
- `!res / css_res` | Main plugin menu

## How i can add music to server?
For example:
- Create addon with your songs and post him in workshop
- Add the addon to the server using [MultiAddonManager](https://github.com/Source2ZE/MultiAddonManager)
- Configure the Round End Sound config
## How add music to server
In few:
1. Create addon with your songs and post him in workshop
2. Add the addon to the server using [**MultiAddonManager**](https://github.com/Source2ZE/MultiAddonManager)
3. Configure the **Round End Sound** config
```json
"music_list": [
{
"name": "Test track 1",
"path": "sounds/music/res_1.vsnd_c"
},
{
"name": "Test track 2",
"path": "sounds/music/res_2.vsnd_c"
}
]
```

## To do...
- [x] Rework random sound selection logic
- [x] Add "in order" sound selection mode
- [ ] Refactoring repository and rework SQL queries constants
- [ ] Add menu point to view all songs
- [ ] Аdd a command to clear old players and scheduler
- [ ] Аdd a scheduler and command to clear old players
- [ ] Create instructions for assembling your workshop addon with music


Expand Down

0 comments on commit eb127f4

Please sign in to comment.