ScrollingMenuSign

Table of Contents

ScrollingMenuSign lets players execute commands with a simple click on a scrollable sign, map, icon, hologram or Spout menu view. Players can scroll through menus by right-clicking, and execute commands by left-clicking (button bindings are configurable). Redstone views allow commands to be executed when a redstone signal (on/off/toggle) is received. Sign views can consist of multiple signs for larger menus, and can be configured to emit a redstone signal when scrolled or executed. The sophisticated command parser allows for command costs (economy, items, item durability, health, food, XP), permission elevation and basic flow control (conditional execution & macros), and even more powerful control is possible with external scripting languages (Javascript, Python...).

Want to get started quickly? Read the Quickstart Guide!

Videos

Latest Version

Features

Create scrollable command menus with one or more sign, map, multisign, inventory, hologram or spout views. Or trigger your menus with redstone signals or even from any held item.
Scroll through views with right-click, execute the selected command with left-click (configurable)
Sophisticated command parser/executor - permission elevation, command costs (items/durability/economy/food/health/xp), player/group/world restrictions, variable substitutions...
Commands can have warm-ups and cooldowns
Macros - run multiple commands or display large text blocks with one click
Build a hierarchy of menus using Submenus
Flexible Access Control gives you private menus and views, or limited to permission groups.
External scripting language support allowing unlimited flexibility in what menu commands can do
Sign & multisign views can produce Redstone Output when scrolled or executed
Redstone Control Signs allow remote scrolling & execution via redstone signals for sign & multisign views
Permissions support via Bukkit superperms
Command Logging lets you keep an audit trail of who's executed what commands from SMS menus
Multi-world support: menus can have views in any number of worlds
Full coloured/bold/italic/underline/strikethrough text support on menu titles, items and messages
Configure menus or menu items to have a limited number of uses, either per-player or globally
Comprehensive tab completion for all commands
Optional Spout support

Possible Applications

A menu of station setting commands for Minecart Mania (this is what inspired me to write the plugin in the first place!)
Newbie user guide menus
Warp menus for your favourite teleportation plugin
A basic shop menu - buy/sell/swap items & credits
Controlled access to commands that users can't normally run
Item reward menus with limited usage count
Traps built from redstone views and/or scripts
Super-convenient game mode (survival/creative) changer with map and/or spout views

Installation

Pretty simple:

Copy ScrollingMenuSign.jar into your server's bukkit/plugins folder
Optional: install Vault for economy command costs and/or permission group support.
Optional: install ProtocolLib to make active items glow.
Restart or reload your server.

That's it. ScrollingMenuSign will automatically create a folder called bukkit/plugins/ScrollingMenuSign when it first runs. All data related to the plugin is stored in here.

Documentation

Source

https://github.com/desht/ScrollingMenuSign

Development Versions

Development versions can be downloaded from this Jenkins build server. Notes:

Development versions have not been approved by dev.bukkit.org staff
Development versions may be buggy or fail to work completely. Only use development versions if you a) want to help with finding bugs, or b) have been asked to, to test a bugfix.

Changelog

Complete changelog

Usage Statistics

Since SMS v1.3.0, fully anonymous usage statistics are collected using MCStats:

If you wish to opt out of MCStats metrics collection, edit plugins/PluginMetrics/config.yml and change opt-out: false to true.

Donations

If you use and enjoy ScrollingMenuSign, you are welcome to make a donation by clicking the "Donate" button at the top right. However, donations are strictly optional, and don't confer any special benefits over non-donors.

Comments

desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#290 desht_08

View User Profile

Send Message

Posted May 13, 2014
@wiedzmin137

Done!

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#289 _ForgeUser8077206

View User Profile

Send Message

Posted May 13, 2014
Little suggestion - add link to devbuild server here.

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#288 desht_08

View User Profile

Send Message

Posted May 11, 2014
@wiedzmin137

Can you create an enhancement ticket for that one, otherwise I'll just forget it :)

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#287 _ForgeUser8077206

View User Profile

Send Message

Posted May 10, 2014
@desht

And question about icons - is there possibility to change their amount and enchantment (boolean)?

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#286 desht_08

View User Profile

