Commit d83fb24c authored by Justin Mitchell's avatar Justin Mitchell
Browse files

Suggested protocol for who listings

parent 7b627813
Loading
Loading
Loading
Loading
+24 −9
Original line number Diff line number Diff line
@@ -96,23 +96,38 @@ IPC_EVENT - an event occured
		verbose - additional (amusing) texts
		reason 	- justification (if any) the attacker gave

IPC_ACTION - user requests an action
	Body: (json)
		type - type of event that occured
		target - (optional) who to apply it to
		reason - (optional) reason why you did this
	List of types, and any additional fields
		zod   - Zebedee of Death
		mrod  - Magic Roundabout of Death
		gag   - Apply gagging filter to user
			gag - name of gag to Apply
		ungag - remove gagging filters

IPC_ACTION - user requests an action
	Body: (json)
		type - type of event that occured
		target - who did the event happen to
		reason - optional reason why you did this
	Response:
		type - command request
		target - victim
		success=0|1
		text - prefered acknowledgement text

IPC_WHOLIST - list of all the users currently known to the system
	Send an empty body one of these to the server to request a refresh
	Respose:  json array() each element being one session
		pid	 - session idle
		id	 - user id
		name     - username
		realname - users actual name (if permitted)
		idle	 - seconds idle
		doing    - doing info
		dowhen   - when doing last updated
		perms    - object of permissions
			chatmode
			chatprivs
			protection


all other codes are old unformatted messages and are to be phased out,
most commonly used is IPC_TEXT which is raw text to be displayed