Inactive [INFO] MCDocs v14.3 ~ Documentation Plugin || MOTD, Local or Online Files, Your Commands [1.3.1]

​

​

​

NEWS (open) NEWS (close)

Version 11.2 released (22nd October 2011)


Version 11.2

• Added permissions wildcard support (mcdocs.*) works for all commands.
  • Note: this only allows all commands. mcdocs.reload does not fall under this wildcard. This needs to be set separately.
• Added some try catch around the motd: configs.
• Fixed motd-enabled

Version 11.1

• Removed the spacing that occurs when you only have 1 page.
• New variable: %time (Shows what time it is in the player's world in 12 hour format.
  • Sun rises @ 5am, Sets @ 7pm

Version 11

• Updated to work with PermissionsBukkit (Tested, nodes work)
• Updated to work with Register for %balance, you will need to download the Register plugin for this to work with iConomy and various other economy plugins.
• Optimised much of the code.
• Updated the commands config structure, much simpler now than before.
• You can now use %name, %size, %world, %group, %ip, %world, %prefix, %suffix in your file paths in the config.yml
  • Example: file: http://example.com/script.php?name=%name
• Redefined the MOTD process.
  • Is now all defined within configuration
  • You can now use online files
• Changed how logging occurs, you can toggle if you want to be informed about errors or not in the config now.
• Group support now uses an in house permission system, where you define the groups players are in manually.
• New permissions-enabled variable, Do you have any permissions system installed? Yes: true | No: false

• If a page is now less than the viewing area, it adds a buffer to the bottom so the header is flush with the top.

 

That's it, I'm getting Notepad++.

I shall inform you any latter news right here.
---
Nope, the files was right! I have a new problem, /help now displays the default/vanilla command list...

 

So I'm having a strange conflict. Maybe you can help.

Previously MCDocs was working fine. i have /rules /news /motd /classes and /mumble set up, and they all work fine. Last night I updated all my plugins and updated to craftbukkit build 260 (as it seems the newest build with support from all the plugins I use) and now /motd and /rules don't work any longer. They just echo back the command in rose red rather than pulling up the file. I'm pretty sure that command echo is a feature of craftbukkit, but I don't understand why those 2 commands don't work but all the rest of my documents do. Any ideas?

 

You have not disabled these commands in essentials.

 

I actually do have them disabled in the config file where you add them via
- motd
- rules

Right? So that can't be the problem.

 

Then its an essentials problem - not mine.

 

Alright

 

Remove Essentials.Help (folder and .jar file) from your plugins to remove that functionality when typing /help.

Regarding this plugin, it has trouble handling multi-line sentences in for example the rules .txt file. It will not allow the user to type in /rules 1 or /rules 2 to display the rules on separate pages, even though it should. Instead, it outputs all the information from this file into the chat window, and one can just see the first rule at the top of the list, when pressing T and reviewing the chat history there.

In short, the multi-page handling of the plugin has trouble with multi-line sentences.

 

That's because it's the responsibility of the user to section the sentences into seperate lines in the .txt.

It's not like you have to restart the server to test it..

I've mentioned before that

IIIIII

is not the same width as

HHHHHH

Plus it's good practice if you want to keep your colours anyway.

 

Very well.
Brilliant plugin, I must say

 

MCDocs v5.0
What's new?

• Complete Nijikokun's Permission Plugin Support
• You can now display a different file using the same command depending on the group specified.
• You can now show a different MOTD for the different groups.
• Some more variables for those using permissions.
• New License.

MCDocs now incorporates Nijikokun's Permission Plugin - Don't worry, if you don't use this plugin, MCDocs will run just like before.

NOTE: If you have this plugin installed, you will have to grant your users acces - see config.yml below.

To use permissions in MCDocs you must first master the following three concepts:

• Permission's config.yml [for player access to the commands]
• The new commands.txt structure [same command, different file per group]
• Create file names for the MOTD based on your group names.

IN DETAIL:

config.yml (open) config.yml (close)

The following node must be used to allow access to your groups/players

Code:

mcdocs./command

For Example:

Code:

mcdocs./rules

You can also allow a group/player to access all the commands:

Code:

mcdocs.*

commands.txt (open) commands.txt (close)

You should only use this structure if you wish for the same command to display a different file when run by various groups

Structure:
/command:filename.txt:Group

What does this mean? - Well only a player from the Group can run the command, and will thus be shown the file. To make the command accessible to various groups, we duplicate the line, and simply change the group and, if you wish, the filename.

Example commands.txt:

Code:

/NULL:LEAVE.THIS.HERE
/rules:rules.txt
/news:news-default.txt:Default
/news:news-default.txt:Member
/news:news-mods.txt:Moderator
/news:news-admins.txt:Admins

And lets also say that the server has the following groups:

• Default
• Member
• VIP
• Moderator
• Admins

Note that VIP is not mentioned in the commands.txt

Explanation:

• /rules will be able to be read by anybody, and only relies on the node permission in the config.yml
• /news will display differently for the various groups
  • "Default" will be shown "news-default.txt"
  • "Member" will be shown "news-default.txt"
  • "Moderator" will be shown "news-default.txt"
  • "Admins" will be shown "news-admins.txt"
  • "VIP" will not be shown a file.
• Also note that if you choose to include a Group with your command, do not have an instance of the same command without a group specified. So, because we've used a group with the /news command in the example above, there should NOT be a "/news:news.txt" apparent.

MOTD (open) MOTD (close)

On Login, MCDocs will look for the following file:

Code:

/path/to/MCDocs/motd-group.txt

For example, if the user to login as of the group "Admins", the following file would be read to them:

Code:

/path/to/MCDocs/motd-admins.txt

If this file was not found, MCDocs then looks for the following file:

Code:

/path/to/MCDocs/motd.txt

and if that file was not found, nothing is shown.

Variables (open) Variables (close)

The following variables are now available too:

%group - Displays the User's group
%prefix - Displays the Group's prefix
%suffix - Displays the Group's suffix

License (open) License (close)

/*
* MCDocs by Tazzernator
* (Andrew Tajsic ~ atajsicDesigns ~ http://atajsic.com)
*
* THIS PLUGIN IS LICENSED UNDER THE WTFPL - (Do What The Fuck You Want To Public License)
*
* This program is free software. It comes without any warranty, to
* the extent permitted by applicable law. You can redistribute it
* and/or modify it under the terms of the Do What The Fuck You Want
* To Public License, Version 2, as published by Sam Hocevar. See
* http://sam.zoy.org/wtfpl/COPYING for more details.
*
* TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
*
* 0. You just DO WHAT THE FUCK YOU WANT TO.
*
* */

DOWNLOAD!
Download 5.1+

 

ummm. bin folder? plugin doesnt seem to activate, im guessing that .txt for an old version?
--- merged: Feb 10, 2011 4:38 PM ---
omg, thank you for this beautiful addon
--- merged: Feb 10, 2011 4:58 PM ---

can someon elaberate on this. I disable the command then my user have to use /h. I would really like to just remove the command from essentials all together. rofl 21 pages of commands

 

From memory Essentials can be configured with the config.yml in the Essentials folder in your plugin folder..

In there there is a disable section where you can list commands to disable. You should ask in the Essentials thread for more information.

 

So no one has any ideas? I change CraftBukkit versions every now and then, but no matter what, /help just does what it would without any plugin (the default command list). I don't think MCDocs v5.0 will change anything.

 

What build # are you running there?

 

I did some testing today, I was having the same problem of /help only showing the same list as you would get by doing /help in the server console. I removed all the other plugins. I am using CB 300, MCDocs 5. What I found was that if I was an OP, then I would get the console help results, if I wasnt an OP, I got the MCDocs help results.

 

CB 238 - MCDocs 4.3.

Thanks - I'll add that info to the OP.
--- merged: Feb 11, 2011 3:20 AM ---

I fixed this in 5.0 too - lol.

 

I think you should clarify it a bit in the OP. basically if you are an op and use /help, you will not get the MCDocs help, you will get the server console help.

 

I have - Under Use>Basics.

 

So, what do I do to get the MCDocs /help list if I am an op?

 

Maybe set a second command for the same file?

/help:help.txt
/helpop:help.txt

 

/helpop doesn't seem to do anything, it comes up with "Type your question for an op to answer". Does it have to be called /helpop?

Edit:
I tried /cmd:cmd.txt but it does nothing.

EDIT 2:
FREAKING FINALLY IT WORKS!! <3 <3 <3

 

5.0 yeah. big thanks.

 

How do I use mcdocs if I have essentials

 

MCDocs gives YOU the oppertunity to CHOOSE the commands YOU wish to use.

if YOU wish to use commands that essentials uses aswell - You must disable them in essentials. Read the Essentials wiki!

No worries mate!

 

for anyone with the /helpop problem, its because the essentials plugin has a /helpop command that allows you to ask a question of an OP. personally I use /ahelp for all admin commands, /help for normal user commands, and I also have a 3rd option of /shelp for voxel sniper commands. like Tazzernator said, you can make the command whatever you want, just watch out for clashes

 

MCDocs 5.1

• Fixed a major error in my coding -- if your commands was only /command:filename.txt -- Permissions were ignored -- Woops! Fixed now

DOWNLOAD
ZIP|JAR

 

Yeah, I realised that and changed it to /cmd since it's quick and easy to type and makes more sense than helpop
--- merged: Feb 12, 2011 11:40 AM ---
Do you know why all coloured text appears white with coloured shadows? I posted a thread but since you're a good coder and this thread seems more popular I might get a better response. Thank you in advance

 

This has the same problem as other MOTD things. When you reload the plugin in Essentials, It adds a repetition to the times it says the motd, or /news or /registration or whatever. It says it twice. wtf

 

Why would you EVER have to reload the plugin? and you say wtf to me?

ON-THE-FLY means the files are read ON-THE-FLY.

 

i can't figure you why this isn't working.
i have motd and rules disabled in essentials but now the only mcdoc that works is /news
if i change /rules:rules.txt to /myrules:rules.txt it works

the motd only seems to work on login, but not using the command