^
Login

or


Development Notes

You are viewing an older version of this article from 2018-06-12
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!

You will find this article changing constantly. If a feature or bug suddenly vanishes from this list, it usually means that it weng live :-)

2. Clean-up Tasks


- Detail Strat check stopped at ID 26
- Check script for account deletion on strategies. Does it work properly?
- update pet collection import to use PetUser instead of Pets table
- remove rematch functionality from celestial tournament
- remove create_rematch function, make sure it's not used anywhere else anymore
- 1590 strategy - problem with tooltip of the pets


3. Bugs


- Wailing Critters => Pet table when not logged in shows different pets than when logged in. Why!?
- PO file on Home.php => title for "Article creators" is hardcoded
- message when comment reaches gold status working or not?
- gold comment trigger will trigger email in the language of that person who made the deciding upvote. Not the person who made the comment. com_vote in ajax
- in profiles, btag and discord can be way too long. needs a way to display it properly
- comment previews on landing page show an incorrect time (yesterdays comments are shown as today)





4. Project: Clever Alternatives (10%)


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.


4.1 Logic behind the priority system.



The order in which strategies are shown will be set 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. The higher the tag is, the more points it awards and decides on the sorting within this factor

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 on the sorting.




5. Project: User Strategies (5%)


Users should be able to create and add their own strategies.
Todos: Once pet selection is active via AJAX, add function that checks on the Tags and updates the auto-tags directly. Then remove tag-checker from battletable.php as it's not needed there anymore.

6. Open Tasks:


- Editing option for comments
- Editing options for the individual pets
- editing options for strategy steps
- "My Strategies" page for strat creators. show # visits, comments, votes and favs of own strategies.
- Info section explaining how everything works




7. Project: Pet Cards (0%)


Xu-Fu already has a database of all available pets with their skills, stats and info. This could be used to replace wowhead tooltips with built-in Xu-Fu pet tooltips that show more details about each pet.




8. Project: Blog 2.0 (0%)


The blog should support different topics and different users posting updates. The blog should be sortable by topic / date. It should show a quick overview and should be searchable. There should be the option to go to a single blog post and view that in full screen.




9. Miscellaneous Tasks, Bugs and Suggestions



9.1 Suggestions


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)
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
By Remte: I'd like to have fresh comment responses notifications cleared out when I visit them independently.
By Panseit: message system, put an icon next to the user profile icon when new messages are there.
By Irayna: When viewing other peoples collection, add a column for your own pets to compare the collections.
By Remte: A notice on the landing page when Squirt day is up on EU or US with a quick link
By Prudentius: Setting for each user to have child comments sort ASC or DESC (depending on preference)
By Remte: When substitute finder is used, the description of the fight changes pets aswell.
By Remte: Allowing non-family substitutes in non-specific fights

9.2 Tasks and To-Dos


- add protocol entries to admin pages
- Petimport - adm_petimport.php:
- check at beginning if user pets are not verified with "cageable or not" and go through them.
- user pets: option to set cageable or not
- Spells: entire API import missing
- battle tag in user profiles needs EU / US switch
- my comments section sometimes does not filter the comments correctly
- option to claim old comments
- crawl of pet collection: if a character is saved, use that one. If that saved char is not available anymore, crawl all characters from bnet again and pick most recently active one and save that one.




10. Possible Future Projects


- SEO
- 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?)
- specific user icons and backgrounds for admins / mods /translators
- sticky comments
- 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.)
- Flavour growls:
"your collection was updated and you got these new pets in the last week!"
after X days of registration, still no password / battle.net connected - send reminder message "hey do this for x"




11. Finished Projects



11.1 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.2 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.






12 Comments (EN)

Show first:


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

1

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

1

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
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Seira

wrote on 10/16/2018

I love the "Incl. Steps" toggle. if somehow "Incl. TD Script" would be possible, my life would be almost complete :)
You must be logged in to vote on comments

1

You must be logged in to vote on comments

gsanta

wrote on 10/20/2018

I was flipping this back and forth to see what changed and didn't notice anything. What does the Incl. Steps toggle do?
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Seira

wrote on 10/21/2018

