^
Login

or


Development Notes

You are viewing an older version of this article from 2019-10-20
Go to current version

1. Introduction



Over the years of developing Xu-Fu's Pet Guide, many ideas and suggestions accumulated. I have tried a few different tools like Trello or even Confluence to keep track of them together with my development notes, but these tools are way too clunky for this small project. And they all lack transparency.
This section aims to solve both problems: all my notes in one place, and making them visible to you, the hopefully curious reader!




2. Current Project:


Move to new Blizzard API before Dec 20th

Areas to go through:
Collection Viewer
Pet collection import for database (first import. update, char import and bnet import)
bnet import of character data - signup and manual addition (maybe)
cronjobs for class and race import
oauth (pending response from blizzard)
anywhere else?


Rollout
Keyword API2

Look for in:
collection_viewer.php
data/blizzard_api_beta.php




3. Backlog:



Cleanup tasks:
- notifications on comments for news writer?
- category filtering, buttons showing the color coding somewhere
- Make sure error messages via growl are working when dead links redirect to Home. Currently broken
- go through all old news entries and sort them into the categories, small/main and fix formatting

Currently working on:


- BUG PRIO 1: Translation tool for fight names currently overwrites work of others => Version history + warning if changes were made
- TASK PRIO 2: internal notes - notification for curators ("admin (2)" ) - how? where?
- TASK PRIO 3: Detail Strat check stopped at ID 244
- TASK PRIO 1: Move PHP to Version 7 before March 2020
- TASK PRIO 3: Make comments of all languages visible in strategies

Open tasks:
- TASK PRIO 3: battle tag in user profiles needs EU / US switch
- TASK PRIO 3: translation for "swap to your Family x"
- TASK PRIO 3: Admin button to reset rating/favourites on a strategy - suggested by Remte
- TASK PRIO 3: For Family Battler (BfA) - Add the names of the trainers as tooltips to the menu
- TASK PRIO 3: review alternatives sorting, Tags are higher rated than Ratings - swap it around?
- TASK PRIO 3: When a strategy is unpublished, will the favourites be cleared? What happens to the favs in that case or when users open up the page?
- TASK PRIO 3: article editor - Bullet points break formatting
- TASK PRIO 3: article editor - expandable text blocks
- TASK PRIO 3: Tags menu has icons with descriptions. It would be nice if these icons where clickable to toggle icons on and off

- BUG PRIO 3: When the creator comment has an unclosed tag like on it, it carries over to the first strategy line - add protection against unclosed tags
- BUG PRIO 3: Level slider in attempt recording doesn't work in some cases (tested with level pet)
- BUG PRIO 3: in profiles, btag and discord can be way too long. needs a way to display it properly
- BUG PRIO 3: article editor: when editing an article that is restricted to only ENglish and your own language is not english, it saves info into the localized part nevertheless and does not default to the EN version
- BUG PRIO 3: Reported by Jaguar: Alternatives tooltip sometimes shows a foreach error - for example on yula strategy
- BUG PRIO 3: Reported by Stan: Family Battler tooltips of family icons show sometimes the wrong achievement name
- BUG PRIO 3: comment preview on landing page cuts off comments with "COntinue reading" - if that hits a link at the same spot, it doesn't work, the continue reading becomes the link from the comment

- SUGGESTION By Irayna: Add XP Values to link list on left (like EU/US appearances of Menagerie). To see which fights give more XP than usual (espcially for legion world quests)
- SUGGESTION By Flatluigi: 21.03.2018: minor sort of request: for the pets that don't have a level/can't battle, take them out of the calculations for number of pets at max level/at rare quality
- SUGGESTION By Remte: I'd like to have fresh comment responses notifications cleared out when I visit them independently.
- SUGGESTION By Panseit: message system, put an icon next to the user profile icon when new messages are there.
- SUGGESTION By Irayna: When viewing other peoples collection, add a column for your own pets to compare the collections.
- SUGGESTION By Remte: A notice on the landing page when Squirt day is up on EU or US with a quick link
- SUGGESTION y Prudentius: Setting for each user to have child comments sort ASC or DESC (depending on preference)
- SUGGESTION By Remte: When substitute finder is used, the description of the fight changes pets aswell.
- SUGGESTION By Remte: Allowing non-family substitutes in non-specific fights
- SUGGESTION By Darkgroob: Longest day achievement in an article with links to the individual fights
- SUGGESTION By Unknown: tool suggestion - compare pets of users and see what duplicates could be traded between them to optimize both collections
- SUGGESTION By Grainne: A tool similar to Rufa's tables http://web.archive.org/web/20150405233814/http://signature.neflin.net/wowpets/pets.php
- SUGGESTION By Ragath: Refactor the fight selection menu and include additional info, such as XP values or "Repeatable" fight






