Home - Sylphian-Network/Sylphian-UserPets GitHub Wiki

Welcome to the Sylphian-UserPets wiki!

Getting started

Step 1: Installing the required files

First of all we need to check out the latest releases. Here we're going to want to install the Sylphian-UserPets-{version}.zip as well as the sylphian_spritesheet.png.

Both of which are essential to getting started.

Step 2: Installing the add-on

If you haven't done this before I'd highly suggest reading through this section of the Xenforo Manual as it will explain how add-ons should be installed.

Step 3: Adding the spritesheet

The add-on should now be installed correctly. You can check it's working by doing two things straight away. In a users Account details under Preferences you should see the options Sprite Sheet & Custom pet name. In your admin control panel under Content you should see Spritesheet management.

If neither of these things occurred, the add-on has not been installed correctly.

Click on Spritesheet management by default you will have no spritesheets available to you. On the top right of your Spritesheet Management area click the button Add spritesheet.

Here we need to fill in each section.

Field	Description	Value
Image	Upload the spritesheet without manually placing files on the server	Drag & drop sylphian_spritesheet.png
Filename	Name of the file on your system	sylphian_spritesheet.png
Title	Name displayed in Account Details → Preferences	Sylph
Frame width × height (px)	Size of each animation frame	192 × 192
Frames per animation (columns)	Number of frames in each hard-coded animation (Idle, Feed, Play, Sleep)	4
Frames per second	Animation speed	4

Click save and you should see your sprite appear like this, cycling through each animation.

Step 4: Editing the options

Under Setup -> Options -> User pets you will find a lot of options for you to edit.

The ones we want to focus on right now are Default Spritesheet, Enable tutorial, and Enable Dueling

Option Name	Description
Default Spritesheet	Select the default spritesheet that new users will have for their pets. This sets the starting appearance for all newly registered users who haven’t chosen a custom spritesheet yet.
Enable Tutorial	Enables the tutorial system. When enabled, users will get a set of predefined steps to work through, encouraging them to fill in their profile. Once completed, rewards will be given.
Enable Dueling	Enables pet dueling between users. When turned on, pets can engage in battles, leveling up or earning rewards based on duel outcomes.

Step 5: Adding the widget

The widget is where the userpets will appear.

To add this widget go into your admin control panel -> Appearance -> Widgetsand click the buttonAdd widget. Open the drop down and choose User PetthenAdd widget` to save.

For the Widget key set this to whatever you want to and for the Title this will not affect the widget in any way.

The recommend option for the Display in positions is Member view: Sidebar as this will let users visit each others pets and see their levels, sprites uses and custom names.

Display condition again does not matter unless you'd prefer to be creative.