Skip to content

Latest commit

 

History

History
90 lines (54 loc) · 2.89 KB

README.md

File metadata and controls

90 lines (54 loc) · 2.89 KB
Raw

Attorney Online

CI build license contributors

Attorney Online 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 for more information.

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 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

This should be put in ./bin/base

Formatting

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

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