diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 40 insertions, 27 deletions
@@ -2,35 +2,56 @@   <br> -[Attorney Online](https://aceattorneyonline.com) is an online version of the world-renowned courtroom drama simulator that allows you to create and play out cases in an off-the-cuff format. +[Attorney Online](https://aceattorneyonline.com) is a world-renowned courtroom drama simulator that allows you to create and play out cases in an off-the-cuff format. **[Refer to the docs](https://github.com/AttorneyOnline/docs/blob/master/docs/index.md) for more information.** -Linux users will need to install the system dependencies related to Qt. These are the commands to run on a terminal for some distributions: -* Ubuntu 22.04 LTS: -``` -$ sudo apt-get install qt6base-dev libqt6websockets6 qt6-image-formats-plugins libqt6svg6 -``` -* Arch: -``` -$ sudo pacman -Syu qt6-base qt6-websockets qt6-imageformats qt6-svg -``` -* Fedora: -``` -$ sudo dnf install qt6-qtbase qt6-qtwebsockets qt6-qtimageformats qt6-qtsvg +## Setting up for development + +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. + +### Other dependencies + +* 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) + +(see .github/workflows/build.yml for exact installation commands) + +## Running Tests +Running tests requires Catch2 and cmake + +```sh +mkdir cbuild && cd cbuild +cmake .. +make test + +# usage: run all tests +./test/test + +# usage: Optionally specify tests and success verbosity +./test/test [bass] --success ``` +`[noci]` tag is used to disable a test on GitHub actions + + ## Credits -This is a open-source remake of Attorney Online written by OmniTroid. The original Attorney Online client was written by FanatSors in Delphi. +The original Attorney Online client was created by FanatSors. -The logo (`logo.png` and `logo.ico`) was designed by Lucas Carbi. The characters depicted in the logo are owned by Capcom. +This is an open-source remake of that client created by OmniTroid. -### Project +The logo (`logo.png` and `logo.ico`) was designed by Lucas CarbĂ. The characters depicted in the logo are owned by Capcom. + +## Copyright The project is dual-licensed; you are free to copy, modify and distribute AO2 under the GPLv3 or the MIT license. -Copyright (c) 2016-2018 David "OmniTroid" Skoland +Copyright (c) 2016-2018 OmniTroid Modifications copyright (c) 2017-2018 oldmud0 @@ -38,14 +59,6 @@ Case CafĂ© additions copyright (c) 2018 Cerapter Killing Fever Online additions copyright (c) 2019 Crystalwarrior -### Qt - -This project uses Qt 6.5.3, which is licensed under the [GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.txt) with [certain licensing restrictions and exceptions](https://www.qt.io/qt-licensing-terms/). To comply with licensing requirements for static linking, object code is available if you would like to relink with an alternative version of Qt, and the source code for Qt may be found at https://github.com/qt/qtbase, http://code.qt.io/cgit/, or at https://qt.io. - -Copyright (c) 2016 The Qt Company Ltd. - -### BASS - -This project depends on the BASS shared library. Get it here: http://www.un4seen.com/ +## Contact -Copyright (c) 1999-2016 Un4seen Developments Ltd. All rights reserved. +You can find us in the official Attorney Online Discord server: https://discord.gg/wWvQ3pw |