Skip to content
Snippets Groups Projects
Commit 84278e60 authored by Rob Swindell's avatar Rob Swindell :speech_balloon:
Browse files

Merge branch 'massive-mrc-update-20250303' into 'master' 

MRC Change List on 3/3/2025:

See merge request !517
parents f08ee496 cb30ad1a
No related branches found
No related tags found
1 merge request!517MRC Change List on 3/3/2025:
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 459 additions and 196 deletions
xtrn/mrc/mrc-client.example.ini
+ 9
− 4
View file @ 84278e60
......@@ -5,10 +5,15 @@ ping_interval = 60
[startup]
room = lobby
motd = true
banners = true
commands =
splash = true
[aliases]
[client]
;change this to true if you want show the nick list on connect.
show_nicks=false
[theme]
[msg_color]
[show_nicks]
[twit_list]
xtrn/mrc/mrc-client.js
+ 277
− 90
View file @ 84278e60
This diff is collapsed.
xtrn/mrc/mrc-connector.js
+ 12
− 11
View file @ 84278e60
......@@ -28,8 +28,8 @@ f = undefined;
if (!settings.ssl)
settings.ssl=false;
const PROTOCOL_VERSION = '1.3.1';
const MAX_LINE = 256;
const PROTOCOL_VERSION = '1.3.2';
const MAX_LINE = 512;
const FROM_SITE = system.name.replace(/ /g, "_");
const SYSTEM_NAME = system_info.system_name || system.name;
......@@ -221,8 +221,10 @@ function mrc_receive(sock) {
line = sock.recvline(MAX_LINE, settings.timeout);
if (!line || line == '') break;
latency_tracker.forEach(function(m) {
if (m.line===line.trim()) {
if (m.line===line.trim() ||
(m.line.indexOf("~STATS") >= 0 && line.indexOf("~STATS") >= 0 ) ) {
client_send({ from_user: "SERVER", to_user: 'CLIENT', body: 'LATENCY:' + (Date.now() - m.time) });
log(LOG_DEBUG, 'Latency: ' + (Date.now() - m.time) );
latency_tracker = [];
}
});
......@@ -239,14 +241,12 @@ function mrc_receive(sock) {
fMa.write(message.body.substr(message.body.indexOf(':')+1).trim());
fMa.close();
}
if (['', 'ALL', FROM_SITE].indexOf(message.to_site) > -1) {
if (['', 'CLIENT', 'ALL', 'NOTME'].indexOf(message.to_user) > -1) {
// Forward to all clients
client_send(message);
} else {
// Send to this user
client_send(message, message.to_user);
}
if (['', 'CLIENT', 'ALL', 'NOTME'].indexOf(message.to_user) > -1) {
// Forward to all clients
client_send(message);
} else {
// Send to this user
client_send(message, message.to_user);
}
yield();
}
......@@ -274,6 +274,7 @@ function main() {
Object.keys(clients).forEach(function (e, i) {
if (!clients[e].socket.is_connected) {
mrc_send(mrc_sock, clients[e].username, "", "NOTME", "", "", "|07- |12" + clients[e].username + " |04has left chat|08.");
mrc_send(mrc_sock, clients[e].username, '', 'SERVER', '', '', 'LOGOFF');
client_send({ from_user: clients[e].username, to_user: 'SERVER', body: 'LOGOFF' }); // Notify local clients
delete clients[e];
......
xtrn/mrc/mrc-help-main.msg 0 → 100644
+ 21
− 0
View file @ 84278e60
NB__[ HWList of available commandsN: B]_____________________________
WH/CinfoNHK:N View information about a BBSHK:N H/CinfoN H#
WH/Ct Kor W/CmsgK:N Send a direct messageHK:NH/CtN HnickN HBmessage
WH/CrNHK:N Reply to last direct messageHK:N H/CrB message
WH/CjoinNHK:N Move to a new roomHK:W/CjoinN Hroom_name
WH/CtopicNHK:N Change room topic:H/CtopicW topic
WH/CroomsNHK:N List available rooms
WH/CusersNHK:N List users
WH/CwhoonNHK:N List users and BBSes
WH/CmotdNHK:N Display the Message of the Day
WH/Cscroll Kor CPGUPK:N Scroll the chat window
WH/Cmentions Kor CUPK:N Reset mention counter and review mentions
WH/Cscroll_nicksN HK:N Scroll the nicklist
WH/Ctoggle_nicksN HK:N Show/hide the nicklist
WH/Ctoggle_statsN HK:N Toggle MRC stats view
WH/CthemeNHK:N Select a theme HK..........N seeHK:N H/ChelpN Htheme
WH/CtwitNHK:N Twit List management HK....N seeHK:N H/ChelpN Htwit
WH/CquitNHK:N Exit the program
WHCLEFTK/CRIGHTWK:N Change your text color HK..N seeHK:N H/ChelpN Hnick
WHCCTRLK+CDNHK:N Clear the input line
NFor a list of additional HSERVERN commands, see H/CquoteN Hhelp
\ No newline at end of file
xtrn/mrc/mrc-help-nick.msg 0 → 100644
+ 12
− 0
View file @ 84278e60
NB__[ HWNick customization optionsN: B]_____________________________
HW/Cnick_prefix K:W NSet a single-character prefix for your handle
Neg.H /Cnick_prefixN H@
WH/Cnick_colorN HK:W NSet your nick color
HNG02HW NC03HW NR04HW NM05HW NY06HW B09W G10W C11W R12M 13W Y14W 15
WH/Cnick_suffix K:W NSet an eight-character suffix for your handle
Neg.H N/HCnick_suffix W<afilz>
N You can include pipe color codes in your nick_prefix and
N nick_suffix. Get as creative as you want!
HB NExample: HB@CUserNameB<GaFiLZB>
xtrn/mrc/mrc-help-theme.msg 0 → 100644
+ 5
− 0
View file @ 84278e60
NB__[ HWHow to set a custom themeN: B]______________________________
N Usage:
WH/Ctheme NHnameoftheme
N
\ No newline at end of file
xtrn/mrc/mrc-help-twit.msg 0 → 100644
+ 10
− 0
View file @ 84278e60
NB__[ HWHow to use the twit listN: B]_______________________________
N Basic twit list implemented! Hides messages from problematic
N chatters.
N Usage:
WH/Ctwit NHadd HBnameoftwit K:W NFilters out nameoftwit's messages
WH/Ctwit NHdel HBnameoftwit K:W Nnameoftwit's messages are re-allowed
WH/Ctwit NHlist K:W NLists twits the user has added
WH/Ctwit NHclear K:W NEmpty's the user's twit list
xtrn/mrc/mrc-session.js
+ 76
− 82
View file @ 84278e60
......@@ -16,7 +16,10 @@ function MRC_Session(host, port, user, pass, alias) {
alias: alias || user,
stats: ['-','-','-','0'],
mention_count: 0,
latency: '-'
latency: '-',
msg_color: 7,
twit_list: [],
last_private_msg_from: ""
};
const callbacks = {
......@@ -41,10 +44,10 @@ function MRC_Session(host, port, user, pass, alias) {
function send_message(to_user, to_room, body) {
if (body.length + state.alias.length + 1 > 250) {
word_wrap(body, 250 - 1 - state.alias.length).split(/\n/).forEach(function (e) {
send(to_user, '', to_room, state.alias + ' ' + e);
send(to_user, '', to_room, state.alias + ' ' + format("|%02d", state.msg_color) + e);
});
} else {
send(to_user, '', to_room, state.alias + ' ' + body);
send(to_user, '', to_room, state.alias + ' ' + format("|%02d", state.msg_color) + body);
}
}
......@@ -80,7 +83,7 @@ function MRC_Session(host, port, user, pass, alias) {
break;
case 'STATS':
state.stats = params.split(' ');
emit('stats'); //, state.stats);
emit('stats');
break;
case 'LATENCY':
state.latency = params;
......@@ -90,6 +93,10 @@ function MRC_Session(host, port, user, pass, alias) {
emit('message', msg);
break;
}
if (msg.body.search(/just joined room/) > -1 ||
msg.body.search(/session has timed-out/) > -1) {
send_command('USERLIST', 'ALL');
}
} else if (msg.to_user == 'SERVER') {
if (msg.body == 'LOGOFF') {
uidx = state.nicks.indexOf(msg.from_user);
......@@ -97,8 +104,13 @@ function MRC_Session(host, port, user, pass, alias) {
state.nicks.splice(uidx, 1);
emit('nicks', state.nicks);
}
}
}
} else if (msg.to_user == '' || user.toLowerCase() == msg.to_user.toLowerCase()) {
if (user.toLowerCase() == msg.to_user.toLowerCase()) {
state.last_private_msg_from = msg.from_user;
}
if (msg.to_room == '' || msg.to_room == state.room) {
emit('message', msg);
}
......@@ -112,9 +124,9 @@ function MRC_Session(host, port, user, pass, alias) {
state.nicks.splice(uidx, 1);
emit('nicks', state.nicks);
}
} else if (msg.body.search(/just joined room/) > -1) {
send_command('USERLIST', 'ALL');
}
} /*else if (msg.body.search(/just joined room/) > -1) {
send_command('USERLIST', 'ALL'); // moved above to msg.from_user == 'SERVER'
}*/
emit('message', msg);
}
}
......@@ -122,6 +134,10 @@ function MRC_Session(host, port, user, pass, alias) {
this.send_room_message = function (msg) {
send_message('', state.room, msg);
}
this.send_notme = function (msg) {
send("NOTME", "", "", msg);
}
this.send_private_messsage = function (user, msg) {
msg = '|11(|03Private|11)|07 ' + msg;
......@@ -140,7 +156,11 @@ function MRC_Session(host, port, user, pass, alias) {
password: pass,
alias: state.alias
}) + '\r\n');
this.send_command('IAMHERE');
mswait(20);
this.send_command('USERLIST', 'ALL');
mswait(20);
this.send_command('STATS', 'ALL');
}
......@@ -181,50 +201,53 @@ function MRC_Session(host, port, user, pass, alias) {
}
const commands = {
banners: {
help: 'List of banners from server' // Doesn't do anything?
},
chatters: {
help: 'List current users'
},
bbses: {
help: 'List connected BBSs',
command: 'CONNECTED'
},
// This section has been cleaned up significantly.
//
// Server commands no longer need to be strictly defined
// here.
//
// Some commands are still defined if they have specific
// function calls attached to them in mrc-client.js
// (e.g. /motd) and or are local command shortcuts
// (e.g. /t and /r).
//
// Any command not defined here (or in mrc-client.js) will
// be assumed to be a server command. The server will
// inform the user if a command is invalid.
//
// The "help" properties are no longer needed, since
// help is contained in external .msg file. They have been
// left commended out to provide reference.
//
help: {
help: 'Display this help message',
//help: 'Display this help message',
callback: function (str) {
emit('help', 'List of available commands:', '');
for (var c in commands) {
emit('help', c, commands[c].help, commands[c].ars);
}
emit('local_help');
emit('local_help', str);
}
},
info: {
help: 'View information about a BBS (/info #)',
//help: 'View information about a BBS (/info #)',
callback: function (str) {
this.send_command('INFO ' + str);
}
},
join: {
help: 'Move to a new room: /join room_name',
join: {
//help: 'Move to a new room: /join room_name',
callback: function (str) { // validate valid room name?
str = str.replace(/^#/, '');
str = str.replace(/^#/, '');
this.send_command(format('NEWROOM:%s:%s', state.room, str));
state.room = str;
state.nicks = [];
this.send_command('USERLIST', 'ALL');
}
},
meetups: {
help: 'Display information about upcoming meetups'
},
motd: {
help: 'Display the Message of the Day'
//help: 'Display the Message of the Day'
},
msg: {
help: 'Send a private message: /msg nick message goes here',
msg: { // This is largely overtaken by /t, but we'll still handle it.
//help: 'Send a private message: /msg nick message goes here',
callback: function (str) {
const cmd = str.split(' ');
if (cmd.length > 1 && state.nicks.indexOf(cmd[0]) > -1) {
......@@ -232,8 +255,8 @@ function MRC_Session(host, port, user, pass, alias) {
}
}
},
t: { // added as shorthand for /msg
help: 'Shorthand for /msg: /t nick message goes here',
t: {
//help: 'Send a private message: /t nick message goes here',
callback: function (str) {
const cmd = str.split(' ');
if (cmd.length > 1 && state.nicks.indexOf(cmd[0]) > -1) {
......@@ -241,70 +264,41 @@ function MRC_Session(host, port, user, pass, alias) {
}
}
},
r: {
//help: 'Reply to last private message: /r message goes here',
callback: function (str) {
if (state.last_private_msg_from) {
this.send_private_messsage(state.last_private_msg_from, str);
}
}
},
quote: {
help: 'Send a raw command to the server',
//help: 'Send a raw command to the server',
callback: function (str) {
this.send_command(str);
}
},
quit: {
help: 'Quit the program',
//help: 'Quit the program',
callback: function () {
handle.close();
emit('disconnect');
handle.close();
}
},
rooms: {
help: 'List available rooms',
//help: 'List available rooms',
command: 'LIST'
},
stats: {
help: 'Return anonymous server stats',
//help: 'Return anonymous server stats',
command: 'statistics'
},
topic: {
help: 'Change the topic of the current room',
//help: 'Change the topic of the current room',
callback: function (str) {
this.send_command(format('NEWTOPIC:%s:%s', state.room, str));
}
},
users: {
help: 'Display list of users'
},
whoon: {
help: 'Display list of users and BBSs'
},
afk: {
help: "Set yourself AFK (Shortcut for STATUS AFK)",
callback: function (str) {
this.send_command('AFK ' + str);
}
},
register: {
help: "Register handle on server (MRC Trust)",
callback: function (str) {
this.send_command('REGISTER ' + str);
}
},
identify: {
help: "Identify as a registered user (MRC Trust)",
callback: function (str) {
this.send_command('IDENTIFY ' + str);
}
},
update: {
help: "Update user registration (MRC Trust)",
callback: function (str) {
this.send_command('UPDATE ' + str);
}
},
trust: {
help: "MRC Trust Info (MRC Trust)",
callback: function (str) {
this.send_command('TRUST ' + str);
}
}
}
};
Object.keys(commands).forEach(function (e) {
......@@ -312,11 +306,11 @@ function MRC_Session(host, port, user, pass, alias) {
this[e] = commands[e].callback;
} else if (commands[e].command) {
this[e] = function () {
this.send_command(commands[e].command.toUpperCase());
this.send_command(commands[e].command);
}
} else {
this[e] = function () {
this.send_command(e.toUpperCase());
this.send_command(e);
}
}
}, this);
......
xtrn/mrc/mrc-splash.msg 0 → 100644
+ 8
− 0
View file @ 84278e60
NHK.N HK.N . HK~N HK~N HK~N HK.N HK~N HK~N HK.N HK~N HK~N HK~N HK~N HK.N HK~N HK~N HK~N . HK.N HK.
N HK.N HK.N . H.N HB88888b.d88b.N HB888d888 .d8888b W.N .HK .N HK.
.N .HK W.K NB.W B8H88N HB"888N HB"88b NB8H88P"NB dH88P"NB.HK W.N . HK.
N.HK W.K NB.W B.W B8H88N B8H88 NB8H88 NB8H88NB8H88NB.W B.HK W.N .
HK . N.HK W.K NB.W B8H88N B8H88 NB8H88 NB8H88NBY8H8b.NB.HK W.N . HK.
. .N . H.N B8H88N B8H88 NB8H88 NB8H88NB"Y8H888 W.N . HK.N HK.
` .N HK.N HK=N==H=========================N==HK=N HK.N HK. '
NHK-=[N HCMNCulti HRNCelay HCNChat forW HCSynchronetN HK]=-
xtrn/mrc/readme.txt
+ 29
− 9
View file @ 84278e60
......@@ -60,7 +60,6 @@ colour codes are permitted:
http://wiki.mysticbbs.com/doku.php?id=displaycodes#color_codes_pipe_colors
I may write a CTRL-A to pipe converter at some later date.
mrc-connector.ini:
......@@ -77,11 +76,16 @@ mrc-client.ini:
above instructions while editing '/sbbs/ctrl/services.ini'.
- The 'ping_interval' setting should be left at the default value unless you
have a good reason for changing it.
- The values in the [startup] section determine which room the client joins
on startup, and whether the Message of the Day and banners are displayed.
- Change show_nicks in the [client] section to always display the nick list
when connecting to the MRC server.
- The values in the [startup] section control the following:
room: Which room the client joins on startup.
motd: Whether the Message of the Day is displayed.
commands: Any additional commands to execute, eg: "chatters" to display
the list of active users in the room on startup. Use commas
to separate multiple commands.
splash: Whether the "Multi Relay Chat for Synchronet" splash is shown
on startup.
- The [aliases], [theme], [msg_color], [show_nicks], and [twit_list] sections
are for user settings which get added or updated any time a user uses them.
4) MRC Stats
......@@ -123,19 +127,35 @@ see "Yes" next to your BBS in the SSL column.
6) Themes
MRC comes with several customizable theme files. These can be added/edited as
the system wishes. The client automatically detects any available theme files
the sysop wishes. The client automatically detects any available theme files
matching the pattern:
mrc-theme-<theme_name>.ini
Available themes are listed in /help. User selects a theme by typing
Available themes are listed in /help theme. User selects a theme by typing
/theme <name>, and the selected theme gets saved to settings for future
sessions.
If a theme file is not available, the classic blue theme gets used by default.
To customize the splash that gets shown on startup, edit the mrc-splash.msg
file. Or just disable it by setting splash = false in mrc-client.ini
7) Support
7) Known issues
- Outgoing messages beginning with a semicolon do not get sent out to the MRC
server. For example, a winking face emoticon: ;) or ;-)
This is because the ; character is used by the inputline.js library to
indicate the start of a sysop command. In the case of the MRC client, such
text is simply ignored and does not get sent over.
As a workround, you may simply insert a space in front of the message you
want to send that starts with a semicolon.
8) Support
- Post a message to 'echicken' in the Synchronet Sysops area on DOVE-Net
- Find me on irc.synchro.net in #synchronet
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment