Overview

This module is part of Minecraft example. This part provides model for Minecraft server commands. Second part (../minecraft-mod) provides mod for Minecraft server sending requests to the NLPCraft server.

Installation

1. Download Minecraft client and install it on your local machine. This is the actual game. Note that Minecraft is NOT a free game, and you will need to purchase it and have an account to play it.
2. Download Forge Server. Minecraft is a client-server game. This is the server to which the Minecraft client will connect to and where the NLPCraft's Minecraft mod will be installed. Download the version 1.16.5-36.1.0 or grab the latest from here (warning: this download location, however, is full or harmful online ads and banners).
3. Install downloaded Forge Server by going to your download location and running java -jar forge-1.16.5-36.1.0-installer.jar. Make sure to select ‘Install Server’ when presented with options. Note the location of the installed Forge Server (default or selected by you) in the last line of the installer log output. For example, on Windows it installs by default to C:\Users\User\AppData\Roaming\.minecraft. For convenience, set %FORGE_SRV% variable to point to this location.
4. Copy pre-built NLPCraft's Minecraft mod to Forge Server mods folder. Pre-built mod is located in assets sub-folder of the minecraft-mod module. To copy, first create folder %FORGE_SRV%\mods and run this from the command line cp .\nlpcraft-examples\minecraft-mod\assets\nlpcraft-example-minecraft-mod-1.0.jar %FORGE_SRV%\mods

Start

1. Start NLPCraft server in a standard way.
2. Start NLPCraft probe with Minecraft model in a standard way (from minecraft example).
3. Accept Forge Server EULA by opening %FORGE_SRV%\eula.txt file and changing eula=false to eula-=true.
4. Start Forge Server from the %FORGE_SRV% location: java -jar .\forge-1.16.5-36.1.0.jar.
5. Start Minecraft Client and login with your Minecraft account.
6. Choose ‘Multiplayer’ -> ‘Add Server’ and add ‘127.0.0.1’ local server. Double-click on the newly added server to connect to it.
7. Play Minecraft! 🤘

Usage

Natural language commands could be entered either on Forge Server (e.g. make it sunny) or in the game itself, i.e. on the Minecraft client side, prefixed with slash (/make it sunny). See file MinecraftModel.kt file for some examples of possible commands.

Documentation

For any questions, feedback or suggestions:

• View & run other examples
• Read documentation, latest Javadoc and REST APIs
• Download & Maven/Grape/Gradle/SBT instructions
• File a bug or improvement in JIRA
• Post a question at Stack Overflow using nlpcraft tag
• Access GitHub mirror repository.
• Join project developers on dev@nlpcraft.apache.org

Copyright

Copyright (C) 2020 Apache Software Foundation