36345612d7
* Ignore .idea * Ignore build dir too * Remove unused Windows Docker files * Remove somewhat cryptic launch.sh script * Remove kebab (javascript) * Remove outdated release_macos script and rename the most up-to-date one to macos_release * Clean up README.md and delete the other ones * Add preliminary configure script * Add hint in dependencies * Remove obsolete CONTRIBUTING.md * let's write the configure script later * Adding this is so supremely ironic that I can't even * Update QtApng repo * Actually we needed that * Add comment * Contact should be h2
65 lines
2.1 KiB
Markdown
65 lines
2.1 KiB
Markdown
# Attorney Online
|
|
|
|
  <br>
|
|
|
|
[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.**
|
|
|
|
## 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
|
|
|
|
The original Attorney Online client was created by FanatSors.
|
|
|
|
This is an open-source remake of that client created by OmniTroid.
|
|
|
|
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 OmniTroid
|
|
|
|
Modifications copyright (c) 2017-2018 oldmud0
|
|
|
|
Case Café additions copyright (c) 2018 Cerapter
|
|
|
|
Killing Fever Online additions copyright (c) 2019 Crystalwarrior
|
|
|
|
## Contact
|
|
|
|
You can find us in the official Attorney Online Discord server: https://discord.gg/wWvQ3pw
|