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
#332 desht_08

View User Profile

Send Message

Posted Jul 2, 2014
@VirtuaNick

I'm not seeing any hit-box glitchiness, really - just tested with an 8-line public hologram and it scrolls fine. But if there is glitching, I'm going to have to blame HoloAPI :)

Your pointer scrolling suggestion is already in there - type /sms set scroll_type page and you will get the behaviour you want. More information on the scroll_type config setting can be found in Configuration.

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

View User Profile

Send Message

Posted Jul 2, 2014
@woeterman94

I've created http://dev.bukkit.org/bukkit-plugins/scrollingmenusign/tickets/80-signs-not-responsive/ to track this - please take a look at the ticket and follow the instructions there.

Rollback Post to Revision RollBack
_ForgeUser8772879
- Join Date: 4/20/2012
- Posts: 10
- Member Details
#330 _ForgeUser8772879

View User Profile

Send Message

Posted Jul 1, 2014
@desht:

Thanks! That fixed it. I can scroll through the menu now, but I noticed that hologram views with more than 4 lines have glitchy hit-boxes for scrolling. Is this a limitation on your end?

EDIT: Also, a suggestion: Would it be possible to implement pointer scrolling as opposed to element scrolling? I found that larger lists can be disorienting when elements scroll through.

Last edited by _ForgeUser8772879: Jul 1, 2014

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

View User Profile

Send Message

Posted Jul 1, 2014
There's something bad in showing "empty" slots in menu. On show (command /skilltree show View Nick show GUI to player, error is in viewing, not in command). I have a lot of structures like this:

- message: '' icon: AIR usesRemaining: {} command: '' altCommand: '' permission: '' label: '29' lore: []

Line in your code when error appear is:

im.setDisplayName(ChatColor.RESET + label);

So something wrong is with labels. Can you tell me what (and also can you "cut" empty slots to only need icon: AIR instead of entire structure)?
Last edited by _ForgeUser8077206: Jul 1, 2014

Rollback Post to Revision RollBack
_ForgeUser9028333
- Join Date: 6/13/2012
- Posts: 34
- Member Details
#328 _ForgeUser9028333

View User Profile

Send Message

Posted Jul 1, 2014
@desht

Yes, that's what I meant, thanks!

However, the signs are not working on my server. (I cannot scroll or activate them) Does it have anything to do with PEX? How can I solve it?

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

View User Profile

Send Message

Posted Jul 1, 2014
@VirtuaNick

Caused by: java.lang.NoSuchMethodError: com.dsh105.holoapi.api.Hologram.setTouchEnabled(Z)V

Looks like you have an outdated version of HoloAPI that doesn't support touch holograms. I suggest trying the latest dev version from http://ci.hawkfalcon.com/job/HoloAPI/ - it's working well for me here.
Last edited by desht_08: Jul 1, 2014

Rollback Post to Revision RollBack
_ForgeUser8772879
- Join Date: 4/20/2012
- Posts: 10
- Member Details
#326 _ForgeUser8772879

View User Profile

Send Message

Posted Jun 30, 2014
I'm getting an error when creating a hologram. I have CB 1.7.9 R2.

Steps to reproduce: (1) /sms create Menu Menu. (2) /sms add Menu option1 "/list" (3) /sms add Menu option2 "/toggledownfall" (4) /sms sync Menu -holopri (5) /sms view Menu-1 -popup

Result: In chat: "An internal error occurred while attempting to perform this command" In console: http://pastebin.com/37Mj7qDY

Last edited by _ForgeUser8772879: Jun 30, 2014

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

View User Profile

Send Message

Posted Jun 27, 2014
New Major Release

SMS v3.0.1 has been released, http://dev.bukkit.org/bukkit-plugins/scrollingmenusign/files/53-scrolling-menu-sign-v3-0-1/a major update with many changes.

Big new feature: hologram views! Both public views for all to interact, and private per-player views.

Note that this release is only supported on 1.7.9-based servers.