On the website, you can see the steps it takes to defeat the tamer. If you flip this before importing the Team into the game, you will see these steps in pet battle (in a note)
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Amber1019

wrote on 10/13/2018

Implementing a mention feature like I've seen you talk about sounds fantastic.
Another thing I've thought would be great would be adding a "date posted" and/or "date updated" to strategy pages. That way if/when Blizzard nerfs and makes changes to battle pets again, we'll be able to see when the strategy was posted, and whether or not it's been updated since the changes Blizzard made, so we know to alert others in the comments about it or to just look into finding a more recent strategy.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

NIteowl1970

wrote on 09/26/2018

Just found this page of upcoming projects. A lot of great stuff there. Just a couple requests.Under #10, you asked "Add a friend (what effects)" I would love to be able to add a friend and compare our pets, to see which ones they have that I still need. Also I would love a category on the pet lists that tells me how rare my pets are compared to the rest of the wow population, something like "Pet name = Ikky: Owned by 25% of other players"
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Nebs

wrote on 09/22/2018

Hey! Long time user here, love love love your work :)
Have seen few suggestions similar to mine, relating high XP battles leveling pet fights.
I was thinking of a list of fights for Pet battle week (bonus event) when you get that lovely +200% XP, focusing to those battles that give high XP.
So my idea was to have a list categorized by areas, where you can find those battles that give high XP, so most beneficial to do on the bonus week. It could be a pet leveling strat at the same time even on the weeks where the bonus XP isn't on.
You must be logged in to vote on comments

0

You must be logged in to vote on comments

Pike wrote on 08/25/2018

I love the site and have used it religiously for several years, thanks for all your hard work.

If I could give one little bit of feedback. I copy the turn instructions and paste them into the Rematch notes for each saved team. Previously the copied notes would paste with each turn on one line (with the turn number and description separated by whitespace). However, sometime between mid-Legion and today the page structure has changed so that copy and paste now loses the formatting and each cell is on its own line (so the turn number is on its own line then the description on the next line and so on).

I'd love to see the old table structure return (maybe just for the popout?) although tbh its not a major problem to manually fix the notes after pasting.

Thanks again for the site.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 09/10/2018

Hey Pike! I'm aware of this and one of the next things I'll work on is to include the strategy steps into rematch notes directly, so you won't have to do 2 copy pastes anymore, and this formatting issue will be gone at the same time :-)
You must be logged in to vote on comments

0

You must be logged in to vote on comments

Pike wrote on 09/22/2018

Just saw the steps copy feature, amazing work, thanks Aranesh!
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Cole#13497

wrote on 07/27/2018

Not sure where to put suggestions but here's mine.

Allow users to link pets when typing comments so you could use your links you want for wowhead on your own site as well. Also the links would allow you to say prevent people from link beast pets on the Aquatic Assault page etc. Additionally, it could eventually even help you import strategies from comments.
You must be logged in to vote on comments

2

You must be logged in to vote on comments

Aranesh

wrote on 07/28/2018

Hey :) Thanks a lot for the suggestion. That is planned as part of the "Pet Cards" project. At the same time I will most likely add a "mention" feature, like on many other platforms, where you put an @ and start typing a username and can then select a name to be mentioned and they get a ping about it.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Cole#13497

wrote on 07/30/2018

Sounds perfect!
You must be logged in to vote on comments

1

You must be logged in to vote on comments

gsanta

wrote on 05/11/2018

Aranesh,

Just wondering how Battletable 2.0 is coming along. Looking forward to the new features and hadn't seen any noticeable updates on this Development Notes page lately. Thanks for all the team's great work on the site. I love it.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

Aranesh

wrote on 05/15/2018

Hey :)
There are smaller changes here and there. I did put it to 70% completed recently because the main parts are done, and I think that's a fair estimate :D There's only some minor additions missing like a system for tags, or the coordinates of tamers. I'm getting there! Outside of weekends I barely find the time to work on it nowadays, unfortunately. But I think at least this part will be ready well before BfA comes out.
You must be logged in to vote on comments

1

You must be logged in to vote on comments

gsanta

wrote on 05/15/2018

Great to hear. Thanks for the update. Shortly after I posted this you posted a new blog entry with the updates, but thanks for the reply.