Table of contents

1. Dissonance
2. Premise
3. Installation
   1. Requirements
   2. Installation
      • Quick-guide
      • Detailed installation guide
   3. Usage
   4. Logfiles
   5. Tests
   6. Uninstall
   7. Known problems
4. Help Me!
5. Game details
   1. Resources
   2. Neurons and potential
   3. Technologies
   4. Costs
6. Acknowledgements

Dissonance

A command line and keyboard based strategy-game, where audio-input determines the AI-strategy and lays the seed for the map-generation.

Premise

Several parts of the brain are in dissonance and started attacking each other with strong potentials, aiming to destroy the others nucleus.

Each player starts with a nucleus with control over a few cells surrounding it. By gathering different resources (iron, oxygen, potassium, ...) you can create synapses to generate potential, advancing towards the enemies nucleus. By activating cells you control, these cells can neutralize incoming potential.

You randomly gain iron every few seconds. Iron can be used to activate the process of gathering new resources or to boost their production. But your resource production is also dependent on your current oxygen level and on how close the resource is to it's limit. So be careful when building neurons: the more resources are bound in neurons, the less resources you gain!

Once you started gaining dopamine and serotonin, you can develop advanced technologies, allowing you to f.e. increase your resource limits or target specific enemy neurons and hence destroy enemy synapses or activated neurons or even block the enemies resource-production.

Once you gained enough resources you can expand your control over the brain by building more nucleus'. Use these, your build potential and the strategist inside you to overcome dissonance in your favor!

Installation

Requirements

• C++ compiler:
  Linux: gcc (available in most package managers),
  MacOs: clang (available with brew install clang)
• also essential c++ tools like make and cmake.
• python
• conan (available in most package managers, but also: pip install conan)
• aubio

Aubio installation:

• Ubuntu: sudo apt-get install aubio-tools libaubio-dev libaubio-doc
• For other linux distros and MacOs a make aubio step is included in this project
• If none of the above is working for you, checkout the official aubio-download page: https://aubio.org/download

You might also need to install some media libraries to play audio which is not in .wav format. So if loading .mp3 files or other audio-files like .ogg is not working for you, please refer to the aubio-documentation (however at least .wav and .mp3 should work if the installation was successful).

Installation<a name="install"></a>

Quick-quide<a name="quick-guide"></a>

git clone https://github.com/georgbuechner/dissonance
cd dissonance

# ubuntu:
sudo apt-get install aubio-tools libaubio-dev libaubio-doc

# MacOs and other linux-distros:
make aubio  

make install

Detailed installation quide<a name="detailed-guide"></a>

Clone project:

git clone https://github.com/georgbuechner/dissonance

Now cd into the project

cd dissonance

If aubio is not available in your systems package-manager, build aubio from source:

make aubio

In case you experience the error /usr/bin/env: ‘python’: No such file or directory:

• Check if python is correctly installed.
• If python3 is installed, you may want to create a symlink with the following command: sudo ln -sf /usr/bin/python3 /usr/bin/python

Finally you install dissonance by running:

make install  // (re-run this step for updates also) 

These steps install dissonance system-wide and create .dissonance in the home folder to store settings and analysed musical data.

Usage

To play, simply run dissonance in your command line.

You can run dissonance -r, to create the map based on your current terminal size. Doing this will however change the game experience and two identical songs will no longer produce an identical map and experience.

Logfiles

If not changed manually, logfiles will be stored at ~/.dissonance/logs/ in the format [timestamp]_logfile.txt f.e. 2021-10-13-01-44-47_logfile.txt.

You can delete these manually f.e. (rm ~/.dissonance/logs/2021-10* will delete all logs created in October 2021), or you can start the game with dissonance -c respectively dissonance --clear-log which will delete all logfiles.

By default logging is set to warn, leading to very small log-files containing only the most relevant information. Consider including these files if you are filing an issue. You may also increase the log-level with dissonance -l respectively dissonance --log-level (f.e. dissonance -l "debug").

Tests

To run tests, run

./build/bin/tests

Uninstall

To uninstall dissonance, run:

make uninstall

If you installed aubio with make, you can uninstall, using:

make uninstall_aubio

Known problems

MacOs installation: c++ compiler detected by cmake differs from conan profile.

Possible error:

CMake Error at conanbuildinfo.cmake:582 (message):
  Incorrect 'gcc', is not the one detected by CMake: 'Clang'

Currently it is expected that clang is the primary compiler, when installing dissonance on MacOs (more specifically: cmake detects clang as compiler). Thus the conan-profile should also be setup for clang. If this is not the case (because you f.e. modified the conan default profile) you can revert this, by running:

conan profile new default --detect

Of course this can only work, if clang is actually your main c++ compiler (conan detects clang).

Afterwards re-run make install.

It is very likely that it is possible to compiler dissonance with gcc on MacOs also, however, Makefile and CMakeList is not optimised for this, and you main need to figure some problems out yourself.

Audio glitching/ noise on Arch Linux.

As the documentation of miniaudio correctly points out, these issues might be fixed by applying the fix mentioned in the arch-linux wiki: https://wiki.archlinux.org/title/PulseAudio/Troubleshooting#Glitches,_skips_or_crackling.

Help Me I have no idea what a command-line is.<a name="help-me"></a>

Okay I think it's worth writing a few lines about the command-line and giving a few instructions in case you never used a terminal or a command-line and especially give some help on installing the requirements.

If you really have now idea at all, I strongly advise checking out a few tutorials, here is f.e. the link to the official ubuntu-command-line-tutorial: https://ubuntu.com/tutorials/command-line-for-beginners#3-opening-a-terminal

Opening the command-line.

You can usually open the command-line (CLI) by searching terminal via your systems build-in search method.

Basic commands

There are a few commands you will probably need during the installation process, let's take a look. (All of the following commands are identical on linux and MacOs.)

The pwd command shows the path of you current working directory

pwd
 
# possible output:
/home/sigmund/Documents

The ls command shows all files and directories in the current folder

ls

# possible output:
Documents
Downloads
Pictures
Music

With mkdir (make directory) you can create a new directory/ "folder":

mkdir build

ls will then show the newly created directory:

ls

# possible output:
Documents
Downloads
Pictures
Music
build

cd allows you to change the current working directory:

cd build

Installing software via CLI

Installing new software via CLI is one of the things that will give you the "oh, that's nice" experiences. Most operating systems (we'll concentrate on linux and MacOs here) will have their own package-manager to not only install but also updated your software. Ubuntu uses apt, arch-bases distro use pacman and on MacOs you can use homebrew. Installing howebrew can be a bit tricky, here's a link on how to do this: https://brew.sh/

To play dissonance, you will need to install a few programs, let's take a look

Ubuntu

As already mention, ubuntu uses apt.

For dissonance you need to install a few programs, like gcc, cmake, python and conan and maybe (depending on what is already installed on you system, more basic tools, like make, wget and other programs. This may seem like a lot, but installing via CLI really makes thing easy:

sudo apt install build-essential cmake python

Will install most programs you need to install and run dissonance.

build-essential contains stand software to for coding, like gcc (c++ compiler), make and a few other libraries.

On Ubuntu conan can not be install via apt, however you can use the python-package-manager that should be present on your system, once python is installed:

pip install conan

In general: often if something is going wrong, the command-line will tell you what the problem is. It might even say program xxx is missing, you can install with 'apt install xxx'.

MacOs

Things are quite similar for MacOs: after installing homebrew you can install the necessary software using the command brew.

brew install cmake make clang python conan

I'm aware that this is a very very limited guide focusing only on comm