Merge pull request #217 from AttorneyOnline/kfo-ao2

Final mega-merge with the Killing Fever Online client, along with other associated bugfixes and feature additions.

This commit is release-ready.

Author: oldmud0

.clang-format

@@ -0,0 +1,2 @@
+BasedOnStyle: LLVM
+BreakBeforeBraces: Stroustrup

.gitignore

@@ -9,14 +9,19 @@ base_override.h
 .DS_Store
 
 base-full/
-base/
+logs/
 bass.lib
 
 bin/
 bins/
 build/
 release/
 debug/
+base/background
+base/characters
+base/sounds
+base/callwords.ini
+base/config.ini
 
 .qmake.stash
 

.gitlab-ci.yml

@@ -121,10 +121,7 @@ build windows i686:
 # Base folder
 .deploy_base: &deploy_base |
     mkdir base
-    mkdir base/themes
-    cp -a ../base/themes/default base/themes/
-    cp -a ../base/config.ini base/config.sample.ini
-    cp -a ../base/serverlist.txt base/serverlist.sample.txt
+    cp -a ../base/ base/
 
 # Miscellaneous files
 .deploy_misc: &deploy_misc |

.travis.yml

@@ -14,7 +14,7 @@ deploy:
   provider: releases
   api_key:
     secure: mZCNwnqKeqJP5CqgYOanYnr/KHydxueGPRhvGLpY0Pop7MiH3CIHMN5dhHbtgJvE5GGMR4xUIEhPpmkCEJw7YiPREMqT4mkV4DR531ZLB3t/FizyvIwXuP6jFwzTofZ51qHfBpcurVc9sMFeD9Pw+rLTTgIiXL2sZxUUXc8U+ZZug1lYndgcO6P00fUJd6V9lyFQUGmbSca97YbG6KuCym0fEpyRnMqzKLjYsUUo8UKRBADtmD822O6z2FSldNZDn45Mkx0MYfHWyT5hzTb7WGa+DrTB/0un1HqqsNPlb/ahjrFQQNR2qd7HNGZa+Mvwi6egTDug+k15x8lbkacUoi34U1eFq9LSTYm8dSO5g23I1OvGvjTCkDj1jOLPqB99XlbAJ0E/9Jzw7wtlLaAzvFzTj/B63TQnO3IsgHBWR14CZlf05WMOFf2irwl+kL6ktspIHnlGgaiWYYrKeAt7QJAXiQOdYDz6SaWVC6TyOE/SszXRU6xFotmCjkP2irM5yGE8SUw2uIzKjD9uG0ZXtbLcdQEFD316+qglqFTCjnKsRfbtQs2u5spZPsZSdsOZCbLfNIn0GSTFRymFsK6gsvji8AD8AZo0zcOZ/7NMVC6A8RnF3Ve+vU/xljhsIOxoLZDvZPia7WozdV99xmnepWBwkuoQs/K0xmWcnLZDcb0=
-  file: "../bin/Attorney_Online_mac_x86_64.zip"
+  file: "../bin/Attorney_Online_macOS.zip"
   draft: true
   on:
     tags: true

Attorney_Online.pro

@@ -3,7 +3,7 @@ QT += core gui widgets network
 TARGET = Attorney_Online
 TEMPLATE = app
 
-VERSION = 2.7.2.0
+VERSION = 2.8.4.0
 
 INCLUDEPATH += $$PWD/include
 DESTDIR = $$PWD/bin
