The robots are coming to SKYBLOCK.SK, here is an example of a robot with a chicken design.
Hello everyone,
Today, I have a big new add-on to show off you guys. While creating, testing, debugging and integrating it into SKYBLOCK.SK took some time, I think it is a very nice feature for server operators to make the late game of SkyBlock way more interesting with this add-on. As you seen in the thumbnail of this post, it is about adding robots to the game. Some other changes have been done too.
1. Repository
https://github.com/Abwasserrohr/SKYBLOCK.SK
2. Index
- Repository
- Index
- New Features
3.1. Splitconfig.skinto multiple configurations
3.2. Custom heads now use NBT
3.3. Added robots - Pull requests
- GitHub Account
- How to contribute
3. New Features
3.1. Split config.sk into multiple configurations
The config.sk grew into a massive file. While it is very handy to just have one file, it is confusing to find the right part to configure. Because it should be easy to configure SKYBLOCK.SK, I decided to split the config.sk into multiple parts, which are now located in the SkyBlock/config/ folder:
- core.sk
- challenges.sk
- upgrades.sk
- oregenerator.sk
- islands.sk
- flags.sk
- blocks.yml
- biomes.sk
These files are named to be easy understandable for what they're there.
Pull request: https://github.com/Abwasserrohr/SKYBLOCK.SK/pull/127
3.2. Custom heads now use NBT
Previously, the heads have got their custom NBT using Minecraft vanilla commands, which isn't the best way of doing it. While it was short and easy to do, saving NBT using nms classes from Minecraft is the best way of doing so.
That's why NBT for custom heads is now saved with nms classes. Because I'm going to do some stuff with custom NBT with the robots, I decided to not go any further here how I accomplished doing it. But understanding how NBT works was quite a task for me. I'm now really happy about the first working results with NBT here with the custom heads and the robots. =)
Pull request: https://github.com/Abwasserrohr/SKYBLOCK.SK/pull/129
3.3. Added robots
Robots are there to automate things, while it is already possible for players to run client mods, which do the exactly same, with the robots, we can control how fast and efficient they are. Next to the robots are standing players with client mods, which can farm with maximum enchantments which would be much more efficient.
The robots are a nice enhancement of servers which do not allow players to use these mods or farm afk. Because these are limited in their efficiency and can be sold expensive, it isn't possible for everyone to use them instantly.
These robots are not only interesting for SKYBLOCK.SK but could also be used on other servers. While there are already plugins which do almost the same thing as I did with these robots, I have ensured to have the following things which others may lack of:
- It is written in Skript instead of Java to make it easy to configure and integrate into existing systems
- Storage based on NBT (a compressed file format included in Minecraft)
- Handling of unloading chunks & server stops
- Open Source (MIT licence) others I have seen are proprietary and some also cost money to use, around 10 - 20 USD
- Multiple designs and jobs the player can use for his robot (also easy customizable)
- The robot stores statistics can be relocated and keeps the statistics.
- Multiple languages can be used at the same time for each user. Most plugins only allow one language for the entire server.
These things above where the main reasons why I created an alternative for it in Skript.
Here is a video of them and how they work. This is the first version of them. They still need some more jobs but the core features and functions are there.
One part that I wanted to do here is to use NBT instead of variables or item lore. With NBT, I can store much more data without using the Skript variables or setting the lore, which is visible to the player. That makes NBT a really nice option.
For that, I created two new functions which allow saving and loading strings using NBT.
To make the functions fully work, I had to import some nms classes using skript-mirror.
After importing I tried to create the functions, once I got into the process of how this works, it is pretty easy to understand what it does. But understanding it in the first place on how it works and what NBT is wasn't that easy for me. =)
NBT is a great way to save data directly to an item or an armor stand in the game. The game handles saving the data directly, which is very handy, because we're dealing with robots. These robots are placed in the world and it makes sense to save their data directly in the world. The advantage over saving the data in a variable is also that it is only loaded if it is really needed. This way, millions of robots could be placed all over the server without a problem.
Here is the function for setting a string in the NBT format.
This function is doing only basic stuff. But we don't need more than that here.
Here is how it works in steps:
- The function is called with an item, a tag and a string.
The item is the item which should get the NBT tag written to it, the tag is like the variable name and the string is any string we want to save to the item. - The function coverts the item to an nms
CraftItemStack.
With these nmsCraftItemStacks, we can do more than with the normalItemStack. Saving NBT data to it is possible through these nmsCraftItemStacks. - Get already existing NBT data or create a new NBT data format.
- Set a string to a tag into the NBT data format using the NBTTagCompound api.
- Parse the NBT back to the right format and save it with the MojangsonParser Java class.
- Set the valid NBT back to the item and return the new item with the new NBT data.
Now, we can also get strings out of it, with this function:
Loading data out is easier than saving new data.
- Call the function with an item and the tag we want.
- Convert the item to an nms
CraftItemStack. - Get the NBT data as local variable.
- Check if the tag which has been set as parameter is there.
- If there is no such tag, return false. If it exists, get the string and then return it.
Now this is only a very small part of the robots, but it is a very important part of it.
There is much, what the robot has to be able to do. You can view all the tasks which have been done in the pull request here.
Here is another important step, which needs to be handled by the skript. If the robot is running and the server is stopping, the robot should stop correctly. If it wouldn't stop correctly, it might have problems starting again later or would confuse the player with incorrect display information.
While I didn't need any variables for saving anything about the robot, I needed a variable to know if a robot is currently loaded. That way, I can easily stop it on unload by looping through all robots.
Stopping it is done by changing its name and the metadata value of the key "robo" to 2. Because the robots are available in multiple languages later, it is also needed that the robot doesn't set its state as [ON|OFF] but in the right language, as example in German in [AN|AUS]. This is why it takes here also the uuid of the owner and gets the language code. That way, the robot keeps always the language of the owner.
The movement of the robots is done by changing their EulerAngle, this way, we can change every body part of the robot, which is going to be very useful for animations in the future.
4. Pull requests
https://github.com/Abwasserrohr/SKYBLOCK.SK/pull/127
https://github.com/Abwasserrohr/SKYBLOCK.SK/pull/129
https://github.com/Abwasserrohr/SKYBLOCK.SK/pull/130
5. GitHub Account
https://github.com/Abwasserrohr
6. How to contribute
If you're interested in contributing to SKYBLOCK.SK, you could join the Discord server below to get more information on how to join. You can also contact me, Abwasserrohr, the sewage pipe on GitHub or directly here in the comments. However you want to contact me, I'm looking forward to meet you. :3
Discord: https://discord.gg/FRuK5BC
Thank you for reading my contribution post about the new features of SKYBLOCK.SK. I hope that these code snippet images make it easier to read through it. Instead of making gifs, I again decided to make a video, because it is easier to see what has been done with the new changes.
Create these new robots was quite fun for me. Even though I had to recreate some parts multiple times and find a good working process, I'm happy that it now works as expected and is also stable. Learning and getting used to the nms classes is a nice opportunity for me to customize the game furthermore. Also to give the server operators who use SKYBLOCK.SK the tools to not have to buy proprietary robot add-ons for the game is a nice achievement in my opinion.
Have you feedback regarding this contribution post, SKYBLOCK.SK or something else? Feel free to tell me your feedback. If you have any suggestions regarding SKYBLOCK.SK, bugs or something else you want to share with me, you can do that too, of course. =)
Have a great week and keep on steeming
