diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 34 insertions, 8 deletions
@@ -8,18 +8,44 @@ ## Setting up for development +### Prerequisites + +Unix-like systems will expect a C toolchain, installed using eg.: + +Ubuntu: `sudo apt install build-essential` +macOS: `xcode-select --install` + +You may also need openGL libraries to compile QApng, eg: + +Ubuntu: `sudo apt install libgl1-mesa-dev` +macOS: `brew install glfw glew` + +### Setup + This program's main dependency is Qt and the currently recommended version for development is **6.5.3**. See [this link](https://doc.qt.io/qt-6/qt-online-installation.html) -on how to install Qt. +on how to install Qt. You will need to check off the following under "Additional Libraries": +- Qt Image formats +- Qt WebSockets + +Under "Developer and Designer tools", you may also want to check off: +- CMake +- Ninja +- If you're on Windows, a toolchain (MinGW) + +Assuming all this is in place, you should be able to run `configure.sh` to generate the necessary build files. +This also compiles the program and shows a cmake command that can be used to recreate the build files. + +### Content + +To test key features, you may need the vanilla base content, which is not included in this repository. +You can get it from https://ao-dl.b-cdn.net/vanilla_full_2023.6_4.zip -### Other dependencies +This should be put in `./bin/base` -* BASS (http://www.un4seen.com/bass.html) -* BASS Opus Plugin (http://www.un4seen.com/bass.html#addons) -* BASS Midi Plugin (http://www.un4seen.com/bass.html#addons) -* Discord Rich Presence (https://github.com/discordapp/discord-rpc/releases) -* Qt Apng Plugin (https://github.com/jurplel/QtApng/releases) +### Formatting -(see .github/workflows/build.yml for exact installation commands) +All code should be formatted according to the `.clang-format` file. +This will be checked by CI and will fail if the code is not formatted correctly. ## Running Tests Running tests requires Catch2 and cmake |