2014-08-02 12:13:58 +00:00
|
|
|
# Shout [](https://www.npmjs.org/package/shout)
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-17 15:17:18 +00:00
|
|
|
### [Try the Shout client](http://shout-irc.com:9000/)
|
2014-07-20 23:14:36 +00:00
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
2014-08-13 01:27:53 +00:00
|
|
|
```
|
|
|
|
|
sudo npm install -g shout
|
|
|
|
|
```
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-13 01:27:53 +00:00
|
|
|
## Usage
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-13 01:27:53 +00:00
|
|
|
When the install is complete, go ahead and start the server:
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-13 01:27:53 +00:00
|
|
|
```
|
2014-08-17 15:40:28 +00:00
|
|
|
shout
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For more information:
|
|
|
|
|
```
|
|
|
|
|
shout --help
|
2014-08-13 01:27:53 +00:00
|
|
|
```
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-17 15:17:18 +00:00
|
|
|
## Screenshot
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-17 15:40:28 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
Open your `config.json` file and edit:
|
|
|
|
|
|
|
|
|
|
__port__
|
|
|
|
|
The default port to be used.
|
|
|
|
|
You can override this by running `shout --port 80`
|
|
|
|
|
|
|
|
|
|
__public__
|
|
|
|
|
Set to either `true|false`.
|
|
|
|
|
When set to `false`, a login will be required for connecting users.
|
2014-07-20 23:14:36 +00:00
|
|
|
|
2014-08-17 22:05:27 +00:00
|
|
|
## User Management
|
|
|
|
|
|
|
|
|
|
Go ahead and run `shout --help`:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Usage: shout [options] [command]
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
|
|
|
|
|
list
|
|
|
|
|
List all existing users
|
|
|
|
|
|
|
|
|
|
add <name>
|
|
|
|
|
Add a new user
|
|
|
|
|
|
|
|
|
|
remove <name>
|
|
|
|
|
Remove an existing user
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Pretty simple, huh?
|
|
|
|
|
|
|
|
|
|
If you want to edit users manually, see `users/example/user.json`.
|
|
|
|
|
|
2014-08-17 15:40:28 +00:00
|
|
|
## Commands
|
2014-07-20 23:14:36 +00:00
|
|
|
|
|
|
|
|
These are the commands currently implemented:
|
|
|
|
|
|
|
|
|
|
- [x] /close
|
|
|
|
|
- [x] /connect
|
|
|
|
|
- [x] /deop
|
|
|
|
|
- [x] /devoice
|
|
|
|
|
- [x] /disconnect
|
|
|
|
|
- [x] /invite
|
|
|
|
|
- [x] /join
|
|
|
|
|
- [x] /kick
|
|
|
|
|
- [x] /leave
|
|
|
|
|
- [x] /me
|
|
|
|
|
- [x] /mode
|
|
|
|
|
- [x] /msg
|
|
|
|
|
- [x] /nick
|
|
|
|
|
- [x] /notice
|
|
|
|
|
- [x] /op
|
|
|
|
|
- [x] /part
|
|
|
|
|
- [x] /query
|
|
|
|
|
- [x] /quit
|
|
|
|
|
- [x] /raw
|
|
|
|
|
- [x] /say
|
|
|
|
|
- [x] /send
|
|
|
|
|
- [x] /server
|
|
|
|
|
- [x] /slap
|
|
|
|
|
- [x] /topic
|
|
|
|
|
- [x] /voice
|
|
|
|
|
- [x] /whois
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Available under [the MIT license](http://mths.be/mit).
|
