Difference between revisions of "HomeMenu"

From WiiBrew
Jump to navigation Jump to search
m
 
(42 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Infobox homebrewapp
+
{{Infobox development tools
| title      = [[HomeMenu]] [[Image:HomeMenu-screenshot.png|center|thumb|180px]]
+
| title      = [[HomeMenu]]
| desc       = A standalone Home Menu library
+
| image      = [[File:HomeMenu-screenshot.png|180px]]
| type        = Library
+
| type       = library
 
| license    = None yet
 
| license    = None yet
 
| author      = [[User:MetaFight|MetaFight]]
 
| author      = [[User:MetaFight|MetaFight]]
| version    = SVN
+
| version    = None yet
| download    = [[Media:HomeMenuPreview.rar|Preview]]
+
| example    = Media:HomeMenuPreview.rar
| source      = [http://code.google.com/p/libhomemenu/ Google Code]
+
| source      = http://code.google.com/p/libhomemenu
 
}}
 
}}
  
This is just a preview of my HomeMenu library I'll be releasing soon (it is now in C).  It's graphics library independent, so there aren't too many hassles there.  It also allows you to associate your own functions to events such as when the menu opens, closes, redraws.
+
[[HomeMenu]] is a library written in C which provides a Big-N style Home Menu.  It aims to be graphics-library-independent so it can be used regardless of your application's underlying graphics code/library.  It also allows you to associate your own functions to events such as when the menu opens, closes, redraws.
  
