Appendix - Team 37

Deployment manual

Python dependencies

Ensure Python 3.6-3.9 is installed. Make sure to install requests.

$ pip install requests

Adding MineACT to your Minecraft server

Place MineACT-1.0-RELEASE.jar into plugins folder.

Place capture_intents.py into server folder. NOTE: You will have to place your API endpoint here which can be retrieved from NoCodeAPI.
Create vf_directory folder. This is where your VF file will be. NOTE: There can only be one file at a time.

Starting up your Minecraft server

Go to CMD/Terminal.
CD to your server folder.
Start server by entering the following:

$ java -Xms2G -Xmx2G -jar spigot-1.16.3.jar -nogui

NOTE: -Xms: minimum amount of RAM, -Xmx: maximum amount of RAM. You can allocate however much is suitable for your needs.

Click here for a more detailed installation guide.

User manual

Build out a conversation in Voiceflow (you are limited to the Speak, Choice, Capture, and Condition blocks).
Export the Voiceflow conversation as a .VF file.
Go to server files and go into vf_directory.
Place your exported .VF file into this folder.
Connect to Minecraft server where MineACT has been deployed.

Enter intent to begin conversation.

Continue conversation until end. You will be rewarded with a treasure hunt. You will be prompted "Warmer" and "Colder". Find the treasure based on these prompts.

Libraries, technologies, and respective licenses

Library/technology used	Link	License
requests	https://pypi.org/project/requests/	Apache Software License (Apache 2.0)
Jackson	https://github.com/FasterXML/jackson-core/blob/master/LICENSE	Apache Software License (Apache 2.0)
Spigot	https://github.com/SpigotMC/Spigot-API/blob/master/LICENCE.txt	GNU General Public License v3.0

EULA: End User License Agreement

The software is an early proof of concept for development purposes and should not be used as-is in a live environment without further redevelopment and/or testing. No warranty is given and no real data or personally identifiable data should be stored. Usage and its liabilities are your own.

By using MineACT, you hereby agree to adhere to Mojang's End User License Agreement (EULA). We, the MineACT Team (Arifuzzaman Choudhury, Nishan Sen, Ruochen Sun), will not be held responsible for any misuse of the plugin or your own violations of Mojang's EULA.

Storing user data

MineACT does not store any user data. Any data stored will be limited to intents (i.e: phrases) which will be stored in a Google Sheet. This Google Sheet will be accessed through a NoCodeAPI endpoint. Spigot servers, however, will record a player's UUID (universally unique identifier). These are unique IDs given to every Minecraft account and cannot be avoided.

Contents of website

While creating this website, we have considered Mojang's "Minecraft Commercial Usage Guidelines". This can be found here. Any screenshots used from Minecraft have been produced by the MineACT team and therefore is in line with their guidelines.

All code snippets were created using Carbon, a free-to-use website which allows you to "create and share beautiful images of your source code".

Any logo which has been used (i.e: Python, Java, NoCodeAPI, Minecraft, Voiceflow, IBM Watson, and Google Sheets) have been found from the following links:

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.