Akayan GUI Creator

Share your scripts and packages with other Mudlet users.
User avatar
Akaya
Posts: 412
Joined: Thu Apr 19, 2012 1:36 am

Akayan GUI Creator

Post by Akaya » Mon Mar 11, 2013 12:20 am

The Akayan GUI Creator is a graphical user interface that will assist you in setting up your own GUI. It is currently built for the use of Iron Realms Entertainment's MUD, Achaea. It is still possible to use with other MUDS but its functionality will be limited and many scripts will likely need to be altered.
:!: The Akayan GUI Creator must be installed on a fresh profile so it doesn't conflict with other scripts you may have
You'll need the latest version of Vyzor which can be found here
Click the 'ZIP' button towards the top of that link to download it as a zip file. Extract the zip file to your computer and install vyzor.mpackage via Mudlet's Package Manger located on the toolbar of Mudlet.
Once Vyzor is installed, you can install the following file via Mudlet's Package Manger.
Akayan GUI Creator.zip
(1.36 MiB) Downloaded 1016 times
How It Works
I'm still in the process of writing proper documentation, but to get you started...
Toolbar: The toolbar rests at the top of the screen and has numerous pull down menus. Currently, they are: Add, Edit, Build, Help, and About.
  • Add Menu: When you click an option on this menu, it will be added to your GUI
    • Chat Window: A basic chat window with some generic tabs. Future updates will allow you to alter which tabs are used as well as their style and size.
      Mapper Widget: Adds the Mudlet Mapper Widget. You'll need to download the lastest mapper for your MUD for this to work properly.
      Status Screen: Adds some information about your character. I'm going to really deck this out in the future. For now, it includes your level, experience, house, race, specialisation, and class via gmcp data.
      Affliction Tracker: Adds an affliction tracker. This is the only svo specific component at the moment. You'll need svo for it to function properly. Future updates will allow Omni users to utilize this feature.
      Info Here: Adds an info here display. This will show you what items are in your current room via gmcp. It updates very nicely as you move around.
      Fishing Tournament: Adds the Akayan Fishing UI. Allows you to hold a fishing tournament with up to 4 people. I wrote this awhile back and its great to have if you're a deepsea fishing fanatic.
    Edit Menu: When you click an option on this menu, you will be prompted to select an item to alter. Simply click on a GUI component you've added to continue, or click anywhere on the background to cancel.
    • Move: Allows you to alter the position of the selected GUI component via an orange compass. Clicking the arrows on the compass will move the GUI component accordingly. When you're finished, click the checkmark in the center of the compass to confirm your selection.
      Resize: Allows you to alter the size of the selected GUI component via an orange compass. Clicking the arrows on the compass will resize the GUI component accordingly. When you're finished, click the checkmark in the center of the compass to confirm your selection.
    • Build Menu: I've yet to add this feature, but in the near future, you will be able to build your own GUI from scratch by adding Frames or Components from this menu.
    • Help Menu: This menu contains all the documentation you'll need to build a user interface just like this! The Mudlet Manual, The Vyzor Guide, and a link to all the GUI components offered with this package and how they work.
    • About Menu: Clicking the option in this menu will display a bit of information as to where the Akayan GUI Creator is at, where its going, and how you can help.
As I stated before, this is far from complete. It is very much in beta and I encourage all to assist me in weeding out the bugs. That said, here are a few known issues I'm still working on. They are easily worked around, but a pain none-the-less. If you know how these can be fixed, do tell!

Ideas in the works:
  • Adding the Akayan Hunting UI component to the Add Menu.
    Constructing the Build Menu
    Options for Fonts, Colors, and Styles for all components.
    Updating the Add Menu so that if you have an Akayan UI component, it will automatically be added to the Add Menu for you.
Known Issues:
  • Each time Vyzor.HUD:Draw() is ran, a black Frame/MiniConsole will appear from the Chat Window. I recommend adding your chat window to the GUI first as it nulls this bug.

User avatar
chris
Posts: 493
Joined: Fri Jun 17, 2011 5:39 am

Re: Akayan GUI Creator

Post by chris » Mon Mar 11, 2013 9:58 pm

Looks nice. It would be cool to make some of the features more abstractable and OO, and would help reduce your code significantly while helping others out.

User avatar
Akaya
Posts: 412
Joined: Thu Apr 19, 2012 1:36 am

Akayan GUI Creator Build Feature!

Post by Akaya » Sat Mar 23, 2013 3:39 am

