fz-mirrors/MaaAssistantArknights
0
0
Fork 0
mirror of https://github.com/MaaAssistantArknights/MaaAssistantArknights.git synced 2026-07-18 10:10:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #689 from LYZhelloworld/doc/Helloworld/translation

Browse Source 
文档翻译工作
This commit is contained in:
MistEO
2022-06-02 01:22:34 +08:00
committed by GitHub
parent 8415a488fd 4dc670c8a8
commit 25eeaf5a59
2 changed files with 87 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/en/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,47 @@
# Contributing to MaaAssistantArknights
1. If you have forked this repository before, please go to `Settings`, scroll down to the bottom, and click `Delete Repository`.
2. Go to [MAA main repository](https://github.com/MaaAssistantArknights/MaaAssistantArknights) and click `Fork`, then `Create fork`.
3. Clone the `dev` branch of the repository (of your account) to local:
```bash
git clone "your git repo link" -b dev
```
4. Configure development environment
1. Download and install `Visual Studio 2022 Community`. Select `Desktop development with C++` and `.NET Desktop Development`.
5. Double-click to open the file `MeoAssistantArknights.sln`. Visual Studio will load the project automatically.
6. Run a build to test whether the development environment has been configured correctly. Chosse `Release` & `x64`, right-click `MeoAsstGui` to set it as the startup project, and run it. If the build is successful, the `MeoAsstGui` window will appear. You can connect to the simulator in order to confirm again that the development environment has been configured correctly.
7. Now you are free to contribute to MAA.
8. Remember to commit once you have proper number of changes. Don't forget to write a commit message.
9. After development, push your local changes to the remote (of your repository).
```bash
git push origin dev
```
10. Go to [MAA repository](https://github.com/MaaAssistantArknights/MaaAssistantArknights) and submit a Pull Request. Wait until the administrator approves it. Please note that the changes should be based on `dev` instead of `master` branch, and should be merged to `dev` branch as well.
11. When there are changes from other contributors on original MAA repository, it is necessary for you to merge them to your forked repository.
1. Add MAA upstream repository.
```bash
git remote add upstream https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
```
2. Fetch upstream changes from the repository.
```bash
git fetch upstream
```
3. Merge changes.
```bash
git merge
```
4. Repeat step 7-10.
Note: operations regarding to Git can be done by VS2022 instead of command line tools, using the Git changes tab.

40
docs/en/FAQ.md Normal file
View File

@@ -0,0 +1,40 @@
## Frequently Asked Questions
### The program crashes immediately when I try to run it.
- Possible solution 1: you are missing some runtime libraries.
Please try installing [Visual C++ Redistributable](https://docs.microsoft.com/en/cpp/windows/latest-supported-vc-redist?view=msvc-160#visual-studio-2015-2017-2019-and-2022), [.NET Framework 4.8](https://dotnet.microsoft.com/download/dotnet-framework/net48) and restart the program.
- Possible solution 2: your CPU instruction set is incompatible.
This project requires `PaddleOCR` to do the image recognition, which requires `AVX` instruction set that is supported by only some of the newly-released CPUs, while others may not support it.
You can also try downloading `PaddleOCR` [NoAVX](../3rdparty/ppocr_noavx.zip) version, unzip and replace the files with the same names. Since it may cause performance drop, please do not use it unless it is necessary.
([CPU-Z](https://www.cpuid.com/softwares/cpu-z.html) is a tool that provides check of existence of `AVX` instruction set.)
- If those solutions above do not work, please submit an issue to us.
### Connection error/not knowing how to fill in ADB path
Tips: please refer to the [Usage](../README-en.md#Usage) section to ensure that you are using your simulator correctly.
- Approach 1: find the installation path of your simulator, where there may be a file named `adb.exe` (or something similar, e.g. `nox_adb.exe`, `HD-adb.exe`, `adb_server.exe`, etc., EXE files with `adb`). Simply choose the file in the connection settings of MAA!
- Approach 2: please refer to the [Custom Connection](#Custom Connection) section.
- Approach 3: change another simulator, such as [Bluestacks international version](https://www.bluestacks.com/download.html) Nougat 64 bit
- Approach 4: change the code related. You can find the code [here](../src/MeoAsstGui/Helper/WinAdapter.cs) written in C# which is related to the hook on the simulator process and getting ADB path. Feel free to submit PR to us!
### Wrong Recognition/Program freezes after starting
Tip 1: The `Current Stage` of auto battle that costs Sanity requires you to go to the screen with the start button. Please confirm they are not related.
Tip 2: Follow the steps below until the problem is solved.
1. Confirm that your simulator is supported in the [List of the Supported Simulators](List of the Supported Simulators.md).
2. Change the DPI to `320 dpi`.
3. Change the resolution to landscape, `1280 * 720`.
4. Try with another simulator, such as [Bluestacks international version](https://www.bluestacks.com/download.html) Nougat 64 bit. (Please note that you are required to switch on ADB in Bluestack simulator.)
5. Submit an issue to us if the problem still exists.
### Custom Connection
- Download [adb](https://dl.google.com/android/repository/platform-tools-latest-windows.zip) and unzip it.
- Go to `Settings` - `Connection Settings`, and select the location of `adb.exe`, fill in the address of ADB (with the format of IP+port, e.g. `127.0.0.1:5555`), and choose the type of your simulator.
### ADB already exists in the environment variable. Do I stil need to download it?
You need not do so! Go to `Settings` - `Connection Settings`, and set `ADB path` to `adb.exe`, or other relative path.