You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2021/05/03 23:17:20 UTC
[incubator-nlpcraft] branch NLPCRAFT-315 updated: Update README.md
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch NLPCRAFT-315
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/NLPCRAFT-315 by this push:
new 0f4884c Update README.md
0f4884c is described below
commit 0f4884cd13224ddc77287fefaba97871ac6ad393
Author: unknown <ar...@datalingvo.com>
AuthorDate: Mon May 3 16:17:12 2021 -0700
Update README.md
---
nlpcraft-examples/minecraft/README.md | 30 ++++++++++++++++++------------
1 file changed, 18 insertions(+), 12 deletions(-)
diff --git a/nlpcraft-examples/minecraft/README.md b/nlpcraft-examples/minecraft/README.md
index e360071..afaa433 100644
--- a/nlpcraft-examples/minecraft/README.md
+++ b/nlpcraft-examples/minecraft/README.md
@@ -30,20 +30,26 @@ Second part (**../minecraft-mod**) provides mod for Minecraft server sending req
### Installation
1. Download [Minecraft client](https://www.minecraft.net/en-us/download) 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.
-1. Install Forge Server. You can either [download](https://files.minecraftforge.net/) it or grab
-
-
-1. Download [Forge server installer](https://files.minecraftforge.net/). Note that download location is full of harmful
- online ads and banners.
-1. Build mod (`cd ../minecraft-mod && ./gradlew clean build`)
-1. Copy mod to mods folder of your forge server folder (`cp build/libs/nlpcraft-mod-*.jar <forge-server-location>/mods`)
-1. (Optional) If non-default settings are used, put them in `main/resources/nlpcraft-settings.json` and copy file to `<forge-server-location>/config`
-1. Start server (`java -jar forge.jar`). For detailed instructions refer to [wiki](https://minecraft.gamepedia.com/Tutorials/Setting_up_a_server)
-1. Connect to the server from client and play!
-
+1. 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](https://github.com/apache/incubator-nlpcraft/raw/master/nlpcraft-examples/minecraft/assets/forge-1.16.5-36.1.0-installer.jar)
+ the version 1.16.5-36.1.0 or grab the latest from [here](https://files.minecraftforge.net/) (this download location, however,
+ is full or harmful online ads and banners).
+1. 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.
+1. 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`
### Startup
-Start server normally. For running probe it's required to use dedicated configuration located in [resources folder](src/main/resources/nlpcraft.conf)
+1. Start NLPCraft server in [standard](http://nlpcraft.apache.org/server-and-probe.html#server) way.
+1. Start NLPCraft probe with Minecraft model in [standard](http://nlpcraft.apache.org/server-and-probe.html#probe) way.
+1. Start Forge Server from the `%FORGE_SRV%` location: `java -jar .\forge-1.16.5-36.1.0.jar`. Make sure to accept
+ EULA by opening `%FORGE_SRV%\eula.txt` and changing `eula=false` to `eula-=true`.
+1. Start Minecraft Client and login with your Minecraft account.
+1. Choose 'Multiplayer' -> 'Add Server' and add '127.0.0.1' local server. Double-click on added server to connect to it.
+1. Play!
### Usage
After starting Minecraft server with mod, you can use natural language to invoke certain commands. It's not required to