Sound themes - Cockatrice/Cockatrice GitHub Wiki

Table of Contents

Introduction

This page explains how to customize the audio aspect of Cockatrice. Since september 2015 Cockatrice is able to load a sound "theme" that defines custom sound effects.

What is a theme?

A Cockatrice theme is just a folder containing the custom sounds. Some basic sound themes are already bundled with Cockatrice inside the "sounds" directory, typically placed in:

  • Windows: c:\program files (x86)\cockatrice\sounds
  • Linux: /usr/share/cockatrice/themes or /usr/local/share/cockatrice/sounds
  • Mac OSX: Cockatrice.app/Contents/Resources/sounds

Additionally, Cockatrice loads up any theme available in the "sounds" subfolder inside the user profile's directory, , typically placed in:

  • Windows: c:\Users\username\AppData\Local\Cockatrice\Cockatrice\sounds
  • Linux: /home/username/.local/share/data/Cockatrice/Cockatrice/sounds
  • Mac OSX: /Users/username/Library/Application\ Support/Cockatrice/Cockatrice/sounds

How to create a theme?

First locate the "sounds" subfolder in your user's profile directory; if the directory doesn't exists yet, just create it. Then create a new folder inside the "sounds" directory and name it after you chosen theme name. This will be the base directory containing all the files that make up your theme.

Customizing sounds

In order to customize the sounds used by Cockatrice, just add them inside your theme respecting the correct names for each sound. If a sound for a specific event is not found in your theme, no sound will be played for that event.

Sound files must be in wav format (https://wikipedia.org/wiki/WAV) at 44.1 kHz rate, 16-bit size, 1 channel (mono), PCM (Pulse Code Modulation). If you don't know what this means, it's just the most common format of wav file.

List of all sounds

Each event handled by cockatrice is associated to a file name that will be searched in the "sounds" directory.

Phases

Sound name Event description
untap_step The current game phase is "untap"
upkeep_step The current game phase is "upkeep"
draw_step The current game phase is "draw card"
main_1 The current game phase is "first main phase"
start_combat The current game phase is "start combat"
attack_step The current game phase is "declare attackers"
block_step The current game phase is "declare blockers"
damage_step The current game phase is "combat damages"
end_combat The current game phase is "end conmbat"
main_2 The current game phase is "second main phase"
end_step The current game phase is "cleanup" (end)

Game Actions

Sound name Description
draw_card A player drew a card
play_card A player played a card
tap_card A player tapped one or more cards
untap_card A player untapped one or more cards
shuffle A player shuffled his/her deck
roll_dice A player rolled a dice
life_change A player changed his life counter

Player

Sound name Description
player_join A player joined the game
player_leave A player left the game
player_disconnect A player was disconnected
player_reconnect A player reconnected
player_concede A player conceded the game
spectator_join A spectator joined the game
spectator_leave A spectator left the game
buddy_join A buddy joined the server
buddy_leave A buddy left the server

Chat & UI

Sound name Description
chat_mention You got mentioned in the chat
all_mention A moderator sent a global mention to everyone
private_message You received a private message

Custom User Created Themes

In this section, you can see some of the awesome themes our players have created.

Please note that nothing in this section is affiliated with any of the developers who have or currently work on the project and this is a user-editable section of the wiki!

Feel free to mix and match assets from themes - and provide your own collection to the community!