4. Upcoming Project: Database Restructure (0%)


The database supporting Xu-Fu's different categories and menus is very old and is not set up properly. It is very difficult to create features with it, like for example the possibilty to move strategies or some of the other projects here including rematch mass export or the new ready-check tool.




5. Upcoming Project: New Ready-Check Tool (0%)


The Legion Ready Checker was one of the most popular tools on Xu-Fu. The addition of user strategies and breeds made this tool non-functional. To bring this back, a new tool showing the list of ALL pets could be created, showing how often the pet appears in each fight, broken down by breed. This could automatically cross-check with the saved collection. In a second step, a selector or sliders could be used to apply the table only on specific battling sections.




6. Upcoming Project: New Pet Tables in Articles (0%)


Every category article (like "Legion world quests") has a table on it that shows the required pets. This table is not using the new alternatives system and is therefore outdated.
This project is to create a new table that picks the best strategy for each fight in the category, based on the same criteria as the alternatives tooltip (favourite, ratings, tags..) and lists those pets. This should also include required or missing breeds. The table will most likely have a longer loading time and should therefore be hidden behind a "Load Pet Table" button that dynamically loads the table only on request.
Suggestion by Remte: tooltip showing which battles the pet appears in, make this interactable and the list of fights clickable to the respective strategy page





7. Upcoming Project: Rematch Mass Export (0%)


One of the most requested features is to mass export strategies to Rematch. Rematch can already import multiple strategies at once, but XuFu currently has no such export feature. That is mostly due to the existance of alternatives. Until user strategies and favourites, the page had no way of knowing which strategy is the best for you. This new tool will make use of those features and give you options from which section you cant to export strategies from, and if only your favourites or also the top pick for you should be exported.




8. Upcoming Project: New Dungeon Tool (0%)


Due to Teroclaw-Hatchling changes, the hardmode guides for Wailing Critters and Deadmines have been removed. Also, because of the addition of user strategies, the Celestial Tournament Planner is not working anymore. A new tool should be created that can be applied to any of the dungeons and to find the optimal strategies based on user collection for non-healing dungeons.




9. Upcoming Project: Pet Cards (0%)


Xu-Fu already has a database of all available pets with their skills, stats and additional info. This could be used to replace wowhead tooltips with built-in Xu-Fu pet tooltips that show more details about each pet, reduce loading times and give additional value to the tooltips.
Additional idea with it: Capture source of pets more clearly. Where are pets coming from? Add more tags as well that go along with it: Premium (for pets like baby winston - not in the shop but was a bought pet technically). Seasonal => Only available during specific seasonal events.






10. Possible Future Projects


- hyperlink preview texts and images
- comment-section: show more info about the threads in tooltip? maybe the top comment + 2 or 3 additional ones with [..] and a "X more messages" ?
- comment-section: for "Votes", maybe add together all votes from the thread from your comments? Otherwise a +50 subcomment might be hidden because it's not the first one
- Email notifications
- Tools: Top X pets of all strategies
- "Your profile has been viewed X times."
- Add friend (what effects?)
- user setting how many comments to display per page (currently set site wide)
- better brute force protection (pw reset)
- rework all tooltips to use tooltipster
- comment moderation features directly on page, including display of reports
- allow bnet connected accounts to unlink from bnet
- comment statistics (how many, how often per month, average upvotes etc.)
- article about fun stuff with pets, what they can do:
der stinker und eine schwarze katze spielen warner bros. nach
katzen können sich auf deinen schoß setzen
bäume trinken wasser, wenn sie nahe dran sind
der schreckliche oozling gibt dir einen kosmetischen debuff...





11. Finished Projects



11.1 Current Project: News 2.0 (finished October 18, 2019)


The news section now supports different topics and different users posting news. It shows a quick overview and is more easily searchable. Articles can be edited with the article editor for news writers and each article opens up in a separate page showing the full view + comments.

11.2 Project: Article Editor (finished April 16, 2018)


The page hosts many different articles and supports localization into 9 languages. This editor makes it easy for other users to add, edit or translate articles.
It is fully integrated into the user system, UAC, and allows on-page editing.


