[idea] Readme format...

Discussion in '3DS - Homebrew Development and Emulators' started by spinal_cord, Nov 3, 2015.

  1. spinal_cord
    OP

    spinal_cord Knows his stuff

    Member
    3,022
    598
    Jul 21, 2007
    somewhere
    As the 3DS homebrew scene is still very young. Before the homebrew library becomes too large, or devs start vanishing. How about a readme format that would be readable by hbl and other launchers, similar to the e-manuals in official games. Nothing too flashy, just a simple xml file with plain text and images.

    Who agrees?
     
    Michu and VinsCool like this.
  2. olshrimpeyes

    olshrimpeyes Your question is bad and you should feel bad

    Member
    454
    284
    Jul 30, 2015
    United States
    GNU/Somewhere
    I think it could be good idea.
     
  3. spinal_cord
    OP

    spinal_cord Knows his stuff

    Member
    3,022
    598
    Jul 21, 2007
    somewhere
    Something really simple though, something like --

    Code:
    <readme>
        <title>ReadMe</title>
        <text>
            Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. 
        </text>
        <image src="images/image1.png" width=100 height=80 />
        <image src="images/image2.png" width=100 height=80 />
        <text>
            Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. 
        </text>
    </readme>
    
     
  4. jonthedit

    jonthedit GBAtemp Advanced Maniac

    Member
    1,691
    438
    May 30, 2011
    Bangladesh
    You posted that just to spread Lorem ipsum :P

    Honestly I think having a readme-popup is pointless. One of the most annoying things on the Wii for homebrew was having to hit 'load' twice on the homebrew of choice. No point to read about it everytime you want to launch it- just read the info on the download page/development log/blog page ONCE and be done with it.

    Unless what you had in mind was that it only appears on new apps, then after an app has been used it goes away... but in that case why bother implementing it in the first place?
     
    Last edited by jonthedit, Nov 3, 2015
    Garcia98 and DarkFlare69 like this.
  5. Xenosaiga

    Xenosaiga That one guy that doesn't give a shit anymore

    Member
    1,478
    838
    Oct 9, 2015
    United States
    The Shadows
    Are you talking about how the home menu does it where you can click Manual to read about the game or Launch where it launches the game?
     
  6. keanutah

    keanutah GBAtemp Regular

    Member
    173
    130
    Sep 18, 2015
    United States
    Maybe we could have a little information section in the SMDH that could be optionally displayed?
     
  7. VideahGams

    VideahGams Advanced Member

    Newcomer
    91
    75
    Aug 29, 2015
    Glasgow, Scotland
    I would recommend using something that's more readable on its own such as Markdown
     
  8. spinal_cord
    OP

    spinal_cord Knows his stuff

    Member
    3,022
    598
    Jul 21, 2007
    somewhere
    Oh hell no. I hate that 'feature' of hbc. I don't like the idea of clogging up the screen, especially when a lot of people have no intention of reading the stuff.

    Correct, a popup would be horrible. The idea would be similar to that of official apps. One button would launch the app (A) usually, but a second button would display the manual.

    Yes.
     
  9. Robfozz

    Robfozz GBAtemp Smartass

    Member
    628
    409
    Apr 19, 2014
    United States
    Onett
    Well, you could always include a little blurb or an e-manual in your own program. I don't really see the need to force it into the Homebrew loader.
     
  10. spinal_cord
    OP

    spinal_cord Knows his stuff

    Member
    3,022
    598
    Jul 21, 2007
    somewhere
    Sure, but I was thinking the idea would remove extra coding and standardize the practice for future projects. A good idea for that sort of thing, don't you think?
     
  11. ElyosOfTheAbyss

    ElyosOfTheAbyss GBAtemp Addict

    Member
    2,214
    1,720
    Aug 20, 2015
    I actually liked that feature of the Wii HBC because I would occasionally move my hand when pressing A then another app shows up.
     
  12. erman1337

    erman1337 GBAtemp Maniac

    Member
    1,211
    931
    Sep 27, 2015
    Belgium
    Brussels
    nice idea
     
  13. Gryphon93

    Gryphon93 GBAtemp Regular

    Member
    145
    14
    Nov 30, 2008
    I agree. Markdown is extremely easy to read and fast to type. XML is too cluttered in my opinion.
     
    filfat likes this.