Last edited by desht_08: Jun 27, 2014

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

View User Profile

Send Message

Posted Jun 27, 2014
@woeterman94

When you say "control", do you mean configure the sign views, or just use them? I probably need to have a better understanding of what you're trying to achieve to answer your question fully.

There is Access Control where you can define the access for a menu or view; you can restrict certain menus and views to be usable by only the person who created them, or by a certain permission group (if you have Vault).

Rollback Post to Revision RollBack
_ForgeUser9028333
- Join Date: 6/13/2012
- Posts: 34
- Member Details
#323 _ForgeUser9028333

View User Profile

Send Message

Posted Jun 26, 2014
Can you give user specific permissions for different signs?

For example when you want users to control one sign at spawn but not the signs at the shop.

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

View User Profile

Send Message

Posted Jun 26, 2014
@wiedzmin137

That certainly won't work at this point. It would require a parser rewrite and multiple passes of the substitution handler to make work, which I'm wary of doing for performance reasons. But I'll have a think about it and see if I can come up with something.

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

View User Profile

Send Message

Posted Jun 25, 2014
Also, is there possibility to use "variable in variable" e.g.
<$*.Warrior.<$Player:Level>.Icebolt.Damage>?

Last edited by _ForgeUser8077206: Jun 26, 2014

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

View User Profile

Send Message

Posted Jun 25, 2014
@desht

I want to avoid big mess with using ScrollingMenuSign (I tried to use them for about 2 hours, it's really a lot of work, look also here) and edit lore of player directly. If you expand UserVariable API - then I choose this way.

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

View User Profile

Send Message

Posted Jun 25, 2014
@wiedzmin137

If by "event" you mean Bukkit events, then an InventoryOpenEvent should be fired, since the inventory view is represented by an inventory window. There's no special hook called by SMS, though.

What are you trying to achieve here?

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

View User Profile

Send Message

Posted Jun 24, 2014
Which event is executed on InventoryView open?

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

View User Profile

Send Message

Posted Jun 23, 2014
@desht

I just forget about this change (plugin doesn't make acutal this thing), sorry and thanks.

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

View User Profile

Send Message

Posted Jun 23, 2014
@wiedzmin137

That error is actually fixed in the latest dev (and the just-uploaded v3.0.0 release).

As for the icon not showing, I thought I'd fixed that months ago. Make sure your config.yml has:

submenus.back_item.material: wood_door

(and not "wooden_door" - see http://dev.bukkit.org/bukkit-plugins/scrollingmenusign/tickets/74-doors-from-submenu-doesnt-show/)
Last edited by desht_08: Jun 23, 2014

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

View User Profile

Send Message

Posted Jun 23, 2014
@desht

Thanks.

Now I have problem with Submenus (InventoryView): The doors don't show, but if you click, you'll get this message http://prntscr.com/3vob5g

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

View User Profile

Send Message

Posted Jun 23, 2014
@wiedzmin137

Hi, neither of those are really possible at this time:

Map view backgrounds are an attribute of the view, not the menu. When a view displays a submenu, it's still using the original view's attributes. Changing that would be a fairly fundamental modification to how menus work; I will think about possibilities here, but it's a major addition.
I might look at adding some code (transparency/drop shadows) to make text more legible in future, but for now, what about just making the background image a bit paler, or using a brighter colour for the title?
Rollback Post to Revision RollBack
_ForgeUser8077206
- Join Date: 12/14/2011
- Posts: 466
- Member Details
#313 _ForgeUser8077206

View User Profile

Send Message

Posted Jun 23, 2014
Hello.

"submenu-for-x" (MapView) have background. If I create "x" (MapView too) which use "SUBMENU submenu-for-x" then "submenu-for-x" doesn't have background. Can you fix that?
Can you add possibility to add some kind of "color background" on background in MenuName (MapView), e.g. Here - "Stalowy miecz" is not very readable.
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,333
License

GNU Lesser General Public Lice...

Bukkit

ScrollingMenuSign

Bukkit Plugins