Send Message

Posted May 8, 2014
@wiedzmin137

Ah, OK. I've just fixed that in the latest dev release - set up proper non-null defaults for anything not specified in the Builder object. Your code didn't set use withMessage() so it was wrongly set to null in the menu item, when it should have been "". Your code should work fine with the latest dev release (Jenkins build #15).

Rollback Post to Revision RollBack

_ForgeUser8077206

Join Date: 12/14/2011
Posts: 466
Member Details

#285 Posted May 8, 2014

Builder looks very nice but...

//This was after change, this can cause error
        			SMSMenuItem skillClass = new SMSMenuItem.Builder(menu, Lang.GUI_TITLE_SKILL.toString().replace("%skill%", skill.getName()))
        				.withCommand("/st down " + skill.getName() + " 1")
        				.withAltCommand("/st up " + skill.getName() + " 1")
        				.withIcon(indicator)
        				.withLore(Lang.GUI_LORE.toString(),
        					skill.getIdentifiers()[0],
        					"&iNice &lone")
        				.build();
//This was before
        			SMSMenuItem skillsClass = new SMSMenuItem(menu, /*menu*/
        					Lang.GUI_TITLE_SKILL.toString().replace("%skill%", skill.getName()), /*label*/
        					"/" + skill.getIdentifiers()[0], "", /*command, message*/
        					indicator, /*iconMaterialName*/
        					new String[] { /*lore*/
        				Lang.GUI_LORE.toString(), //Click for use!: String
        				Lang.GUI_LORE_LEVEL.toString() //SkillLevel: String
        				.replace("%level%", String.valueOf(skillLevel)) //skillLevel: int
        				.replace("%maxLevel%", String.valueOf(skillMaxLevel)) //maxLevel: int

It was returned this (on 223 line I have menu.setAutosave(true); )

Lang enum contain &something for colouring.

desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#284 desht_08

View User Profile

Send Message

Posted May 8, 2014
@wiedzmin137

Not bored, discussion is always welcome :)

However, a setAltCommand() method won't be added, since SMSMenuItem is a (mostly) immutable class - only the remaining uses on an existing menu item can be changed.

To set the alt-command in a new SMSMenuItem, use the SMSMenuItem.Builder object, with the withAltCommand() method, e.g.

SMSMenuItem item = new SMSMenuItem.Builder(menu, label) .withCommand(cmd) .withAltCommand(altCmd) // and any other modifiers you want .build();

I decided to add a builder pattern for this class since the number of (optional) parameter was just getting too big...
Last edited by desht_08: May 8, 2014

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#283 _ForgeUser8077206

View User Profile

Send Message

Posted May 8, 2014
Also, can you add setAltCommand into SMSMenuItem class?

You're not bored with my requests?

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#282 desht_08

View User Profile

Send Message

Posted Apr 25, 2014
@wiedzmin137

OK, I see. It may actually be possible to do without ProtocolLib - it's just a matter of making the appropriate substitutions when the item stacks are created for the inventory window. I will probably make that a feature which needs to be enabled in the config, simply because it adds extra processing time for a feature not everyone will need. But yeah, I can the use for that...

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#281 _ForgeUser8077206

View User Profile

Send Message

Posted Apr 25, 2014
@desht

Substitutions in lore - I would see API for that and {Player} variable (maybe here ProtocolLib is needed ;) ).

E.g. (with API):

You must have {Level} to upgrade that item.
You have {SkillLevel} level on this skill.
Damage: {Damage}

Those examples are about Skills from Heroes, SkillLevel from my plugin.
I think that it will be faster that actualize menu.yml ALWAYS onMenuOpen.
Last edited by _ForgeUser8077206: Apr 25, 2014

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#280 desht_08

View User Profile

Send Message

Posted Apr 25, 2014
@wiedzmin137

API for adding custom substitutions: no, but that's a good idea, and something easy enough to add. Expect to see it in the upcoming 2.4.0.

Substitutions in lore: no, and that's a bit harder. What kind of use-case do you see for this?

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#279 _ForgeUser8077206

View User Profile

Send Message

Posted Apr 25, 2014
@desht

And is there API for writing your own variables by external plugin?

Are those variables can be used on lore?

Last edited by _ForgeUser8077206: Apr 25, 2014

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#278 desht_08

View User Profile

Send Message

Posted Apr 25, 2014
@wiedzmin137

It's absolutely possible, and no ProtocolLib or extra plugin is needed. Any occurrence of <NAME> in a command is replaced with the name of the player who is running the command. The next release will also support the <UUID> replacement for the player's full UUID.

See http://dev.bukkit.org/bukkit-plugins/scrollingmenusign/pages/command-parser/#w-command-preprocessing for a full list of subsitutions that are made.

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#277 _ForgeUser8077206

View User Profile

Send Message

Posted Apr 25, 2014
Is there possibility to write variables on menu.yml? E.g. {player} - in game returns players name (who e.g. see that).

If not, can you implement that (as I know, you can use ProtocolLib for that)?

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#276 desht_08

View User Profile

Send Message

Posted Mar 30, 2014
@wiedzmin137

Yeah, this looks interesting :) I'll definitely be checking this out.

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#275 _ForgeUser8077206

