Skip to content

Commit

Permalink
Some english language fixes and README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
AyHa1810 committed Mar 13, 2021
1 parent c2b15e1 commit 8de8a7d
Show file tree
Hide file tree
Showing 6 changed files with 225 additions and 226 deletions.
1 change: 0 additions & 1 deletion .idea/gradle.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions app/src/main/res/values-en/strings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<string name="title_all">All</string>
<string name="title_in_game">In-game</string>
<string name="title_out_game">Outside the game</string>
<string name="title_out_game">Out-game</string>
<string name="title_language">Language</string>
<string name="title_restore">Restore</string>
<string name="title_game_list">Game List</string>
Expand All @@ -31,8 +31,8 @@
<string name="title_plugin">Plug-in</string>
<string name="title_add_plugin">Add Plug-in</string>
<string name="title_show">show</string>
<string name="title_launcher_private_path">Private directory</string>
<string name="title_launcher_public_path">Public directory</string>
<string name="title_launcher_private_path">App directory</string>
<string name="title_launcher_public_path">External directory</string>
<string name="title_setting_basic">Basic Settings</string>
<string name="title_keyboard_layout">Keyboard Layout</string>
<string name="title_max_memory">Maximum Memory (MB)</string>
Expand Down Expand Up @@ -63,7 +63,7 @@
<string name="title_user">User</string>
<string name="title_manager">Management</string>
<string name="title_select_version">Select Version</string>
<string name="title_launch_game">Start the game</string>
<string name="title_launch_game">Launch</string>
<string name="title_download_source">Minecraft Download Source</string>
<string name="title_import_runtime">Import Runtime</string>
<string name="title_import">Import</string>
Expand Down Expand Up @@ -185,9 +185,9 @@
<string name="tips_user_namehint">Username or email</string>
<string name="tips_please_enter_password">Please enter your password</string>
<string name="tips_downloader_warn">If the list is not displayed for a long time, please manually click "Refresh"\nPlease be patient and wait for the download to complete. If the download is slow, please try to change to another download source.</string>
<string name="tips_launcher_path">Note: Using "Private Directory" does not need to grant MCinaBox write permissions, but uninstalling MCinaBox will lose all the data in the "Private Directory"!</string>
<string name="tips_jvm_extra_args">Java Virtual Machine parameters (no need to fill)</string>
<string name="tips_minecraft_extra_args">Minecraft additional parameters (no need to fill)</string>
<string name="tips_launcher_path">Note: Using "App Directory" does not need to grant MCinaBox write permissions, but uninstalling MCinaBox will lose all the data in the "App Directory"!</string>
<string name="tips_jvm_extra_args">Java VM Arguments (Advanced)</string>
<string name="tips_minecraft_extra_args">Minecraft Arguments (Advanced)</string>
<string name="tips_refresh_finished">Refresh finished</string>
<string name="tips_please_refresh">Please refresh</string>
<string name="tips_please_select_version">Please select the game version</string>
Expand Down Expand Up @@ -223,7 +223,7 @@
<string name="tips_tipper_not_allow_launch">There is error level information, launch is blocked, please handle it in tipper manager.</string>
<string name="tips_tipper_is_not_void_and_user_canceled">There are unprocessed messages in the tipper manager, and the user ended the operation.</string>
<string name="tips_checking_launcher_setting">Checking the launcher configuration…</string>
<string name="tips_have_no_minecraft_please_install">No game detected, please install a Minecraft version first.</string>
<string name="tips_have_no_minecraft_please_install">No installation detected, please install a Minecraft version first.</string>
<string name="tips_checking_runtime">Checking runtime…</string>
<string name="tips_have_no_runtime_please_install">The runtime is not detected, please install the runtime first.</string>
<string name="tips_checking_system_platform">Checking system architecture…</string>
Expand Down
20 changes: 10 additions & 10 deletions app/src/main/res/values/strings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<string name="title_all">All</string>
<string name="title_in_game">In-game</string>
<string name="title_out_game">Outside the game</string>
<string name="title_out_game">Out-game</string>
<string name="title_language">Language</string>
<string name="title_restore">Restore</string>
<string name="title_game_list">Game List</string>
Expand All @@ -42,8 +42,8 @@
<string name="title_plugin">Plug-in</string>
<string name="title_add_plugin">Add Plug-in</string>
<string name="title_show">show</string>
<string name="title_launcher_private_path">Private directory</string>
<string name="title_launcher_public_path">Public directory</string>
<string name="title_launcher_private_path">App directory</string>
<string name="title_launcher_public_path">External directory</string>
<string name="title_setting_basic">Basic Settings</string>
<string name="title_keyboard_layout">Keyboard Layout</string>
<string name="title_max_memory">Maximum Memory (MB)</string>
Expand Down Expand Up @@ -74,7 +74,7 @@
<string name="title_user">User</string>
<string name="title_manager">Management</string>
<string name="title_select_version">Select Version</string>
<string name="title_launch_game">Start the game</string>
<string name="title_launch_game">Launch</string>
<string name="title_download_source">Minecraft Download Source</string>
<string name="title_import_runtime">Import Runtime</string>
<string name="title_import">Import</string>
Expand Down Expand Up @@ -196,9 +196,9 @@
<string name="tips_user_namehint">Username or email</string>
<string name="tips_please_enter_password">Please enter your password</string>
<string name="tips_downloader_warn">If the list is not displayed for a long time, please manually click "Refresh"\nPlease be patient and wait for the download to complete. If the download is slow, please try to change to another download source.</string>
<string name="tips_launcher_path">Note: Using "Private Directory" does not need to grant MCinaBox write permissions, but uninstalling MCinaBox will lose all the data in the "Private Directory"!</string>
<string name="tips_jvm_extra_args">Java Virtual Machine parameters (no need to fill)</string>
<string name="tips_minecraft_extra_args">Minecraft additional parameters (no need to fill)</string>
<string name="tips_launcher_path">Note: Using "App Directory" does not need to grant MCinaBox write permissions, but uninstalling MCinaBox will lose all the data in the "App Directory"!</string>
<string name="tips_jvm_extra_args">Java VM Arguments (Advanced)</string>
<string name="tips_minecraft_extra_args">Minecraft Arguments (Advanced)</string>
<string name="tips_refresh_finished">Refresh finished</string>
<string name="tips_please_refresh">Please refresh</string>
<string name="tips_please_select_version">Please select the game version</string>
Expand All @@ -213,7 +213,7 @@
<string name="tips_import_failed">Import Failed</string>
<string name="tips_not_install_runtime">Runtime is not installed</string>
<string name="tips_not_selected_user">No user is created or selected</string>
<string name="tips_not_select_version">Game version is not downloaded or selected</string>
<string name="tips_not_select_version">Any game version is not downloaded or selected</string>
<string name="tips_available_memory_low">Memory limit is too low</string>
<string name="tips_available_memory_over">Memory limit is too high</string>
<string name="tips_downloading_manifest">Downloading manifest file…</string>
Expand All @@ -234,14 +234,14 @@
<string name="tips_tipper_not_allow_launch">There is error level information, launch is blocked, please handle it in tipper manager.</string>
<string name="tips_tipper_is_not_void_and_user_canceled">There are unprocessed messages in the tipper manager, and the user ended the operation.</string>
<string name="tips_checking_launcher_setting">Checking the launcher configuration…</string>
<string name="tips_have_no_minecraft_please_install">No game detected, please install a Minecraft version first.</string>
<string name="tips_have_no_minecraft_please_install">No installation detected, please install a Minecraft version first.</string>
<string name="tips_checking_runtime">Checking runtime…</string>
<string name="tips_have_no_runtime_please_install">The runtime is not detected, please install the runtime first.</string>
<string name="tips_checking_system_platform">Checking system architecture…</string>
<string name="tips_platform_not_correct_may_cause_crash">It is detected that the runtime architecture does not match your system architecture, which may cause startup failure or performance loss. Do you want to continue?</string>
<string name="tips_platforn_not_correct_and_user_canceled">The runtime library architecture did not confirm to the system, and the user ended the operation.</string>
<string name="tips_checking_main_file">Checking game\'s core file…</string>
<string name="tips_not_found_main_jar_please_reinstall">The Minecraft JAR main file was not found. Please reinstall the Minecraft version.</string>
<string name="tips_not_found_main_jar_please_reinstall">The Minecraft JAR file was not found. Please reinstall the Minecraft version.</string>
<string name="tips_checking_libraries">"Checking game dependencies…</string>
<string name="tips_lose_libraries">Incomplete dependent library detected, missing files:\n%s Do you want to continue?</string>
<string name="tips_lose_libraries_and_user_canceled_please_reinstall_minecraft">The Minecraft dependency library is incomplete. Please reinstall the Minecraft version. The user has finished the operation.</string>
Expand Down
153 changes: 78 additions & 75 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,116 +1,119 @@
# MCinaBox - A Minecraft Java Edition Launcher on Android
[现在是简体中文] [Change to English](./README_en.md)</br>

如果你在使用时发现问题,可以先查看[Q&A](./Q&A.md)

## 简介
- MCinaBox是一个运行在Android系统的 Minecraft Java Edition 启动器, 它的核心功能由[CosineMath](https://github.com/CosineMath)[BoatApp](https://github.com/AOF-Dev/BoatApp)项目提供。

## 目录
- [项目背景](#项目背景)
- [更新日志](#更新日志)
- [构建](#构建)
- [使用](#使用)
- [预览](#预览)
- [已知问题](#已知问题)
- [维护者](#维护者)
- [许可](#许可)
- [贡献者](#贡献者)
- [依赖的开源项目库](#依赖的开源项目)
[Now in English] [切换为简体中文](./README_zh-cn.md)</br>


If you find problems when you run MCinaBox, you can check [Q&A](./Q&A.md) first.

## Instruction
- MCinaBox is a Launcher of Minecraft Java Edition on Android. The core functionality is powered by [CosineMath](Https://github.com/CosineMath)'s [BoatApp](https://github.com/AOF-Dev/BoatApp) project.
# Discord
https://discord.gg/55GECvHuNd

![Discord Banner 2](https://discord.com/api/guilds/808182854718062623/widget.png?style=banner2)
## Contents
- [Background](#Background)
- [Change Log](#Change-Log)
- [Build](#Build)
- [Usage](#Usage)
- [Preview](#Preview)
- [Known Issues](#Known-Issues)
- [Maintainers](#Maintainers)
- [License](#License)
- [Contribution](#Contribution)
- [Related](#Related)
- [Q&A](./Q&A.md)

## 项目背景
- `MCinaBox`是一个开源项目,目标是构建并发展一个运行在Android系统上的Minecraft Java版的启动器。
- `前端` 提供用户管理、Minecraft版本管理、Minecraft游戏控制器、Minecraft启动参数生成、配置后端等`配置``管理`功能,减少完整的启动器开发的工作量。
- `后端` 提供JRE运行环境、Minecraft运行环境等`核心`功能。
- `组成` MCinaBox 启动器由前端和后端共同组成
## Background
- `MCinaBox` is an open source project with the goal of building and developing a Minecraft Java Edition launcher that runs on an Android.
- `Front End` provides User Management, Minecraft Version Management, Minecraft Game Controller, Minecraft Startup Parameter Generation, Configuration Backend, etc`Configuration` and `Management` functions to reduce the workload of complete launcher development.
- `Backend` provides JRE runtime environment, Minecraft runtime environment, etc `core` functionality.
- `Composition` MCinaBox consists of a front end and a back end.

## 更新日志
## Change Log
- [English](./CHANGELOG.md)
- [Chinese](./CHANGELOG_zh-cn.md)

## 构建
## Build

### 准备开发环境
### Environment
- Android Studio
- Android NDK
- Git

### 克隆到本地
### Clone
- ```git clone https://github.com/AOF-Dev/MCinaBox.git ```

### 导入项目到AS
- 将此项目导入你的 Android Studio
### Import
- Import this project in your Android Studio.

### 编译
- 通过 Android Studio 编译项目
### Build
- Build via Android Studio.

#### 你也可以从[这里](https://github.com/AOF-Dev/MCinaBox/releases)获得发布的APK。
#### You can also get released apk from [here](https://github.com/AOF-Dev/MCinaBox/releases).

## 使用
## Usage

### 安装
1. 将最新的APK和运行库下载到你的Android手机。
2. 然后启动APK并找到 `启动器设置` - `导入运行库` 点击 `导入` 以导入运行库。
3. 或者,你也可以将运行库移动到 `/sdcard/Android/com.aof.mcinabox/files/MCinaBox/runtime` 文件夹下,然后重复上一步的操作。
### Installation
1. Download the latest APK and runtime to your Android phone.
2. Then start APK and find `Launcher Settings` - `Import Runtime`. Click `Import` to import runtime.
3. Alternatively, you can move the runtime to `/ sdcard / Android/ com.aof.mcinabox/files/MCinaBox/runtime` , and then repeat the previous step.

### 开始
1. 首先,你需要创建一个用户。 请在 `左侧导航栏` - `用户` - `添加新用户` 来创建一个用户
2. 其次,你需要下载Minecraft。 请在 `左侧导航栏` - `游戏列表` - `安装新游戏版本` 下载Minecraft游戏
3. 最后,你将要启动游戏。 请在`左侧导航栏` - `主页` 选择一个Minecraft版本并启动。
### Start
1. First, you need to create a user. Click `User` - `Add new User` to create a user.
2. Second, you need to download Minecraft. Click `Game List` - `Install new version` to download Minecraft.
3. Finally, you will start the game. Please select a Minecraft version on `home page` and start the game.

### Forge API
1. 首先,请在Forge官网下载Forge-Installer,必须是`通用版`的且是`jar`格式。
2. 然后,请将下载的jar文件放入`/sdcard/Android/com.aof.mcinabox/files/MCinaBox/forge`文件夹中。
3. 最后,请打开MCinabox,在`左侧导航栏` - `启动器设置` - `Forge本地安装其` 选择并安装forge版本。
1. First, download Forge-Installer from Forge. It must be in `Universal` and `jar` format.
2. Then put the downloaded jar file in `/sdcard/Android/com.aof.mcinabox/files/MCinaBox/forge`.
3. Finally, open the MCinaBox and click `Launcher Settings` - `Forge Installer` to select and install the forge.

### 自定义
1. MCinaBox提供了大量的自定义选项,你可以在 `左侧导航栏你` - `游戏列表` - `全局游戏设置` 中配置你的启动参数。
2. MCinaBox提供了自定义Minecraft工作目录的功能,你可以在 `左侧导航栏` - `游戏目录` 中配置你的Minecraft工作目录。
3. MCinaBox提供了自定义游戏控制器的功能,你可以在 `左侧导航栏` - `虚拟键盘设置` 中创建你的虚拟键盘布局。
### Customize
1. MCinaBox offers a number of customization options, you can configure your launcher parameters in the `Game List` - `Global Game Settings`.
2. MCinaBox provides the ability to customize your Minecraft working directory by configuring your Minecraft working directory in the `Game Directory`.
3. MCinaBox provides the ability to customize your game controller by creating your virtual keyboard layout in the `Virtual Keyboard Settings`.

### 服务器验证
1. MCinaBox支持Minecraft的官方服务器验证,你可以在创建用户时,勾选 `在线登陆` ,输入你的Mojang账户和密码来进行登录。
2. MCinaBox支持Authlib-Injector的服务器验证,你可以在创建用户时,勾选 `在线登陆` ,输入你的账户和密码和验证服务器的地址来进行登录。
3. MCinaBox按照规范优先选择https协议进行通信。
4. MCinaBox不会以任何形式记录你的密码。
### Online
1. MCinaBox supports Mojang's official server authentication. When you create a user, you can check `Online login` and enter your Mojang account and password to log in.
2. MCinaBox supports server authentication for Authlib-Injector. When you create a user, you can check `Online login`, enter your account and password, and verify the address of the server to log on.
3. MCinaBox will not record your password in any way.

## 预览
## Preview

## 已知问题
## Known Issues

### 启动器
### Launcher
1. Microsoft Authentication API is not added, so you'll not be able to login with Microsoft Account.

### 我的世界
1. Forge的加载动画会导致崩溃。
2. 在低于1.6的Minecraft版本中启动似乎会出现X11错误。
3. 无法初始化Minecraft 1.13.x。
### Launch Minecraft
1. Forge's loading animation will cause a crash
2. It seems that there will be an X11 error when starting the Minecraft version below 1.6

## 维护者
## Maintainers
[@AOF-Dev](https://github.com/AOF-Dev)

## 许可
该软件根据[GPL v3](https://www.gnu.org/licenses/gpl-3.0.html)和附加条款进行分发。
### 附加条款(依据 GPLv3 协议第七条)
1. 当你分发本程序的修改版本时,你必须以一种合理的方式修改本程序的名称或版本号,以示其与原始版本不同。 [依据 GPLv3, 7(c).]
2. 你不得移除本程序所显示的版权声明。[依据 GPLv3, 7(b).]
## License
The software is distributed under [GPL v3](https://www.gnu.org/licenses/gpl-3.0.html) with additional terms.
### Additional terms under GPLv3 Section 7
1. When you distribute a modified version of the software, you must change the software name or the version number in a reasonable way in order to distinguish it from the original version. [under GPLv3, 7(c).]
2. You must not remove the copyright declaration displayed in the software. [under GPLv3, 7(b).]

## 贡献者
这个项目的存在要感谢所有贡献者。
## Contribution
This project exists thanks to all the people who contribute.

### 贡献者列表:
- [全部](https://github.com/longjunyu2/MCinaBox/graphs/contributors)
### List of contributors:
- [ALL](https://github.com/longjunyu2/MCinaBox/graphs/contributors)
- `MCredbear`
- 所有提出Issues的人。
- All people who put forward issues.


如果要提交拉取请求,则有一些要求:
If you want to submit a pull request, there're some requirements:
* IDE: Android Studio
* TargetSDK: 22
* MimniumSDK: 21
* 不要修改`gradle`文件。
* DO NOT modify `gradle` files.

## 依赖的开源项目
## Related
* [BoatApp (CosineMath,GPL 2.0)](https://github.com/AOF-Dev/BoatApp)
* Gson (Google,Apache 2.0)
* XZ for Java (Lasse Collin,Public Domain)
Expand All @@ -119,7 +122,7 @@
* [BubbleLayout (MasayukiSuda,All)](https://github.com/MasayukiSuda/BubbleLayout)
* [AndroidRocker (kongqw,All)](https://github.com/kongqw/AndroidRocker)
* [colorpicker (QuadFlask,All)](https://github.com/QuadFlask/colorpicker)
- `运行库`
- `Runtime Pack`
* [GL4ES (ptitSeb,MIT)](https://github.com/ptitSeb/gl4es)
* [OpenJDK-8 (CosineMath,GPL-2.0)](https://github.com/CosineMath/openjdk-jdk8u-aarch32-android)
* [OpenJDK-8 (CosineMath,GPL-2.0)](https://github.com/AOF-Dev/openjdk-aarch64-jdk8u-androidport)
Expand Down
Loading

0 comments on commit 8de8a7d

Please sign in to comment.