Inner Core Mod Toolchain for Horizon is a toolchain that allows you to efficiently develop and build modifications for mobile Minecraft: Bedrock Edition directly from your PC.
To work correctly, this toolchain requires:
- Python 3.7 or higher
- node.js 10.15.1 or higher (for TypeScript modding),
tscversion 3 or higher must also be installed (to do this, runnpm install -g tsc) - Android NDK version r16b (for C++ modding), otherwise it can be installed by toolchain when needed
- Java Development Kit 1.8 (for Java modding)
It is obligatory to install only first component, the rest can be installed when necessary.
You can simply download repository, however we recommend using install script. It will help you install all necessary components for more efficient use. Open a terminal in the folder that will be used to install toolchain and enter command following the information from interactive console.
# Windows
python -c "from urllib import request; exec(request.urlopen('https://raw.githubusercontent.com/zheka2304/innercore-mod-toolchain/master/toolchain-setup.py').read().decode('utf-8'))"
# Unix
python3 -c "from urllib import request; exec(request.urlopen('https://raw.githubusercontent.com/zheka2304/innercore-mod-toolchain/master/toolchain-setup.py').read().decode('utf-8'))"Alternatively, save toolchain-setup.py for more installation and import options. Run the following command for more details.
# Windows
python toolchain-setup.py --help
# Unix
python3 toolchain-setup.py --help
For the best user experience, it is recommended to install Visual Studio Code. This environment is great for modding and can be easily improved with extensions and toolchain itself. This repository already contains all necessary files for easy interaction with this editor.
It is also recommended to install the following extensions:
- ESLint (Microsoft), TSLint now deprecated
- C/C++ Extension Pack (Microsoft)
- Extension Pack for Java (Microsoft)
Just clone or download this repository and open toolchain.code-workspace, it contains everything you need to start your journey! Use Ctrl+Shift+B to access all available options.
Most of the features are also implemented to work with IntelliJ IDEA. Use build menu to access the available scripts, or use console for more information.
Inner Core Mod Toolchain does not require an installed editor, much less an environment, to develop mods. You can run build and configuration scripts directly from console or by opening files located in toolchain/toolchain/python folder. We recommend checking out the Working with CLI for details.
To start the first build, use Build task or run ./build-all.bat or ./build-all.sh from console. You will be prompted to select a project, install additional components, and connect to the device. Most of these operations will no longer be required.
There are three types of configurations for managing projects, builds, and the toolchain itself. They describe complete process of building your project.
- make.json — to control the assembly of projects
- toolchain.json — toolchain configuration and basic properties for make.json
- template.json — template for subsequent generation make.json
Path selections can contain /**/ to select folders and all subfolders, as well as /* to select all files, /*.js or /*.jar to select all files with the desired extension.
For each of the operations, tasks Import Project, New Project and Remove Project are provided, respectively, as well as commands ./import-project.bat, ./import-project.sh, ./new-project.bat, ./new-project.sh, ./remove-project.bat and ./remove-project.sh. All operations are accompanied by interactions in console, which means that a detailed description of each of them is not required.
Use the Select Project task or ./select-project.bat and ./select-project.sh command to open selection menu. In case you can't find your project, check projectLocations property in your toolchain.json or import the project using toolchain.
In addition, for Visual Studio Code tasks Select Project by Active File, Build by Active File, e.g. are provided. They are hidden from Ctrl+P > Tasks: Run Task menu by default, but are available from the build menu Ctrl+Shift+B and can be displayed by changing .vscode/tasks.json manually.
Run the Check for Updates task or ./update-toolchain.bat and ./update-toolchain.sh command. Local components and toolchain itself will be rechecked for updates. When updating, only the folder of toolchain itself is affected, only configuration files and scripts are changed. The rest of files cannot be deleted under any circumstances, or they will be moved to a copy with .bak suffix.
Components can be installed using Reinstall Components or commands ./component-integrity.bat and ./component-integrity.sh. You can install or update them at any time using the same command, there is no uninstallation for components.
In addition to standard TypeScript build, this toolchain has built-in Java and C/C++ support. Tools for working with them are embedded in additional components that can be installed at any time if necessary.
Install Java Development Kit 1.8 (JDK) on a computer for Java development. Now, you need to download components Java R8/D8 Compiler (to optimize and bring compiled code to format of Android devices, it allows you to use lambdas and other useful features) and `Java Classpath' (contains Horizon, Inner Core and Android libraries to work with any part of engine). If at least one of these components is not installed, correct operation of environment is not guaranteed.
By default, new project contains environment settings for Java support in Visual Studio Code and IntelliJ IDEA environments. It is most convenient to use Eclipse configuration files, since they are supported "out of box" in most existing code editors. This is a project file .project, as well as .classpath with a list of built-in libraries, sources and JDK version.
The build system files are not included in new project by default, because environments will automatically create an excessive load. A simple example of using Eclipse build system is in fashion-an example, links to settings of which are in previous paragraph.
First of all, you need to install Extension Pack for Java for full support of mod projects. It contains necessary tools for all build systems supported by toolchain. Now, when you open any project folder or workspace (workspace), source files will get highlighted and will display errors and hints.
You won't need to install anything else, but a little additional configuration is needed for projects. By default, new mods contain necessary configurations. If such a project is opened (for example, mod example contains a fully configured project), sources, libraries and everything else will be determined automatically.
If this does not happen and errors are not analyzed, hints are not displayed, and project reports that JDK is not configured, you need to import project. Build system (by default Eclipse) must be configured in advance, settings will be added to existing folder after import.
Open menu File > New > Project from Existing Sources... to import a project if another project is already open. Close open mod project if it is open.
If project is not open and start screen is here, press Ctrl+Shift+A to display a list of available tasks. Start searching for Import Project from Existing Sources... and select appropriate task.
Now, find folder with toolchain and your project in it, find build system file (by type .gradle, .project, .classpath) and select it.
If you are using Eclipse build system, be sure to check Link created IntelliJ IDEA modules to Eclipse project files. This will ensure that environment configurations are automatically updated after it is restarted.
Check that JDK version is defined correctly, and finally, create a project using Create. Now, hints, error information and all other features should be available in environment.
Once development is complete, next step is to publish to Mod Browser. Execute the Assemble Mod for Release task or ./assemble-release.bat and ./assemble-release.sh command. An archive <folder_name>.icmod will be created at the root of folder. It is already completely ready for publication to site. Read article for details.
All documentation is available at https://docs.mineprogramming.org. Here you can find information about available APIs, learn the basics of modding and get acquainted with existing projects.
Slightly outdated, but no less useful information can be found at https://wiki.mineprogramming.org.
There are several options for using toolchain through the console or terminal. The first, and easiest, is to open the toolchain/toolchain/python folder in the console, manually running scripts there. You can add the same folder to PATH environment variable, how to do it on your platform can be found here.
If one of the tasks python -m icmtoolchain --list or python3 -m icmtoolchain --list is of interest to you, a great option is to integrate toolchain as a module for Python. Extend PYTHONPATH to use icmtoolchain.* imports or run commands with python -m icmtoolchain.* or python3 -m icmtoolchain.* regardless of the working directory.
# Windows
set PYTHONPATH=%PYTHONPATH%;<path to your toolchain installation>\toolchain\toolchain\python
# Unix
export PYTHONPATH="<path to your toolchain installation>/toolchain/toolchain/python":$PYTHONPATHNow you can use scripts from the console without changing your working directory, if toolchain.json configuration is present in it or any folder above, it will be used instead of the global one. Use imports from your code, this is also now possible.
from icmtoolchain import device
device.setup_device_connection()Yes, and yes again! Fork repository to yourself, we will all be happy with the new functionality. Development is done on develop branch, any pull requests outside this branch will be rejected.