From f06031f75381798e04b33faffa9416e0fabb7874 Mon Sep 17 00:00:00 2001 From: Azalea <22280294+hykilpikonna@users.noreply.github.com> Date: Sun, 5 Jan 2025 21:15:16 -0500 Subject: [PATCH] [U] docs update faq --- README.md | 2 + docs/frequently_asked_questions.md | 88 +++++++++--------------------- 2 files changed, 28 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 034aaeb9..a3230069 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ Check out these docs for more information. * [Game specific notes](docs/game_specific_notes.md) * [Frequently asked questions](docs/frequently_asked_questions.md) +> We do not provide game files. You need to obtain them on your own. + > [!TIP] > Some games may require additional patches and these will not be provided in this project and repository. You already found this, so you know where to find related resources too. diff --git a/docs/frequently_asked_questions.md b/docs/frequently_asked_questions.md index f2ff8246..f094471c 100644 --- a/docs/frequently_asked_questions.md +++ b/docs/frequently_asked_questions.md @@ -1,19 +1,37 @@ # Frequently asked questions -For best viewing experience, please use a markdown viewer that supports Github or Gitlab Flavored Markdown syntax. -## Server +## Game + +### Will you share game or update files? +No. + +### Where I can find game patches or get one? +Use a search engine and scroll through some forums, you will eventually find them. + +### Can I use unmodified cabinets or games with this server? +No. Most games require patches to properly run. You can find which patches are required in the [game specific notes](game_specific_notes.md). + +### Will you add [game name] support? +If a game is not supported, chances are that no current developers play the game. It will be extremely difficult to add support for a game you don't play. So, if you want to see support for a game that's currently not supported, you would need to find someone with Kotlin/Java programming skills who also plays the game. + +### Will this server work with newer version of supported games? +Not likely but it doesn't hurt to try. If it works, please report it in the [issue tracker](https://github.com/MewoLab/AquaDX/issues). + + +## Self Hosting + ### Can I host a public instance? -You're permitted to. However, you should only consider this if you have strong programming or homelab experience or have self-hosted other services before, as we will not be answering basic questions such as how to set up things like port forwarding or domain records. +Yes. But you should only consider this if you have strong programming or homelab experience or have self-hosted other services before, as you will not receive support for basic questions. -If you're new to self-hosting, it's easier to just use our public server at https://aquadx.net. +If you're new to self-hosting, please just use our public server at https://aquadx.net. + +> [!CAUTION] +> By the CC By-NC-SA License, your public instance CANNOT be commercial in any way, this includes paid access, donations, or any other form of monetization. ### Can I use other port for endpoints? No. It's hardcoded inside a game and server can do nothing about it. -### Can I disable billing endpoint? -Yes. There will be no major consequences even without it. - -### What ports does Aqua use? +### What ports does AquaDX use? * 80: ALL.Net, Game endpoints * 8443: Billing * 22345: Aime @@ -29,57 +47,3 @@ Here are some tips: * Set `allnet.server.host` in `application.properties` with your public IP or hostname * You may change endpoint ports for internally (aqua <-> proxy), but external ports that are exposed needs to be the same as default (proxy <-> game) -### `java.lang.ClassNotFoundException` occurs when I try to start a server! -Delete exclamation mark character(`!`) in your directory name. - -### I want to add custom content data in Aqua database -You can add database entry by hand or your handmade tools. Currently Aqua doesn't have a way to do this automatically. I don't have timeframe for this either. - -### How can I update to a newer version? -Read the [changelog](/CHANGELOG.md) to check breaking changes before updating. Then follow **one** of these options: -* Take jar file (`aqua.jar`) from newer release and replace it -* Copy your current DB file (`data/db.sqlite`) and config file (`application.properties`) to newer release folder - -### `Port 80 was already in use` occurs when I try to start a server! -Identity which process is using 80 port then terminate it. Game won't connect to Aqua server if port is different then 80 port, so it is necessary. - -## Game -### Can I use unmodified cabinets or games with this server? -No. This is due to hardened security measures which SEGA made. - -### Will you add [your wanted game name] support? -It'll be case by case basis. Open an issue if you want to suggest something. - -### Is the server update is mandatory with every new game content updates? -No, games will still work. However, new content *probably* not appear in game without so-called "force unlock" and Web UI will not work as intended when displaying new content. - -### Will this server work with newer version of supported games? -Probably not without update, but who knows? - -### Game passes connection test but networking is not working -Some game have kill switch for prevent early run before release date (a.k.a "Flying Get"). In this case, **BOTH** client and server need to handle networking enable flag for avoid this problem. For client part, consult with your source. For server, wait for future Aqua update with new version support. - -### Team or/and place name showed as garbled characters in game when using non-latin text -Convert `application.properties` text encoding to UTF-8 without BOM. - -## Misc -### Can I use latest version of Java instead of 17? -Yes. - -### Can I use OpenJ9 JVM? -While it *may* work, I can't give any support with it. - -### Will you share game or update files? -No. - -### Where I can find game patches or get one? -I won't give any help on this repository. - -### Why the file size of compiled jar is so huge? -It is because Aqua is using Spring Boot as a base. It's a upstream issue, not something that can be fixed on this project side. - -### I have a problem with the *online* aqua server -I, the fork maintainer, am not affiliated with any public hosted instance. Contact to your server maintainer instead. - -### Can I request developer access to this repository? -Please don't. I'm not hiding anything in the repository and currently no plan to give direct write access to anyone. However, merge request is always welcome. \ No newline at end of file