mirror of
				https://github.com/fluffle/goirc
				synced 2025-11-04 12:08:03 +00:00 
			
		
		
		
	Document commands and flags
This commit is contained in:
		
							parent
							
								
									e0cf7e3917
								
							
						
					
					
						commit
						8b3845d216
					
				
					 1 changed files with 31 additions and 1 deletions
				
			
		
							
								
								
									
										32
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										32
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -18,6 +18,36 @@ rbot.conf and auth.conf will be copied. Configure those and then run the bot:
 | 
			
		|||
 | 
			
		||||
	./rbot
 | 
			
		||||
 | 
			
		||||
### Misc.
 | 
			
		||||
### Commands
 | 
			
		||||
 | 
			
		||||
All commands are prefixed with the trigger configured in rbot.conf.
 | 
			
		||||
 | 
			
		||||
`tr text`: detect the language of text
 | 
			
		||||
`tr en|ja en|es text`: translate text into Japanese and Spanish
 | 
			
		||||
`flags raylu`: get's raylu's flags
 | 
			
		||||
`flags`: get's the flags of the user executing the command
 | 
			
		||||
`add john t`: gives john the t flag
 | 
			
		||||
`remove john t`: removes the t flag from john
 | 
			
		||||
`remove john`: removes all of john's flags
 | 
			
		||||
`topic text`: sets the topic and basetopic to text
 | 
			
		||||
`topic`: gets the current basetopic
 | 
			
		||||
`appendtopic text`: if the topic does not starts with basetopic, sets the basetopic to the current topic. Makes the topic basetopic+text.
 | 
			
		||||
`say text`: says text to the channel
 | 
			
		||||
 | 
			
		||||
Commands that don't require access behave the same when sent to a channel the bot is in and when whispered to the bot. Commands that require access are listed above as if they were sent to a channel. When sent as a whisper, the first argument must be a channel name.
 | 
			
		||||
 | 
			
		||||
### Flags
 | 
			
		||||
 | 
			
		||||
Access is configured in auth.conf and based on ident and host; nick is ignored. The owner is configured per server and other access is configured per channel. Owners can use any commands.
 | 
			
		||||
 | 
			
		||||
The following is a description of the commands enabled by each flag:
 | 
			
		||||
 | 
			
		||||
`a`: add remove
 | 
			
		||||
`t`: topic appendtopic
 | 
			
		||||
`s`: say
 | 
			
		||||
 | 
			
		||||
In addition, a user must have _some_ access to use `flags`.
 | 
			
		||||
 | 
			
		||||
### Miscellaneous
 | 
			
		||||
 | 
			
		||||
This project was forked from jessta/goirc which is in turn forked from fluffle/goirc. Both of those projects are focused on developing the goirc framework whereas this is focused on developing a bot.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue