Skip to content

Commit 5d75342

Browse files
author
CosineMath
committed
Update README
1 parent 024967c commit 5d75342

File tree

2 files changed

+54
-10
lines changed

2 files changed

+54
-10
lines changed

README-zh_CN.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Boat - 在 Android 设备上运行 Minecraft Java 版
2+
3+
## 目录
4+
- [简介](#简介)
5+
- [构建](#构建)
6+
- [组件](#组件)
7+
- [相关项目](#相关项目)
8+
- [许可](#许可)
9+
10+
## 简介
11+
Boat 提供一个在 Android 上运行 Mincraft Java 版的环境,显然它不是一个模拟器。它起源自 zhuowei 的 [Boarwalk](https://github.com/zhuowei/Boardwalk)。Boat 提供一系列开源软件的 Android 移植,例如 OpenJDK。这个仓库存储的是 Boat 的
12+
Android app 部分。其他软件包可在其各自的仓库里找到。参看[组件](#组件)
13+
14+
这个 app 包含一个非常简单的 Minecraft 启动器,仅仅用于开发中的测试。
15+
16+
## 构建
17+
要构建整个项目是非常麻烦的,所以我们不建议你自己从源码构建整个项目。不过你可能希望自己构建和更新某些组件。请参看仓库中关于构建的说明。
18+
19+
我们有一个[参考资料仓库](https://github.com/AOF-Dev/Boat-reference-material),希望能分享各种关于 Boat 的参考资料 :)
20+
21+
构建指南:
22+
1. 构建可用于 Android 的 OpenJDK 8。
23+
2. 构建本项目。请注意保存好 `libboat.so``boat.h`,其他项目会使用到的。
24+
3. 构建适用于 Android 的 GL4ES 与 OpenAL-soft。
25+
4. 构建针对 Boat 的 LWJGL 2 。需要用到 `libboat.so``boat.h`
26+
5. 构建针对 Boat 的 GLFW 。需要用到 `libboat.so``boat.h`
27+
6. 构建针对 Boat 的 LWJGL 3 。需要 GLFW 。
28+
29+
## 组件
30+
- [OpenJDK 8 Android port](https://github.com/CosineMath/openjdk-jdk8u-aarch32-android).
31+
- [Boat app project](https://github.com/CosineMath/BoatApp).
32+
- [GL4ES](https://github.com/ptitSeb/gl4es).
33+
- [OpenAL-soft](https://github.com/kcat/openal-soft).
34+
- [LWJGL 2 port for Boat](https://github.com/CosineMath/lwjgl-boat).
35+
- [GLFW port for Boat](https://github.com/CosineMath/glfw-boat).
36+
- [LWJGL 3 port for Boat](https://github.com/CosineMath/lwjgl3-boat).
37+
- [Gson](https://github.com/google/gson)
38+
- [Commons Compress](https://github.com/apache/commons-compress).
39+
- [XZ for Java](https://git.tukaani.org/?p=xz-java.git;a=summary).
40+
41+
## 相关项目
42+
- [MCinaBox](https://github.com/AOF-Dev/MCinaBox). 一个用于 Android 的 Minecraft Java 版启动器,基于 Boat 提供 Minecraft 运行环境。
43+
44+
## 许可
45+
本项目以 [GPL v2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) 授权。各个组件有其各自的许可。
46+

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Boat - Running Minecraft Java Edition on Android
2-
2+
[中文](./README-zh_CN.md)
33
## Contents
44
- [Introduction](#Introduction)
55
- [Building](#Building)
@@ -15,16 +15,15 @@ This repository contains the Android app part of Boat. Other packages could be f
1515
## Building
1616
It takes time to build whole project. So it is not suggested to build whole one youself. But you may want to build and update some components. Please follow the instructions in the repositories.
1717

18-
This app project uses old-fashioned Eclipse Ant building system. You should copy the source code into your Android Studio project (Maybe your own Minecraft launcher app :) ).
18+
We set up a [reference material repository](https://github.com/AOF-Dev/Boat-reference-material), hoping that we can collect useful imformation about boat :).
1919

2020
Building instruction:
21-
1. Build OpenJDK 8 Android port (https://github.com/CosineMath/openjdk-jdk8u-aarch32-android).
21+
1. Build OpenJDK 8 Android port.
2222
2. Build this app project. Note that you should copy `libboat.so` and `boat.h` that other components depend on.
23-
3. Build GL4ES (https://github.com/ptitSeb/gl4es) and OpenAL-soft (https://github.com/kcat/openal-soft) for Android.
24-
Instruction:
25-
4. Build LWJGL 2 port for Boat (https://github.com/CosineMath/lwjgl-boat). Need `libboat.so` and `boat.h`.
26-
5. Build GLFW port for Boat (https://github.com/CosineMath/glfw-boat). Need `libboat.so` and `boat.h`.
27-
6. Build LWJGL 3 port for Boat (https://github.com/CosineMath/lwjgl3-boat). Need GLFW port for Boat.
23+
3. Build GL4ES and OpenAL-soft for Android.
24+
4. Build LWJGL 2 port for Boat. Need `libboat.so` and `boat.h`.
25+
5. Build GLFW port for Boat. Need `libboat.so` and `boat.h`.
26+
6. Build LWJGL 3 port for Boat. Need GLFW port for Boat.
2827

2928
## Components
3029
- [OpenJDK 8 Android port](https://github.com/CosineMath/openjdk-jdk8u-aarch32-android).
@@ -34,13 +33,12 @@ This repository contains the Android app part of Boat. Other packages could be f
3433
- [LWJGL 2 port for Boat](https://github.com/CosineMath/lwjgl-boat).
3534
- [GLFW port for Boat](https://github.com/CosineMath/glfw-boat).
3635
- [LWJGL 3 port for Boat](https://github.com/CosineMath/lwjgl3-boat).
37-
- [JNDCrash](https://github.com/ivanarh/jndcrash)
3836
- [Gson](https://github.com/google/gson)
3937
- [Commons Compress](https://github.com/apache/commons-compress).
4038
- [XZ for Java](https://git.tukaani.org/?p=xz-java.git;a=summary).
4139

4240
## Related-Projects
43-
- [MCinaBox](https://github.com/longjunyu2/MCinaBox). A Minecraft Java Edition Launcher on Android. Using Boat to provide runtime environment.
41+
- [MCinaBox](https://github.com/AOF-Dev/MCinaBox). A Minecraft Java Edition Launcher on Android. Using Boat to provide runtime environment.
4442

4543
## License
4644
This app project is distributed under [GPL v2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html). Other components have their respective license.

0 commit comments

Comments
 (0)