ScrollingMenuSign
Videos
Latest video:
- See the Videos page for full list of demonstration & tutorial 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
- Quickstart Guide
- FAQ
- Command Reference
- Permissions support
- The Configuration File
- The Command Parser
- Submenus
- Warmups and Cooldowns
- Popup Messages
- View Types
- Redstone Output
- Macros
- Menu Item Tooltips
- User Variables
- Command Logging
- Setting usage limits on menus & menu items
- Redstone Control Signs
- Spout Support
- Using External Scripting Languages
- API: Managing ScrollingMenuSign menus from scripts or other plugins
Source
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
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.
@Fairawen
Thanks :) Always nice to hear from satisfied users!
Just wanted to drop a friendly note to let you know how fantastic this mod is. Exactly what my server needed. It's evident you spent a huge amount of time making this thing flawless. Hats off to you! :D
@desht
For ProtocolLib, you have typo in link to it (look up). You have /Protocol-lib instead of /ProtocolLib.
@wiedzmin137
Yeah, I can do that.
@desht
That's not good (I have used editor instead of commands). Can you add "translator" for this (e.g. ሴ => unicode/"?" character)?
Before the time I did not have access to PLib page...
@wiedzmin137
Did you edit the menu file directly, or use a /sms command to enter the ሴ sequence? The escape codes will only work via command (if editing directly, you'll need to use an editor which can insert unicode characters somehow).
The ProtocolLib page looks fine: http://dev.bukkit.org/bukkit-plugins/protocollib/
@desht
Not works (I use 18th build). Screen: click
Code (first and last lines with "characters");
Google Translator tells me that ሴ should returns "ሴ" character.
BTW: Was ProtocolLib's dev.bukkit page deleted?
@wiedzmin137
I actually edited the original to correct it - should have mentioned that, sorry. The "ሴ" sequence definitely works in the latest dev build. Make sure you're including the trailing semicolon.
@desht
FYI - you have wrote this same example so this same effect appear.
For justification I will add ticket soon.
@wiedzmin137
Oops, typo there - try
/sms add mymenu "Unicode ሴ Test" "
- '&' before the '#', not after.hello <<NAME>>!"
Justification works fine as far as I can see - if you have a problem, please create a ticket with detailed description of how to reproduce it.
@desht
Hmm... It doesn't work for me, maybe I'm newbie in HTML but your examples doesn't works.
EDIT: Also, I'm not sure is item_justify and title_justify in views are working.
@wiedzmin137
Yes, I'll probably eventually deny any attempt to put space in menu names (and transform any already saved entries with "_" like you suggest). I'll probably limit menu names to alphanumeric, "_" and "-".
@wiedzmin137
Regarding Unicode unescaping, I'll go one better and run HTML unescaping on any label, command, feedback message or lore that is entered via
/sms add
or/sms edit
. So in the latest dev build you can now do:Any &xxxx; sequence valid in HTML should work, including Ӓ for a literal Unicode character.
@desht
Maybe "_" character instead of spaces (on menu loading read spaces and transform it) and .replace("_", " ") on specific menus/views/events. Of course warning to menu creator will be good (to be aware of situations like this and tells players to use Player_Menu instead of Player Menu).
@wiedzmin137
Yeah, you've hit a problem with spaces in menu names. Next build will allow working around that by surrounding the name in quotes -
/sms give book "Player Menu"
and fix a couple of other small problems with the give command.But spaces in menu names isn't a great idea - it just makes it more difficult to use various commands, and messes with Tab completion. Spaces in the displayed menu titles are fine; but in the menu names - not such a good idea. Better to have a menu name like player-names (the name doesn't get displayed to players, only the title).
@desht
OK, I'm waiting for \u1234 support and I will do something more depth. Probably it will be WTownyAddon with GUI instead of boring commands (designed mainly for stupid players).
BTW: You have typo in command:
@wiedzmin137
That must be down to the locale you have defined for your CraftBukkit JVM. I've never understood precisely how locale settings affect what characters work and what don't, but I suspect you're supplying ISO-8859-1 encoded characters to a JVM expecting UTF-8, or possibly vice versa.
@desht
On my Linux they don't work, ąćęłń are converted into something like [?].
@wiedzmin137
Do you mean the ability to convert a literal "\u1234" sequence as typed in chat into a Unicode character? If so - no, but that could be added. There shouldn't be any problem storing or parsing such characters (it is already possible to edit the menu files directly and do
/sms reload
and Unicode characters work fine there).I know that the OS and server locale settings can cause problems with non-ASCII characters sometimes, but it's working fine my Linux dev server using a en_GB.UTF-8 locale.
Do you have UTF-8 characters support (e.g. like McMMO - \u1234)?