View User Profile

Send Message

Posted Mar 30, 2014
For Holografic view, you can use Touchscreen Holograms, like here.

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#274 desht_08

View User Profile

Send Message

Posted Mar 3, 2014
@wiedzmin137

Yeah, items with no command would cause an inventory view to pop down (if its "autopopdown" attribute is true, which is the default). I can modify that for the next release, and not pop down views at all if the item has no command.

If you can find a way of preventing an inventory window from closing, great :) But I'll be extremely surprised. Closing of windows is done client-side, and a packet is sent to the server to tell it that the window has already been closed. It isn't possible to stop the window being closed (although I could possibly just immediately pop the window up again if I can detect that it was closed without any icon being clicked... that could work).

Last edited by desht_08: Mar 3, 2014

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#273 desht_08

View User Profile

Send Message

Posted Mar 3, 2014
For anyone who uses Submenus in conjunction with View Types / Inventory Views in 1.7.x - if you notice that the "<- Back" button is missing, the fix is here:

http://dev.bukkit.org/bukkit-plugins/scrollingmenusign/tickets/74-doors-from-submenu-doesnt-show/?comment=1

Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#272 _ForgeUser8077206

View User Profile

Send Message

Posted Mar 1, 2014
@desht

I'll add ticket soon.
I'm exciting that news, of course - wait for that.
With tellraw you can e.g. open a link menu or suggest command (like players' T + /<command> without enter). Probably, there is API just for that features. You can see those features here.
Thanks for Submenu. But you can click in Unclickable item GUI and menu will disapear.
I've seen somewhere GUI's with ESC and E prevention, I'll search that again.

Maybe you'll create ToDo list?
Last edited by _ForgeUser8077206: Mar 1, 2014

Rollback Post to Revision RollBack
desht_08
- Join Date: 8/26/2011
- Posts: 452
- Member Details
#271 desht_08

View User Profile

Send Message

Posted Mar 1, 2014
@wiedzmin137

Yep, sorry, meant to reply earlier. Anyway:

If you're having trouble with submenus, please create a ticket and include instructions on how to reproduce the problem, i.e. the command you used to create the menus which are giving you trouble.
Quantity/enchantment of inventory view icons: can't be done right now, but that's a feature which could be added. Need to come up with a new syntax for specifying that, though.
Submenus by API: no special API needed here - just create your menus as normal, and add an item with a command like "SUBMENU <mysubmenu>" to the main menu; basically the same as if you were creating menus via commands.
tellraw: I haven't looked into this yet, no. Can you supply some examples of how you'd like to see it working?
Unclickable icon menu GUI items: you can easily do this now by simply adding a menu item with no command - just use the empty string for your command.
Unleaveable GUI's? Not sure how that would work - it is not possible to prevent someone closing an inventory window by pressing Escape (InventoryCloseEvent can't be cancelled).
Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

31310
Created

Aug 26, 2011
Last Released File

Jun 25, 2014
Total Downloads

65,411
License

GNU Lesser General Public Lice...

Bukkit

ScrollingMenuSign

Bukkit Plugins