==News==
+
It's coming along well but isn't completed yet.  An up-to-date "To Do" list can be found on the [http://code.google.com/p/libhomemenu/ SVN].
'''1 April 2009''' -- I put up a quick and dirty conversion to C up on the SVN. Preliminary testing showed no bugs. I would appreciate it if somebody could point out any big NO-NOs in the code since it was converted with very little knowledge of C.
 
  
Oh, and no, this is ''not'' an April Fool's joke :)
+
== News ==
 +
{{Archive box
 +
|[[/Archive 1|Archive 1]]}}
 +
'''11 April 2009''' -- I just tested HomeMenu with a fresh extraction of the libwiisprite tarball... it wasn't pretty. I hadn't noticed just how drastic my modifications to lws were. I'll be updating [[HomeMenu]] to work with lws out of the box in a week or so. I'll also implement some more GX related tweaking options so hand rolled graphics solutions can better control [[HomeMenu]]'s behavior.
  
[[User:MetaFight|MetaFight]] 06:40, 1 April 2009 (UTC)
+
Back to coding in a week,
  
 +
[[User:MetaFight|MetaFight]] 06:20, 11 April 2009 (UTC)
  
'''30 March 2009''' -- I'll be busy for the next few weeks so I won't be able to work on HomeMenu much.  Since a few people have contacted me about getting the source I thought I'd release it early.  The source is still for the incomplete preview, but a full v1 release shouldn't be too far away.
 
  
Enjoy!
+
'''4 April 2009''' -- I'm looking for testers. I've gotten reports of odd behavior on PAL systems, so first and foremost I'm looking for PAL testers. I also need widescreen testers (both PAL and NTSC). If you're interested please leave your contact info on the [[Talk:HomeMenu#Testers|discussion]] page. I'll also put together a version of the menu that will allow you to take screenshots.
  
[[User:MetaFight|MetaFight]] 23:15, 30 March 2009 (UTC)
+
Thanks,
  
==Installation and usage==
+
[[User:MetaFight|MetaFight]] 19:01, 4 April 2009 (UTC)
===Installation===
 
Simply copy all the .c and .h files into your project (make sure the .c are accessible as ''source''s and .h accessible as ''include''s).  Then, add <code>#include "HomeMenu.h"</code> where appropriate.
 
  
===Usage===
 
Call <code>HomeMenu_Init()</code> to set things up.  Its parameters are:
 
* <code>int screenWidth</code> -- horizontal resolution of screen.
 
* <code>int screenHeight</code> -- vertical resolution of screen.
 
* <code>void* framebuffer0</code> -- pointer to the first framebuffer.
 
* <code>void* framebuffer1</code> -- pointer to the second framebuffer (Currently assumes double-buffering).
 
* <code>u8 framebufferIndex</code> -- index to last buffer drawn to [0, 1].
 
  
When you want to display the menu (when the user presses HOME), simply call <code>HomeMenu_Show()</code>.
+
''(For older news please refer to the archives.)''
  
Tip:  If you have a callback setup for when the user holds down on the wiimote's powerbutton, add <code>HomeMenu_Hide()</code> to this callback to tell HomeMenu to relinquish execution control.
+
== Installation and usage ==
 +
See [[HomeMenu|/HomeMenu/]][[/Installation and usage|Installation and usage]].
  
====Libwiisprite users====
+
== Statistics ==
Currently, the pointers to the framebuffers and the framebuffer index are stored in the <code>GameWindow</code> object as <code>private</code> members.  [[Shiny Red Tank]] got around this problem by adding accessors to the <code>GameWindow</code> class.  Hopefully, if there is enough demand, the accessors will be included in the next version of LWS (go ask!).
+
I'd like to have a general idea of how many apps use this library (once released, or even off the svn). If you use it, could you please add <code><nowiki>[[</nowiki>[[:Category:Homebrew using HomeMenu]]<nowiki>]]</nowiki></code> to your application's wiki page? Thanks.
  
==Feedback==
+
== Feedback / Support ==
Please direct all questions and feedback to the [[Talk:HomeMenu|discussion]] page.
 
  
==Statistics==
+
Feedback would be greatly appreciated. You can find me in #wiidev and #wiidevot on EFNet, you can email me at the address listed in the game, or you can use the [[Talk:HomeMenu|discussion]] page.
I'd like to have a general idea of how many apps use this library (once released, or even off the svn).  If you use it, could you please add <code><nowiki>[[</nowiki>[[:Category:Homebrew using HomeMenu]]<nowiki>]]</nowiki></code> to your application's wiki page?  Thanks.
 
  
==Potential Issues==
+
If you'd like to contribute to the project, please contact me and we'll see what can be arranged.<br />
Currently, when the menu pops up, it takes a screenshot of whatever is on the screen and then uses GX to render everything it needs.  Since I don't know much about GX yet, I can't tell if this approach will interfere with other graphics libraries.  I know it runs fine with libwiisprite, but I'm not sure, yet, how it will fare with GRRLIB or handrolled graphics solutions.  My advice: only call the menu immediately after having drawn.
+
<!--If you'd like to contribute to the project but you're not sure in what capacity, please consider the option posted on my [[User:MetaFight#Support_/_Donations|User page]].-->
  
Similar issues will present themselves with sound.  The menu will (eventually) stop any sound playback when it is opened.  I haven't poked around ASND much yet, so I don't know if there is a way to save a channel's state and then eventually restore it.  My current advice:  make use of the callbacks (before menu is shown, after menu closes) to backup/restore your sound data manually.  Another option of for me to just pause ASND and not include sound in the menu.
+
== Release log ==
 
 
Thirdly, I haven't looked into this much yet either, but wiimote settings (resolution, mode) are set when the menu is shown.  If there is no way for me to programmatically find what the previous values are I won't be able to restore them when the menu is closed.  My advice:  use the callbacks to save/restore wiimote settings before and after showing the menu.
 
 
 
==Changelog==
 
 
'''30 March 2009'''
 
'''30 March 2009'''
* Sourcecode released (Google Code SVN).
+
* Source code released (Google Code SVN).
 
* Updated preview (Now with rumble and some sound).
 
* Updated preview (Now with rumble and some sound).
  
Line 66: Line 54:
 
* Not yet complete, but you can get the idea.
 
* Not yet complete, but you can get the idea.
  
==Thanks==
+
== Thanks ==
 
* Thanks go to the folks at [irc://irc.efnet.net/grrlib #grrlib].
 
* Thanks go to the folks at [irc://irc.efnet.net/grrlib #grrlib].
 
* Thanks go to the madness at [irc://irc.efnet.net/wiidevot #wiidevot].
 
* Thanks go to the madness at [irc://irc.efnet.net/wiidevot #wiidevot].
 
* Thanks to [[User:Dykam|Dykam]] for code snippets.
 
* Thanks to [[User:Dykam|Dykam]] for code snippets.
 
* Thanks to [[User:drmr|drmr]] for his [[Wii Homebrew Cursors]].
 
* Thanks to [[User:drmr|drmr]] for his [[Wii Homebrew Cursors]].
 +
 +
== See Also ==
 +
* [[:Category:Homebrew using HomeMenu|Homebrew using HomeMenu]]
 +
 +
[[Category:Libraries]]
 +
[[Category:HOME Button Libraries]]

Latest revision as of 16:06, 16 August 2010

HomeMenu
HomeMenu-screenshot.png
General
Author(s)MetaFight
TypeLibrary
VersionNone yet
Links
Example
Source

HomeMenu is a library written in C which provides a Big-N style Home Menu. It aims to be graphics-library-independent so it can be used regardless of your application's underlying graphics code/library. It also allows you to associate your own functions to events such as when the menu opens, closes, redraws.

It's coming along well but isn't completed yet. An up-to-date "To Do" list can be found on the SVN.

News

11 April 2009 -- I just tested HomeMenu with a fresh extraction of the libwiisprite tarball... it wasn't pretty. I hadn't noticed just how drastic my modifications to lws were. I'll be updating HomeMenu to work with lws out of the box in a week or so. I'll also implement some more GX related tweaking options so hand rolled graphics solutions can better control HomeMenu's behavior.

Back to coding in a week,

MetaFight 06:20, 11 April 2009 (UTC)


4 April 2009 -- I'm looking for testers. I've gotten reports of odd behavior on PAL systems, so first and foremost I'm looking for PAL testers. I also need widescreen testers (both PAL and NTSC). If you're interested please leave your contact info on the discussion page. I'll also put together a version of the menu that will allow you to take screenshots.

Thanks,

MetaFight 19:01, 4 April 2009 (UTC)


(For older news please refer to the archives.)

Installation and usage

See /HomeMenu/Installation and usage.

Statistics

I'd like to have a general idea of how many apps use this library (once released, or even off the svn). If you use it, could you please add [[Category:Homebrew using HomeMenu]] to your application's wiki page? Thanks.

Feedback / Support

Feedback would be greatly appreciated. You can find me in #wiidev and #wiidevot on EFNet, you can email me at the address listed in the game, or you can use the discussion page.

If you'd like to contribute to the project, please contact me and we'll see what can be arranged.

Release log

30 March 2009

  • Source code released (Google Code SVN).
  • Updated preview (Now with rumble and some sound).

22 March 2009, preview

  • Not yet complete, but you can get the idea.

Thanks

See Also