11.3 Project: Battletable 2.0 (finished June 02, 2018)


The battle tables were the first thing created on Xu-Fu. They are mostly static and not up to the standards of the current page.
This project was to fully re-create them, to integrate the user system, user collections and to add many more features such as breeds, coordinates, new Rematch formatting, an automated substitute finder and the option to record your attempts to make the strategy more accurate through crowd intelligence.


The substitute finder uses this logic:
no requirements => all substitutes are fine, based on skills and family
only a breed => creator pet, only show the selected breed(s). For substitutes, ignore breeds
only a stat => use the stat to determine which creator pet breed is OK. and use the stat for substitutes and their breeds
breed and stats => for the creators pet, only show the breed he activated. for substitutes, use the stat to show them or not.

11.4 Project: Dynamic Alternatives (finished July 01, 2018)


There should not be a limit to the amount of alternatives saved for any given fight. They should not have a fixed order either. The order should be dynamic and follow a logic that could include user settings, if the pets are in your collection, strategy upvotes, favourites, amount of pageviews, records of successful attempts or other factors.
The interface should use AJAX to reduce loading times and give a clear preview of the pets used.


The order in which strategies are shown is determined by 4 factors. Each factor supercedes the next. From top to bottom:

1. Favourited by user
If you set a strategy as favourite, it will be shown on top always

2. Pets missing from collection
The sorting will prioritize based on how many pets from the strategy you do not have in your saved collection:
No pets missing > one pet missing > two pets missing > three pets missing

3. Tags - optional
In the user settings, you can set the order of importance for all tags. Preferred tags move the strategy up, unfavored tags move it down in priority.

4. Rating and Favourites
Ratings and Favourites are calculated together into one single score. The calculation is:
- One favourite counts exactly the same as one 5* rating
- The stars are transformed into the numerical sequence -2, -1, 0, 1, 2
- The average is calculated and multiplied by a factor that is determined on the amount of votes+ratings:
1-10 ratings: Factor = 0.5
11-20 ratings: Factor = 0.8
20+ ratings: Factor = 1
This calculation makes sure that a single 5* vote on a strategy is not counted more important than an average of 4.8* from a large amount of voters, for example.
Likewise, a strategy that received many below average votes will be considered worse than one that received only a single 1* rating.

The first three factors only apply to registered users. If you are visiting without a user account, only factor 4 decides the sorting.

11.5 Project: User Strategies (finished August 01, 2018)


Users should be able to add and edit their own strategies. The editing options should be integrated into the Battletables without adding more pages. Most if not all options should be dynamic using AJAX to minimize page reloading.


19 Comments (EN)

Show first:


You must be logged in to vote on comments

0

You must be logged in to vote on comments

Wh15k3y_ wrote on 09/27/2020

when i try to login, no window appears. just all screen faded. how can i login now?
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 09/27/2020

There was an error on the webpage. It should be all back to normal now. Sorry for that!
You must be logged in to vote on comments

0

You must be logged in to vote on comments

Beardsly wrote on 09/07/2020

Forgive me if I missed it, Will there be a Rematch and TDbattle scripts functional during Prepatch/Shadowlands? While I see mass exporting isn't a thing, will there at least be a functional addon to put in the updated strats? Thank you for all that you do.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Shenk

wrote on 09/07/2020

there already is a version for rematch working in SL. tdscript is being worked on
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 09/07/2020

The Mass Rematch tool mentioned here is not going to happen before Shadowlands, but there is a mass rematch export already possible for each section :)
Just go to a section and hit the blue Load Pet Table button - once loaded, a rematch export button is available
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Thoizor

wrote on 06/20/2020

My collection doesn't get updated properly. Here it says I have 539 pets at max level, and 25 uncommon pets, while when checking my collection on warcraftpets website it tells me I have 555 at max level and 18 uncommon pets. Any idea why it's like this? I use the same char for updating both profiles.

EDIT: Am leveling battle pets atm, so the numbers mentioned above are no longer correct. There does remain a difference of 16 pets at max level between both sites, as well as a difference of 7 uncommon pets. (edited)
You must be logged in to vote on comments

1

You must be logged in to vote on comments

CoJo

wrote on 06/17/2020

The hyperlinks to the legion quests in the new Powerleveling widget don't work.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 06/17/2020

Working for me, which one exactly and where does it lead you to?
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Gráinne

wrote on 06/17/2020

I get

