Go to file

Salanto 0c10f03150 [Feature] Add support for custom playerlist formatting, show all users when authenticated (#1046 ) * Playerlist QoL * Remove excessive whitespaces * Add placeholder when displayname is unavailable		2024-08-31 13:29:26 -05:00
.github	Set MultiGen to Release Mode (#1015 )	2024-07-10 21:35:32 +02:00
android	2.10.1 Changes (#888 )	2023-05-31 20:17:30 +02:00
bin	Removed theme submodule, ...	2024-05-23 00:02:07 +02:00
data	[Feature] Add support for custom playerlist formatting, show all users when authenticated (#1046 )	2024-08-31 13:29:26 -05:00
lib	adjusted gitignore files	2018-12-26 18:11:08 +01:00
scripts	Universal configure script (#1022 )	2024-07-31 13:40:43 +02:00
src	[Feature] Add support for custom playerlist formatting, show all users when authenticated (#1046 )	2024-08-31 13:29:26 -05:00
test	Clarified test message builder	2024-05-18 03:09:39 +02:00
.clang-format	Ported to CMake, ...	2024-05-15 00:04:16 +02:00
.gitignore	Universal configure script (#1022 )	2024-07-31 13:40:43 +02:00
CMakeLists.txt	V2.11.0 rc1 fixes (#1029 )	2024-07-31 11:55:25 +02:00
configure.sh	Universal configure script (#1022 )	2024-07-31 13:40:43 +02:00
data.qrc	Add playerlist widget element (#996 )	2024-07-12 11:48:01 +02:00
LICENSE.GPLv3	Relicense/dual-license under MIT	2018-03-15 20:38:58 -05:00
LICENSE.MIT	Update readme and license	2018-12-06 14:38:02 -06:00
README_LINUX.md	Github -> GitHub in readme linux (#1010 )	2024-07-09 10:04:19 +02:00
README.md	Universal configure script (#1022 )	2024-07-31 13:40:43 +02:00

README.md

Attorney Online

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.

Contact

You can find us in the official Attorney Online Discord server: https://discord.gg/wWvQ3pw