Homebrew [idea] Readme format...

[spinal_cord]

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?

 

[olshrimpeyes]

I think it could be good idea.

 

[spinal_cord]

Something really simple though, something like --

<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>

 

[jonthedit]

Something really simple though, something like --

<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>

You posted that just to spread Lorem ipsum

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?

 

[Xenosaiga]

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?

 

[keanutah]

Maybe we could have a little information section in the SMDH that could be optionally displayed?

 

[VideahGams]

Something really simple though, something like --

<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>

I would recommend using something that's more readable on its own such as Markdown

 

[spinal_cord]

Maybe we could have a little information section in the SMDH that could be optionally displayed?

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.

You posted that just to spread Lorem ipsum

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?

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.

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?

Yes.

 

[Deleted User]

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.

 

[spinal_cord]

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.

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?

 

[ElyosOfTheAbyss]

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.

I actually liked that feature of the Wii HBC because I would occasionally move my hand when pressing A then another app shows up.

 

[erman1337]

nice idea

 

[Gryphon93]

I would recommend using something that's more readable on its own such as Markdown

I agree. Markdown is extremely easy to read and fast to type. XML is too cluttered in my opinion.