What's new

Welcome to RetroTools.XYZ - We Make It Easier To Manage Your Habbo Retro By Yourself!

Join us now to get access to all our features. Once registered and logged in, you will be able to create topics, post replies to existing threads, give reputation to your fellow members, get your own private messenger, and so, so much more. It's also quick and totally free, so what are you waiting for?

Free Nitro Websocket Proxy

Tired of paying to avoid random disconnections and want better protection on your Habbo Retro? Please click the icon on the top right.

Answer

Answer Questions and Become an Expert on Your Topic

Contact Staff

Our Experts are Ready to Answer your Questions

Arcturus Plugins Tutorial

RetroPlug

Member
Staff member
Management Team
Joined
Nov 12, 2020
Messages
37
Reaction score
13
Points
8
Table of Contents

0: Other tutorials
1: Introduction
2: Prerequisites
3: Configuring IntelliJ
4: Installing Arcturus Emulator
5: Updating Arcturus Emulator[/B]
6: Creating a new plugin project
7: Configuring your plugin

0: Other tutorials
How to add custom commands by @
Please, Log in or Register to view URLs content!
: [Arcturus] Plugin Tutorial: How to add custom commands

1: Introduction
In this tutorial, I will give an in-depth explanation about building your own plugins for Arcturus.

2: Prerequisites
The following pieces of software must have been installed:

IntelliJ IDE:
Please, Log in or Register to view URLs content!

This is the code editor you will be using. Now other editors may work but are not covered in this tutorial. Eclipse will probably work too.

Java JDK:
Please, Log in or Register to view URLs content!

Arcturus targets Java 6 however Java 8 should work fine as well.

Maven:
Please, Log in or Register to view URLs content!

Download the binaries and extract them.

3: Configuring IntelliJ
Start IntelliJ

1605953066634.png

Choose Configure -> Plugins

1605953077991.png

Choose 'Browse repositories...'

1605953085182.png

Install the following plugins:
  • Git Integration
  • CVS Integration
  • Bitbucket
  • Maven Integration

Save close and let the IDE restart.

Choose Configure -> Settings
Choose Build, Execution, Deployment -> Build Tools -> Maven

1605953111088.png

For Maven home direction navigate to the folder where you extracted your Maven binaries.
Tick the override option.

Choose Build, Execution, Deployment -> Build Tools -> Maven -> Importing
Tick Import Maven projects automatically
Save and close.

4: Installing Arcturus Emulator
To install Arcturus you have to use maven to install the jar to your local maven repository (.m2).

Use this command to install the jar:

Code:
Please, Log in or Register to view codes content!

Change the path-to-file to the Habbo-1.13.0.jar path.
Note that the version may vary, depending on when you've downloaded Arcturus. At the moment of writing Arcturus version is 1.13.0.

5: Updating Arcturus Emulator
When changes to the Emulator are made you have to make sure they work properly with your plugins. Therefore you have to install the new updates to Maven.

All you have to do is execute Step 5 again for the different version and update your pom accordingly.

6: Creating a new plugin project

Click on 'Create new project'

1605953206641.png

Select Maven and click next


Group Id: Enter your domain, in reverse order. For example, sulake.com becomes com.sulake.
Artifact: This is your plugin name, preferably in lowercase.
Version: The version of your plugin, the first version is 1

And click next

1605953382513.png

Enter your project name. This can be anything and doesn't have to be lowercase.
Preferably modify the location where the project is created. This is up to you.

Click on Finish.

1605953404696.png


7: Configuring your plugin

At the top right you will see this message, click on 'Enable Auto-Import'. Don't worry if you don't see it.

View attachment 27

Open your pom.xml file, if you haven't already.

Add to your pom.xml file within the <project></project> scope:

Code:
Please, Log in or Register to view codes content!

Change <version> accordingly to the version you have taken from the bitbucket repository. If you want to update to a new version you have to follow 5: Updating Arcturus Emulator.

In the file explorer, right-click the resources folder and go to New -> File

1605954024143.png

And name it plugin.json and click OK

1605954042178.png

Right click the java folder in /src/main/java and go to New -> Package

1605954060602.png


And enter your groupId and artifactId in there and click OK.

1605954077013.png


At the top right click the cog and untick 'Compact Empty Middle Packages'

1605954093323.png

Right-click your plugin package and go to New -> Java Class

1605954109076.png

Enter the name of your plugin and click OK

1605954124226.png

Make the class extend HabboPlugin and Implement the methods. (Alt+Enter)

The method onEnable(void) : void will be called when your plugin gets loaded enabled. This is can be used as your entry point however it is suggested to use the default constructor if you want to add new furniture interactions in time.

The method onDisable(void) : void will be called when your plugin gets unloaded. This is the point where have to make sure everything you may want to save to the database is being saved.

The method hasPermission(Habbo habbo, String s) : boolean is called to see if a user is allowed to use specific permission.

Open your plugin.json file in the resources folder and add and modify the following lines:

Code:
Please, Log in or Register to view codes content!

For example:

Code:
Please, Log in or Register to view codes content!

Go to Maven -> Your artifact name -> lifecycle -> package.

A .jar file will be created, located in your target folder. Put this .jar file in the plugins folder of the emulator and restart your emulator. Your plugin should be loaded!

Congratulations, you've created your own plugin for Arcturus emulator. Now it's up to you to explore all the possibilities.

Check out these plugins for examples and inspiration:

Plugin Example: https://bitbucket.org/Wesley12312/pluginexample
Kickwars:
Please, Log in or Register to view URLs content!
 

Attachments

  • 1605953228449.png
    1605953228449.png
    65 KB · Views: 108
  • 1605953264774.png
    1605953264774.png
    70.9 KB · Views: 106
Last edited:
shape1
shape2
shape3
shape4
shape7
shape8
Top