Sir Galveston https://wow-petguide.com/8361
Jarrun https://wow-petguide.com/5043

Ahhh. US vs EU.

I had the US page up when I saw those. On EU I get the right pages. (edited)
You must be logged in to vote on comments

1

You must be logged in to vote on comments

CoJo

wrote on 06/18/2020

Any link from the widget sends me to what appears to be a 404 page in German. Would also like to mention that last night, the widget's date was off as well for me. It was showing the date as the 17th when it was still the 16th here in the US. As Grainne said, it probably has problems between EU/US.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 06/18/2020

Aaah found it!
Both of these should be fixed now :) Thanks for bringing it up!
You must be logged in to vote on comments

1

You must be logged in to vote on comments

WalkingDead11

wrote on 04/04/2020

love the site and want to submit my bug report. I am not sure where to post this bug report so this post might need to be moved or removed. Here is my problem: When I am looking at a strategy on my touch screen device, in Google Chrome for Android 80.0.3987.162 and click on the alternatives. A menu comes up, but if there are too many alternatives on the menu I cannot scroll down the list. If I try to scroll down it reacts to the first touch and immediately closes the menu even if I press directly on the scroll bar. It does the same thing even if I request the desktop site version in my browser.Very annoying because I cannot see all the alternatives. Thank you. (edited)
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Aranesh

wrote on 04/04/2020

Hey! Absolutely the right place for this type of feedback :)

The sad but simple answer, though, is: There is no mobile version of the page. It was never designed to support mobile :/ I try to make tweaks here and there but lack the knowledge (and time) to make it really mobile friendly.
I'll log a bug ticket for me to look into the alternatives tab a bit more, maybe I can come up with a solution. Thanks for reporting it and sorry I don't have a better answer for you!
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Shenk

wrote on 04/04/2020

it's not like i haven't annoyed him before with it. glad i'm not the only one now ;)
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Gráinne

wrote on 04/04/2020

I'm honestly bemused by requests for mobile-friendliness in this context.

The only time these strats are useful is when you are actually at your PC. Why would people use a mobile browser when sitting at their keyboard? What's the condition I'm not seeing?
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Shenk

wrote on 04/04/2020

changing/working on your strategies and strategy curating in general
You must be logged in to vote on comments

1

You must be logged in to vote on comments

DragonsAfterDark

wrote on 04/04/2020

Some people also don't like to alt + tab if they only have one monitor. I know for me, half the time I don't remember what I was looking at when I move to a different screen. Imagine trying to do some of the strats on here, and alt-tabbing for each step.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Shenk

wrote on 04/04/2020

ok boomer
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Gráinne

wrote on 04/04/2020

I don't have to imagine; that's what I do when I'm checking a strat out. (I really should bring down my second monitor and find the adaptor and set it up again.) What I can't imagine is the awkwardness of trying to use a phone screen instead. But OK, if people do that, then they do, I guess.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Shenk

wrote on 04/04/2020

when i'm not at home during the week (which is usually the case if not for the current quarantine stuff) and not always have access to a pc or tablet i'm sometimes forced to do strategy reworking on my phone... and that really isn't pleasant at all
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Aranesh

wrote on 04/05/2020

Only thing I can say to that is: Sorry!
I'm in the very, very early stages of learning how to do mobile friendliness :/
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Blocky

wrote on 01/14/2020

Hi, are you aware of a bug that is effecting the site's Export Team feature? The error message below seems to be injecting itself into the export, also every line now includes a BR HTML tag in addition to newline markup tag.

Error messages:

This error message: "Use of undefined constant language - assumed 'language' (this will throw an Error in a future version of PHP) in /kunden/426045_85652/webseiten/Petguide/classes/ajax/bt_rmsteps.php on line 152

This error message: "Use of undefined constant language - assumed 'language' (this will throw an Error in a future version of PHP) in /kunden/426045_85652/webseiten/Petguide/classes/ajax/bt_rmsteps.php on line 179
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Aranesh

wrote on 01/15/2020

This should be fixed, thanks for the heads-up!
You must be logged in to vote on comments

3

You must be logged in to vote on comments

Blocky

wrote on 01/16/2020

Yes it is fixed, hurrah! You are amazing!
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 01/17/2020

<3
You must be logged in to vote on comments

1

You must be logged in to vote on comments

JestersTear

wrote on 12/05/2019

I don't know if something like this is possible, but a suggestion -

