Page 1 of 2

RULES_MODULE - is there any interest?

Posted: Tue Feb 05, 2013 4:51 pm
by Captank
To clean this thread a bit and keep it up to date, this post will become a bit different now.

All information about the RULES_MODULE you can find now at: https://github.com/Captank/RULES_MODULE

I will try to keep a change log in this post up to date as well.

Cap

Little side note, since I'm working on other stuff I do not really enhance the rules module anymore, if bugs occure I'll still fix them and if there are any feature requests that are quite quick implemented I prolly will do it, too. But don't expect huge changes anymore.

Change log:
27-03-2013: Readme added, budabot thread clean up
06-04-2013: !rules changes, !rulesadmin spam and behavior of !rules (and !rules changes) implemented.
14-05-2013: Module is now using namespaces.
20-05-2013: sign_alts setting implemented
16-11-2013: added installer for windows, updated readme's install instructions

Re: RULES_MODULE - is there any interest?

Posted: Tue Feb 05, 2013 5:36 pm
by Tyrence
It's a nice idea. I know that several people have asked about something similar. As far as including it into the bot, we usually try to determine how many orgs would use this and if enough orgs show interest we include it. I am interested to see how it turns out.

Re: RULES_MODULE - is there any interest?

Posted: Tue Feb 05, 2013 6:10 pm
by Captank
So I'll hold the development more abstract for different cases (for example for raid bots as well)

And maybe different "rule levels" so that u can use different rules for members, guild members, etc as well.

But this will take a while since i never messed around with v3 since yesterday >.<

cap

Re: RULES_MODULE - is there any interest?

Posted: Fri Mar 01, 2013 12:53 am
by 1upnate
if you produce anything functional, i'll use it for my org

Re: RULES_MODULE - is there any interest?

Posted: Mon Mar 18, 2013 2:45 pm
by Captank
Within this week (maybe even in ~4-5 hours) I think I'm done with my last implementation and some tests, and will make a looooong explaining post, to introduce the module and talk a bit about and how to use it.

cap

Re: RULES_MODULE - is there any interest?

Posted: Tue Mar 19, 2013 1:43 am
by Shelly
Nice idea and a good tool to add to the bots. :)

Thanks Cap!

Shelly

Re: RULES_MODULE - is there any interest?

Posted: Tue Mar 19, 2013 9:50 am
by Captank
I'll start explaining the module. I have to test some more stuff, but that I can't do at the moment.

Rules can be set up for different groups.
- admin: obviously all admins of the bot.
- mod: all moderators
- guild: all org members
- member: all guest channel members
- all: actually not all, but the rest.

One rule can be relevant for multiple groups.

Players get notified if they have to sign rules. The notify contains all rules they have to (re-)sign.
Players of the groups admin, mod and guild will get a notify when they log on.
Players of the groups member and all will get a notify when they join the private channel.

You have to sign the rules on every alt as well.

Internally editing the rules stores the time, signing rules stores the time as well. The module will check if there are any rules changes after the sign time, if there are rules that have to be signed.

Editing a rule also stores who changed them.

In fact, you can NOT delete rules. You can set them inactive (means they are not assigned to any groups) and they will get deleted after X days if there were not any changes on them. These X days you can set up, default will be 30 days.

Now to the commands.
!rules
This command will show you all rules that are assigned to your group.
EDIT: At the end of the rules will be the link to sign the rules.

!rules 'id'
This command will show you a specific rule, IF it is assigned to your group. (Except, if you are mod or admin)

!rules search 'keywords'
This command will show you all rules that contain any of the keywords in the rules title or rules text that are assigned to your group. (Except if you are mod or admin) Key words are separated by white spaces.

That it was for the 'user commands'.

EDIT:
!signed characters|all
If the parameter is 'all' is given it will show the sign status of all online players of the groups 'guild', 'mod' and 'admin' and all players if the the groups 'all' and 'member' that are in the private channel.
If you want it for specific players, simply write the names separated by white spaces (Example: !signed Name1 Name2 Name3)

!rulesadmin show [group|inactive] [long]
Without any parameters (besides show) this command will show ALL rules. The rules text will be shortened to the next white space after 25 characters (not sure about the number yet)
If the parameter long is given as well, rules texts doesnt get shortened.
If a group (or 'inactive') is given, it will only show the rules that are assigned to the given group (or the inactive).

!rulesadmin add 'title' 'text'
This command will create a new rule the first word will be the rules title, the rest the rules text. If you want more than one word as the title you need to surround it by single or double quotes (Example !rulesadmin add 'the title' a random and senseless text)

!rulesadmin edit 'id' groups|title|text [text]
If the parameter is 'groups' the bot will send you a formular with the current assigned rules and links to assign to or remove from a group.
If the parameter is 'title' the text will be set as the new rules title. Same goes for 'text'

!rulesadmin rem 'id'
This command actually just removes all relations to any groups.

Well, that's it for now.

EDIT: Tested it now, here the link to the repo:
https://github.com/Captank/RULES_MODULE/

Any questions, hints, critics?
(Either toss it here or catch me in #budabot on funcoms irc server)

cap

PS: please excuse my english (it sucks badly >.<)

Re: RULES_MODULE - is there any interest?

Posted: Mon Mar 25, 2013 6:18 pm
by Captank
Woops, there was a misbehavior on logon, priv channel join and !rules cmd. Rules were shortened.
Thats and a typo got fixed.

Seems noone is actually using it yet, tho ='(

cap

Re: RULES_MODULE - is there any interest?

Posted: Thu Apr 18, 2013 2:26 am
by 1upnate
downloading now :) will test it on my own bot and if i like it, i'll fully incorporate it into my org's bot

Re: RULES_MODULE - is there any interest?

Posted: Sat Apr 20, 2013 9:26 pm
by Shelly
Hey Cap :)

Just downloaded it also and playing with it. :)

Shelly