@@ -13,30 +13,39 @@ MOC_DIR = $$PWD/build
 SOURCES += $$files($$PWD/src/*.cpp)
 HEADERS += $$files($$PWD/include/*.h)
 
-
 LIBS += -L$$PWD/lib
 
-
-#DEFINES += DISCORD
+# Uncomment to enable Discord Rich Presence
+# DEFINES += DISCORD
 
 contains(DEFINES, DISCORD) {
-LIBS += -ldiscord-rpc
+  LIBS += -ldiscord-rpc
 }
 
-#DEFINES += BASSAUDIO
+# Uncomment to enable the BASS audio engine
+# (Recommended for Windows)
+# DEFINES += BASSAUDIO
 
 contains(DEFINES, BASSAUDIO) {
-LIBS += -lbass
+  LIBS += -lbass
+  LIBS += -lbassopus
 }
 
-#DEFINES += QTAUDIO
+# Uncomment to enable the Qt audio engine
+# (Recommended for non-Windows platforms)
+# DEFINES += QTAUDIO
 
 contains(DEFINES, QTAUDIO) {
-QT += multimedia
+  QT += multimedia
+}
+
+AUDIO_DEFINES = $$find(DEFINES, BASSAUDIO) $$find(DEFINES, QTAUDIO)
+count(AUDIO_DEFINES, 0) {
+  warning("No audio system selected. Your build will not have audio.")
 }
 
-contains(CONFIG, qml_debug) {
-DEFINES += DEBUG_NETWORK
+count(AUDIO_DEFINES, 2) {
+  error("More than one audio system selected.")
 }
 
 macx:LIBS += -framework CoreFoundation -framework Foundation -framework CoreServices
@@ -46,16 +55,16 @@ CONFIG += c++14
 
 RESOURCES += resources.qrc
 
-TRANSLATIONS    =   resource/translations/ao_en.ts \
-                    resource/translations/ao_jp.ts \
-                    resource/translations/ao_de.ts \
-                    resource/translations/ao_ru.ts \
-                    resource/translations/ao_es.ts \
-                    resource/translations/ao_pt.ts \
-                    resource/translations/ao_pl.ts
+TRANSLATIONS = resource/translations/ao_en.ts \
+               resource/translations/ao_jp.ts \
+               resource/translations/ao_de.ts \
+               resource/translations/ao_ru.ts \
+               resource/translations/ao_es.ts \
+               resource/translations/ao_pt.ts \
+               resource/translations/ao_pl.ts
 
-win32:RC_ICONS = resource/logo.ico
-macx:ICON = resource/logo.icns
+win32:RC_ICONS = resource/logo_ao2.ico
+macx:ICON = resource/logo_ao2.icns
 
 android:DISTFILES += \
     android/AndroidManifest.xml \

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+## Compiling
+
+The traditional route is by undergoing the [AO2 Rite of Passage](https://gist.github.com/oldmud0/6c645bd1667370c3e92686f7d0642c38).
+
+However, these days it is easy to get away with using the default Qt toolchain on any platform, which creates a dynamic executable. (Don't forget to invoke windeployqt when creating a release.)
+
+### Dependencies
+
+- [BASS](http://un4seen.com) (optional; may use Qt Multimedia instead)
+- [Discord Rich Presence](https://github.com/discordapp/discord-rpc) (optional)
+
+## Release instructions
+
+Follow these steps to make a new full release:
+
+- Set a new AO version in the `.pro` file and in `aoapplication.h`.
+- Compile the project.
+- Commit the version bump and and create a tag for the commit.
+- Rename the executable to `Attorney_Online`.
+- Create a temp directory.
+- Copy a fresh `base` folder to the temp dir. Ensure that the timestamps are consistent.
+  - Ignore this step if creating a client-only release.
+- Copy the repository's `base` folder to the temp dir.
+- Append `.sample` to the names of all `.ini` files, including `serverlist.txt`.
+- Copy the game executable to the temp dir.
+- Copy `bass.dll`, `discord-rpc.dll`, and `qapng.dll` if applicable.
+- Copy `README.md` as `README.md.txt` with CRLF line endings.
+- Copy `LICENSE` as `LICENSE.txt` with CRLF line endings.
+- Compress the contents of the temp dir to an archive with maximum compression, but
+  be sure that the contents are placed inside the root directory of the archive and not
+  within a subdirectory.
+- Compute the SHA-1 hash of the archive.
+- Upload the archive to the Wasabi bucket and an additional mirror (e.g. MEGA or OneDrive)
+  (if this is a full release).
+- Publish a GitHub release and upload the archive there (if this is a client-only release).
+- Add the new version to the `program.json` manifest for the respective platform 
+  (if this is a client-only release).
+- Update the following on the website for the respective platform:
+  - Full download links (Wasabi and mirror)
+  - Client download link
+  - Full download hash
+  - Client download hash
+
+Repeat for each platform (currently 32-bit Windows and 64-bit Linux). Once you're done, don't forget to announce your release!