For the pet dungeons, instead of just spitting out the optimal strategy for each encounter based on our pet list, make a dungeon optimal strategy list all at once? What I mean is I look up, let's say, Gnomeregon, and it tells me for optimal strategies to use the same pet in 5 fights. Maybe something where it starts at the last fight and works backwards, so your best pets are used for the last fight (let's say it's fight #10), then it goes back to fight 9 and looks for an optimal strategy that doesn't use the 3 pets you'll be using in the final fight unless you have 2+ of one of them. This way you don't get to fight 8 and it says to use Ikky, but all 3 are either dead or too wounded from fights 2, 4 and 5 to be used again.
(edited)
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Aranesh

wrote on 12/05/2019

Hey JestersTear!

That's definitely planned :) It's currenty listed as "Upcoming Project: New Dungeon Tool" and what you are suggesting is *exactly* what I'm planning to do ^^
Hope I'll be through this current database rework soon so I can jump on cooler stuff like this one.
Thanks for the suggestion! If you have any other ideas, always happy to hear them
You must be logged in to vote on comments

3

You must be logged in to vote on comments

JestersTear

wrote on 12/05/2019

Thanks, your hard work is definitely appreciated!
You must be logged in to vote on comments

1

You must be logged in to vote on comments

ZoroarkRonan

wrote on 09/08/2019

i have a question. when i was looking at my strat it said OP what does that mean?
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Gráinne

wrote on 09/08/2019

OP = Original Poster, which as the poster of the strat, refers to you.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

ragath

wrote on 05/20/2019

I would suggest GitHub or GitLab for maintaining and developing this project. These 2 tools are no overkil for this "small project" as you called it in the beginning. Both offer free code versioning for private repositories, Issue Tracking and more. Personally I prefer GitLab as it has more features.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 05/21/2019

Hey ragath!
I know about both and what they do, but have never used them to work on a software product. I'm very much a novice in this field and in the creation of this page I made many mistakes that make it very hard to move it to a repository, mostly security details (hardcoded passwords yay!). The effort to make everything ready for such a move is probably quite high, and a big unknown to me. So it's part not wanting to invest the time and part not wanting people to see the code behind this page that keeps me from doing it ^^'
You must be logged in to vote on comments

1

You must be logged in to vote on comments

ragath

wrote on 05/22/2019

I'm a professional software developer and I work with GitHub everyday. So in case you are interested in learnig how to get to a "new Level" I could give you some tips. With private repositories your code is not public and not visible to others. In case of hard-coded passwords and stuff there are simple methods how to handle it, e.g. using .env files or simple array files. But I also understand that it's a bit of work to migrate this project to GitLab etc
You must be logged in to vote on comments

1

You must be logged in to vote on comments

shybobcat

wrote on 03/20/2019

I’d like to report a bug, hope this is the right place. A linked group of similar crabs, starting with Kelp Scuttler, does not have their abilities aligned. For example, if the Kelp Scuttler is listed with the skills 1 1 2, when you scroll through the rest of the group, they are all listed as skills 2 2 2, while they should be the same as the first one. You can see it in this strategy:

https://www.wow-petguide.com/index.php?Strategy=1352

Would also like to add that this site is amazing! I’m very impressed with both how it looks and especially how well done the coding behind it! Thank you!
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Remte

wrote on 03/20/2019

Thank you for your kind words :)
I reuploaded the pet and told our master tinkerer, and it seems it's okay now. Hopefully it was not a signal of something more severe ^^
You must be logged in to vote on comments

1

You must be logged in to vote on comments

shybobcat

wrote on 03/21/2019

Thank you for a quick fix! It works fine now :)
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Ekire

wrote on 12/28/2018

Wondering - now that they changed the way pet battles work, would it be doable to add the pet trainer names in brackets beside the quest name? Not everyone knows the WQ name if it isnt up, but the trainer name is easy to reference.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Ekire

wrote on 12/30/2018

Meaning stuff like Family Battler - IE: Zuldazar quest for "Small Beginnings" - Show it as either "Zujai - Small Beginnings", or "Small Beginnings (Zujai)"
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Remte

wrote on 12/06/2018

Not too soon: To avoid duplicates, any achievement-specific (Plushie, Family and as it was suggested The Longest Day) strategy could be automatically linked in the "global" encounter list (still redirecting to family section after clicking). To prevent clutter, they could be displayed only via user input to show more.
If this is not worth it, just expand the duplicate warning to all sections of the page… though it could be problem when someone decides to apply a strat the other way i.e. from globals to specific ones :P