The new build feature will allow you create your very own GUI on any MUD as long as you have the latest version of Mudlet and the latest version of the Vyzor Framework.

At the moment, it allows you to create Frames (labels), MiniConsoles, Chat Windows and Gauges. Future updates will allow a multitude of features so you can create eye-popping GUI's with your imagation as the limit.

Due note that this script only creates the GUI components for you. It is still up to you to do the scripting in the background such as updating the gauges, or creating the triggers that will append lines to the Chat Windows. (Again, I hope to change this in future updates, but for now, its up to you)

I've split the Akayan GUI Creator into two halves for now. The first half is the script on the first post of this thread. It creates premade GUI components that I've made over the past few months. The second half, a completely separate script for now, allows maximum customization so you can build your GUI from scratch. If you're a novice to the Mudlet world, I recommend the first half.

The mechanics of the build feature work pretty much the same as before with a few alterations. Here's a short demo on how it works: http://youtu.be/QLWJeuJuWeE

The #1 issue users run into when using my GUIs is not installing Vyzor properly.
Watch this video if have not already! http://youtu.be/SAQ2SumHfRw
The video above will show you how to properly install Vyzor along with a minor change you should make to ensure everything loads properly when you load your Mudlet profile.
Akayan GUI Creator Build Feature.zip
- Updated 3/25/2013
- You can now add images to Frames
(3.3 MiB) Downloaded 1097 times
Enjoy!
Last edited by Akaya on Mon Mar 25, 2013 6:54 pm, edited 1 time in total.

Daagar
Posts: 84
Joined: Fri Feb 19, 2010 2:42 am

Re: Akayan GUI Creator

Post by Daagar » Mon Mar 25, 2013 4:39 am

This second build-from-scratch edition is pretty impressive!

User avatar
Akaya
Posts: 412
Joined: Thu Apr 19, 2012 1:36 am

Re: Akayan GUI Creator

Post by Akaya » Mon Mar 25, 2013 6:55 pm

Added a new feature that adds images to your Frames.

Here it is in action: http://youtu.be/nRa-ObCfYoY

User avatar
Oneymus
Posts: 321
Joined: Thu Sep 17, 2009 5:24 am

Re: Akayan GUI Creator

Post by Oneymus » Mon Mar 25, 2013 11:22 pm

I continue to be amazed at what you're doing with Vyzor, Akaya.

User avatar
Akaya
Posts: 412
Joined: Thu Apr 19, 2012 1:36 am

Re: Akayan GUI Creator

Post by Akaya » Tue Mar 26, 2013 6:28 pm

I made some proper documentation for the second version. As this project updates, so will the documentation.

I'm not the best with literature so if you find room for improvement please do tell!

You can find the Akayan GUI Creator Manual here.

User avatar
demonnic
Posts: 576
Joined: Sat Dec 05, 2009 3:19 pm

Re: Akayan GUI Creator

Post by demonnic » Thu Mar 28, 2013 5:27 am

Have you considered vendoring Vyzor, Akaya? It seems to me that if the #1 issue most folks have is installing vyzor, if you offer two versions (one with Vyzor bundled, and one without) then if they don't already have Vyzor, or want to update it themselves as Oney updates it, they could get the version you're already putting out there. But for those without it and who are unlikely to want to muck about with it themselves you could just include the necessary items inside the mpackage. Save yourself some headaches.

Assuming Oney doesn't have any issues with you doing it.

User avatar
Oneymus
Posts: 321
Joined: Thu Sep 17, 2009 5:24 am

Re: Akayan GUI Creator

Post by Oneymus » Thu Mar 28, 2013 5:09 pm

That's fine by me. Until I am motivated to make some changes in the way Vyzor is distributed (see Akaya's post about automatically updating a package, for instance), that sounds like an effective method of distribution.

User avatar
Akaya
Posts: 412
Joined: Thu Apr 19, 2012 1:36 am

Re: Akayan GUI Creator

Post by Akaya » Sun Jul 21, 2013 6:15 am

Here's the latest version. I improved the overall look and functionality. BackDrop is the main Frame everything is built on. Ideas for this are more than welcome. It's written with Vyzor so be sure you have the latest version on your profile before installing.
AGUI.zip
(55.67 KiB) Downloaded 585 times
EDIT: I didn't think I was using images in this, but apparently I did. So here's a zip that includes them instead of just the .xml file. Just install the zip as is via the Package Manager.

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest