1. The forums will be archived and moved to a read only mode in about 2 weeks (mid march).

Announcement Clean up our consoles!

Discussion in 'General discussion' started by SOFe, Apr 26, 2018.

  1. SOFe

    SOFe Administrator Staff Member PMMP Team Poggit Admin

    Messages:
    1,968
    GitHub:
    sof3
    Bitlink to this thread: https://bit.ly/pmcolors

    Last night on Poggit, I rejected 9 plugins with the following message:
    What's wrong?
    [​IMG]
    (image contributed by @TheDeibo)

    TeaSpoon generates an enormous ASCII text. PureEntitiesX writes a GOLD message about something users don't care about most of the time, then writes a debug message in AQUA. AdvancedJoin uses a mix of AQUA and GOLD to try to attract users' attention as if they wouldn't know they have installed the plugin otherwise.

    These messages hurt users' eyes seriously. And worse, the user won't be alerted when an important error/warning message shows up.

    Why not?
    If you look at the server startup logs carefully, you will notice that PocketMine already logs a message about your plugin:
    You really don't need to write this message from your plugin again.

    OK, so you really want to tell the user that your plugin is not only enabling but also already enabled. But you don't need to make fancy messages with rainbow colors and 12 lines of ASCII text, do you?

    Maybe you think your plugin is great; it finally has no syntax errors, it finally doesn't crash, it finally enables. You want to tell the whole world about your greatness. But wait... every other plugin on the server did the same. Now plugins are going on a loudness war. In the beginning, some plugins wanted to make an extra message to stress that it was loaded. Some others thought it was not significant enough, so they started making colors. Then some thought everyone was using colors and they couldn't stand out, so they used ASCII text. One day we will wake up to see plugins calling your phone to tell you that the plugin is loaded.

    What can I do?
    Of course, colors are there for a reason. But they are not to be abused. Please let the important messages stand out.

    If a user types a command, you can decorate the response with colors, because the user asked for it. You can tolerate Microsoft Word showing its famous startup window when you open a document and you are waiting for it to startup, but you won't accept every program you installed opening a popup when you turn on your computer. (Now I finally understand why Android requires apps to explicitly declare permission to get notified when the phone starts)

    If you just want to highlight particular words in a sentence, it is OK too. Colors are great for highlighting particular words to make messages easier to read. But don't highlight the whole message, else it's equivalent to not highlighting anything.

    If it is an important message, of course, you can color it too. This is what colors are supposed to do. I wrote this thread mainly to allow these messages to stand out.

    If you can't decide whether a message is important, think from the user's perspective. Does the user really care about it? Maybe you really want the user to care, but the user will just ignore you.

    What if I really want to use colors/ASCII text?
    Let me quote a suggestion from @Thunder33345:
    This is really a great suggestion. You are probably the only person in this world who wants to see that message. If you really think others would like it, let users enable it in the config.

    P.S. Throughout writing this thread, I had a hard time determining which lines I should bold, which words I should italic and whether I should underline or colorize anything. It is the hardest skill to teach in software engineering!
     
    Last edited: May 13, 2018
  2. MalakasPlayzMCPE

    MalakasPlayzMCPE Zombie Pigman

    Messages:
    667
    You are not wrong, but it is just a console spam on startup, only on startup. This won't prevent someone from finding an important error or something. However, if a server owner can't find what he is searching for, he can simply press the magic buttons (CTRL+F). I do not disagree with that because they violated the rules of poggit but anyways, all these is my opinion only.
     
  3. Daniktheboss

    Daniktheboss Baby Zombie

    Messages:
    144
    GitHub:
    daniktheboss
    Oh i love when developers think having a huge ASCII makes their plugin cool
     
  4. EdwardHamHam

    EdwardHamHam Skeleton

    Messages:
    962
    GitHub:
    edwardhamham
    :facepalm: Some of the most important errors or messages may come at startup....
     
  5. MalakasPlayzMCPE

    MalakasPlayzMCPE Zombie Pigman

    Messages:
    667
    Magic buttons
     
  6. Daniktheboss

    Daniktheboss Baby Zombie

    Messages:
    144
    GitHub:
    daniktheboss
    Please stop spamming irrelevant stuff on the threads
     
  7. MalakasPlayzMCPE

    MalakasPlayzMCPE Zombie Pigman

    Messages:
    667
    Read my previous post.
     
    Last edited: Apr 26, 2018
  8. EdwardHamHam

    EdwardHamHam Skeleton

    Messages:
    962
    GitHub:
    edwardhamham
    How would the user know what there searching for if they don't see the error message in the first place to know that there's a problem. Besides, not everyone knows that shortcut. (and I can't remember if it works in the terminal, console, or powershell)
     
    Thunder33345, yuko fuyutsuki and SOFe like this.
  9. Muqsit

    Muqsit Chicken

    Messages:
    1,548
    GitHub:
    muqsit
  10. SOFe

    SOFe Administrator Staff Member PMMP Team Poggit Admin

    Messages:
    1,968
    GitHub:
    sof3
    yuko fuyutsuki and Muqsit like this.
  11. SOFe

    SOFe Administrator Staff Member PMMP Team Poggit Admin

    Messages:
    1,968
    GitHub:
    sof3
    But they don't even know there existed an error. The error is there to alert the user, not to stay and get searched.
    Well, if the user doesn't read the messages anyway... then why would they care about your cool ASCII texts?
    Or, to make real errors and warnings stand out, we have to make ASCII text out of ASCII text? omg
     
    Thunder33345 and EdwardHamHam like this.
  12. MalakasPlayzMCPE

    MalakasPlayzMCPE Zombie Pigman

    Messages:
    667
    Well, you can just search for dark red color or search ERROR
     
    Saiini14 TV likes this.
  13. EdwardHamHam

    EdwardHamHam Skeleton

    Messages:
    962
    GitHub:
    edwardhamham
     
  14. SOFe

    SOFe Administrator Staff Member PMMP Team Poggit Admin

    Messages:
    1,968
    GitHub:
    sof3
    This is exactly the point. Plugins are corrupting the console with irrelevant red messages.
     
  15. dktapps

    dktapps Administrator Staff Member PMMP Team

    Messages:
    774
    GitHub:
    dktapps
    on a semi-related note, it is intended to change plugin load/enable messages generated by PM itself to debug level instead of info. This won't affect messages generated manually by plugins though.
     
    SalmonDE likes this.
  16. Thunder33345

    Thunder33345 Moderator Staff Member

    Messages:
    2,137
    GitHub:
    Thunder33345
    re sofe, what if i log onenable and ondisable under DEBUG is it acceptable? @SOFe i think it would be since normally these are hidden and debug means it's for dev
    my personal razor is simple: `dont show it if user dosent need to take action against it`
    under that message like "[OK] Connection to MYSQL established" would be cut away, since no user action is needed,
    but "[ERROR] Connection to MYSQL failed error: server offline" would not be cut away since it prompts user's action or attention to fix a probable issue
     
    dktapps likes this.
  17. SOFe

    SOFe Administrator Staff Member PMMP Team Poggit Admin

    Messages:
    1,968
    GitHub:
    sof3
    I don't think anyone minds seeing spam in debug mode. They asked for it, after all.
     
    Daniktheboss and Thunder33345 like this.
  18. xZeroMCPE

    xZeroMCPE Witch

    Messages:
    67
    GitHub:
    xZeroMCPE
    who install plugins?

    The user, of course. If the user chooses to install a plugin that does x. Whatever it does, blame the user. We can't block nor deny any plugins that choose to use colorful things
    Code:
    onEnable(){}
    . I do understand the fact that plugins misuse things that shouldn't be used. I mostly agree with SOFe. But again, my counter-arguments is simple as; we shouldn't care. A [server software] should get deployed as if. Whatever the user chooses to install, for example, [a plugin] shouldn't be an issue for us, but one for them. Yes, xx misuse color xx on
    Code:
    onEnable(){}
    (or wherever) but how does that affect you? If it's your server, just simply [uninstall] that plugin. That's like blocking a plugin that communicates with maybe a fork of PMMP?

    Developers these days like to BOOM their users, they want to let their users know that their plugin is enabled (even though PMMP does that), they want to stand out from maybe other plugin messages. They want all eyes on them. But, that shouldn't be a reason Poggit deny their plugin entry. That is plain vacuous. Instead, you can just apply a tag to those plugins and maybe separate them. But denying them? no no. You're killing what's left on the of such fraternity.

    In conclusion,

    That's my argument, you may/not agree with it. I wouldn't care. Everyone has their own point of view to everything. What's yours?
     
  19. Tee7even

    Tee7even Slime

    Messages:
    81
    GitHub:
    tee7even
    And then what? Write one yourself? For most users it's not the option, and even if it is, it takes time. For example, there's effectively only one option for permission management right now and that is PurePerms. The situation is similar with most of the plugins. Competition is almost nonexistent. You can't "just uninstall the plugin".
    No, blame Shoghi that's absurd, the user practically doesn't have a choice, how come they're the one to blame?

    I would agree that it should be more like "SHOULD NOT" rather than "MUST NOT", but blaming the users? Lol.
     
  20. SOFe

    SOFe Administrator Staff Member PMMP Team Poggit Admin

    Messages:
    1,968
    GitHub:
    sof3
    Plugins released on Poggit are only some fraction of the plugin ecosystem. I am doing this (rejecting plugins and writing this thread) not only to explain what I did on Poggit, but also to promote the campaign to eliminate the abuse of startup messages in the whole plugin ecosystem.
     
  1. This site uses cookies to help personalise content, tailor your experience and to keep you logged in if you register.
    By continuing to use this site, you are consenting to our use of cookies.