`
);
}
onComplete(player) {
if (player.completed)
return false;
const now = Date.now();
const time = Chat.toDurationString(now - this.startTime, { hhmmss: true });
const canBlitz = this.completed.length < 3;
const blitz = now - this.startTime <= 6e4 && canBlitz && (this.room.settings.scavSettings?.blitzPoints?.[this.gameType] || DEFAULT_BLITZ_POINTS[this.gameType]);
player.completed = true;
let result = this.runEvent("Complete", player, time, blitz);
if (result === true)
return;
result = result || { name: player.name, time, blitz };
this.completed.push(result);
const place = import_lib.Utils.formatOrder(this.completed.length);
const completionMessage = this.runEvent("ConfirmCompletion", player, time, blitz, place, result);
this.announce(
completionMessage || import_lib.Utils.html`${result.name} has finished the hunt in ${place} place! (${time}${blitz ? " - BLITZ" : ""})`
);
player.destroy();
}
onShowEndBoard(endedBy) {
const sliceIndex = this.gameType === "official" ? 5 : 3;
const hosts = Chat.toListString(this.hosts.map((h) => `${import_lib.Utils.escapeHTML(h.name)}`));
this.announce(
`The ${this.gameType ? `${this.gameType} ` : ""}scavenger hunt by ${hosts} was ended ${endedBy ? "by " + import_lib.Utils.escapeHTML(endedBy.name) : "automatically"}. ${this.completed.slice(0, sliceIndex).map((p, i) => `${import_lib.Utils.formatOrder(i + 1)} place: ${import_lib.Utils.escapeHTML(p.name)}[${p.time}]. `).join("")}${this.completed.length > sliceIndex ? `Consolation Prize: ${this.completed.slice(sliceIndex).map((e) => `${import_lib.Utils.escapeHTML(e.name)}[${e.time}]`).join(", ")} ` : ""} Solution: ${this.questions.map((q, i) => `${i + 1}) ${Chat.formatText(q.hint)} [${import_lib.Utils.escapeHTML(q.answer.join(" / "))}]`).join(" ")}`
);
}
onEnd(reset, endedBy) {
if (!endedBy && (this.preCompleted ? this.preCompleted.length : this.completed.length) === 0) {
reset = true;
}
this.runEvent("End", reset);
if (!ScavengerHuntDatabase.isEmpty() && this.room.settings.scavSettings?.addRecycledHuntsToQueueAutomatically) {
if (!this.room.settings.scavQueue)
this.room.settings.scavQueue = [];
const next = ScavengerHuntDatabase.getRecycledHuntFromDatabase();
const correctlyFormattedQuestions = next.questions.flatMap((question) => [question.text, question.answers]);
this.room.settings.scavQueue.push({
hosts: next.hosts,
questions: correctlyFormattedQuestions,
staffHostId: "scavengermanager",
staffHostName: "Scavenger Manager",
gameType: "unrated"
});
}
if (!reset) {
if (!this.runEvent("ShowEndBoard", endedBy))
this.onShowEndBoard(endedBy);
if (!this.runEvent("GivePoints")) {
const winPoints = this.room.settings.scavSettings?.winPoints?.[this.gameType] || DEFAULT_POINTS[this.gameType];
const blitzPoints = this.room.settings.scavSettings?.blitzPoints?.[this.gameType] || DEFAULT_BLITZ_POINTS[this.gameType];
let hostPoints;
if (this.gameType === "regular") {
hostPoints = this.room.settings.scavSettings?.hostPoints ? this.room.settings.scavSettings?.hostPoints : DEFAULT_HOST_POINTS;
}
let didSomething = false;
if (winPoints || blitzPoints) {
for (const [i, completed] of this.completed.entries()) {
if (!completed.blitz && i >= winPoints.length)
break;
const name = completed.name;
if (winPoints[i])
Leaderboard.addPoints(name, "points", winPoints[i]);
if (blitzPoints && completed.blitz)
Leaderboard.addPoints(name, "points", blitzPoints);
}
didSomething = true;
}
if (hostPoints) {
if (this.hosts.length === 1) {
Leaderboard.addPoints(this.hosts[0].name, "points", hostPoints, this.hosts[0].noUpdate);
didSomething = true;
} else {
this.room.sendMods("|notify|A scavenger hunt with multiple hosts needs points!");
this.room.sendMods("(A scavenger hunt with multiple hosts has ended.)");
}
}
if (didSomething)
Leaderboard.write();
}
this.onTallyLeaderboard();
this.tryRunQueue(this.room.roomid);
} else if (endedBy) {
this.announce(`The scavenger hunt has been reset by ${endedBy.name}.`);
} else {
this.announce("The hunt has been reset automatically, due to the lack of finishers.");
this.tryRunQueue(this.room.roomid);
}
this.runEvent("AfterEnd", reset);
this.destroy();
}
onTallyLeaderboard() {
for (const p in this.playerTable) {
const player = this.playerTable[p];
PlayerLeaderboard.addPoints(player.name, "join", 1);
if (player.completed)
PlayerLeaderboard.addPoints(player.name, "finish", 1);
}
for (const id in this.leftHunt) {
if (id in this.playerTable)
continue;
PlayerLeaderboard.addPoints(id, "join", 1, true);
}
if (this.gameType !== "practice") {
for (const host of this.hosts) {
HostLeaderboard.addPoints(host.name, "points", 1, host.noUpdate).write();
}
}
PlayerLeaderboard.write();
}
tryRunQueue(roomid) {
if (this.room.scavgame || this.room.settings.scavSettings?.scavQueueDisabled) {
return;
}
if (this.room.settings.scavQueue && this.room.settings.scavQueue.length) {
setTimeout(() => {
const room = Rooms.get(roomid);
if (!room || room.game || !room.settings.scavQueue?.length || room.settings.scavSettings?.scavQueueDisabled)
return;
const next = room.settings.scavQueue.shift();
const duration = room.settings.scavSettings?.defaultScavTimer || DEFAULT_TIMER_DURATION;
room.game = new ScavengerHunt(
room,
{ id: next.staffHostId, name: next.staffHostName },
next.hosts,
next.gameType,
next.questions
);
const game = room.getGame(ScavengerHunt);
if (game) {
game.setTimer(duration);
room.add(`|c|~|[ScavengerManager] A scavenger hunt by ${Chat.toListString(next.hosts.map((h) => h.name))} has been automatically started. It will automatically end in ${duration} minutes.`).update();
}
room.saveSettings();
}, 2 * 6e4);
}
}
// modify destroy to get rid of any timers in the current roomgame.
destroy() {
if (this.timer) {
clearTimeout(this.timer);
}
for (const i in this.playerTable) {
this.playerTable[i].destroy();
}
this.room.game = null;
}
announce(msg) {
this.room.add(`|raw|
${msg}
`).update();
}
validatePlayer(player) {
if (player.infracted)
return false;
if (this.hosts.some((h) => h.id === player.id) || player.id === this.staffHostId) {
player.sendRoom("You have been caught for doing your own hunt; staff has been notified.");
const staffMsg = `(${player.name} has been caught trying to do their own hunt.)`;
this.room.sendMods(staffMsg);
this.room.roomlog(staffMsg);
this.room.modlog({
action: "SCAV CHEATER",
userid: player.id,
note: "caught trying to do their own hunt"
});
PlayerLeaderboard.addPoints(player.name, "infraction", 1);
player.infracted = true;
}
const uniqueConnections = this.getUniqueConnections(player.id);
if (uniqueConnections > 1 && this.room.settings.scavSettings?.scavmod?.ipcheck) {
player.sendRoom("You have been caught for attempting a hunt with multiple connections on your account. Staff has been notified.");
const staffMsg = `(${player.name} has been caught attempting a hunt with ${uniqueConnections} connections on the account. The user has also been given 1 infraction point on the player leaderboard.)`;
this.room.sendMods(staffMsg);
this.room.roomlog(staffMsg);
this.room.modlog({
action: "SCAV CHEATER",
userid: player.id,
note: `caught attempting a hunt with ${uniqueConnections} connections on the account; has also been given 1 infraction point on the player leaderboard`
});
PlayerLeaderboard.addPoints(player.name, "infraction", 1);
player.infracted = true;
}
}
eliminate(userid) {
if (!(userid in this.playerTable))
return false;
const player = this.playerTable[userid];
if (player.completed)
return true;
player.destroy();
delete this.playerTable[userid];
return true;
}
onUpdateConnection() {
}
onChatMessage(msg) {
let msgId = toID(msg);
const commandMatch = ACCIDENTAL_LEAKS.exec(msg);
if (commandMatch)
msgId = msgId.slice(toID(commandMatch[0]).length);
const filtered = this.questions.some((q) => q.answer.some((a) => {
a = toID(a);
const md = Math.ceil((a.length - 5) / FILTER_LENIENCY);
if (import_lib.Utils.levenshtein(msgId, a, md) <= md)
return true;
return false;
}));
if (filtered)
return "Please do not leak the answer. Use /scavenge [guess] to submit your guess instead.";
return;
}
hasFinished(user) {
return this.playerTable[user.id] && this.playerTable[user.id].completed;
}
getUniqueConnections(userid) {
const user = Users.get(userid);
if (!user)
return 1;
const ips = user.connections.map((c) => c.ip);
return ips.filter((ip, index) => ips.indexOf(ip) === index).length;
}
static parseHosts(hostArray, room, allowOffline) {
const hosts = [];
for (const u of hostArray) {
const id = toID(u);
const user = Users.getExact(id);
if (!allowOffline && (!user?.connected || !(user.id in room.users)))
continue;
if (!user) {
hosts.push({ name: id, id, noUpdate: true });
continue;
}
hosts.push({ id: "" + user.id, name: "" + user.name });
}
return hosts;
}
static parseQuestions(questionArray) {
if (questionArray.length % 2 === 1)
return { err: "Your final question is missing an answer" };
if (questionArray.length < 6)
return { err: "You must have at least 3 hints and answers" };
const formattedQuestions = [];
for (let [i, question] of questionArray.entries()) {
if (i % 2) {
const answers = question.split(";").map((p) => p.trim());
formattedQuestions[i] = answers;
if (!answers.length || answers.some((a) => !toID(a))) {
return { err: "Empty answer - only alphanumeric characters will count in answers." };
}
} else {
question = question.trim();
formattedQuestions[i] = question;
if (!question)
return { err: "Empty question." };
}
}
return { result: formattedQuestions };
}
}
class ScavengerHuntPlayer extends Rooms.RoomGamePlayer {
// for purposes of adding new temporary properties for the purpose of twists.
constructor(user, game) {
super(user, game);
this.joinIps = user.ips.slice();
this.currentQuestion = 0;
this.completed = false;
this.lastGuess = 0;
}
getCurrentQuestion() {
return {
question: this.game.questions[this.currentQuestion],
number: this.currentQuestion + 1
};
}
verifyAnswer(value) {
const answer = this.getCurrentQuestion().question.answer;
value = toID(value);
return answer.some((a) => toID(a) === value);
}
onNotifyChange(num) {
this.game.runEvent("NotifyChange", this, num);
if (num === this.currentQuestion) {
this.sendRoom(`|raw|The hint has been changed to: ${Chat.formatText(this.game.questions[num].hint)}`);
}
}
destroy() {
const user = Users.getExact(this.id);
if (user) {
user.games.delete(this.game.roomid);
user.updateSearch();
}
}
}
const ScavengerCommands = {
/**
* Player commands
*/
""() {
return this.parse("/join scavengers");
},
guess(target, room, user) {
return this.parse(`/choose ${target}`);
},
join(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply("There is no scavenger hunt currently running.");
this.checkChat();
game.joinGame(user);
},
leave(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply("There is no scavenger hunt currently running.");
game.leaveGame(user);
},
/**
* Scavenger Games
* --------------
* Individual game commands for each Scavenger Game
*/
game: "games",
games: {
/**
* General game commands
*/
create: "start",
new: "start",
start(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
if (room.scavgame)
return this.errorReply("There is already a scavenger game running.");
if (room.getGame(ScavengerHunt)) {
return this.errorReply("You cannot start a scavenger game where there is already a scavenger hunt in the room.");
}
target = toID(target);
const game = import_scavenger_games.ScavMods.LoadGame(room, target);
if (!game)
return this.errorReply("Invalid game mode.");
room.scavgame = game;
this.privateModAction(`A ${game.name} has been created by ${user.name}.`);
this.modlog("SCAVENGER", null, "ended the scavenger game");
game.announce(`A game of ${game.name} has been started!`);
},
end(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
if (!room.scavgame)
return this.errorReply(`There is no scavenger game currently running.`);
this.privateModAction(`The ${room.scavgame.name} has been forcibly ended by ${user.name}.`);
this.modlog("SCAVENGER", null, "ended the scavenger game");
room.scavgame.announce(`The ${room.scavgame.name} has been forcibly ended.`);
room.scavgame.destroy(true);
},
kick(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
if (!room.scavgame)
return this.errorReply(`There is no scavenger game currently running.`);
const targetId = toID(target);
if (targetId === "constructor" || !targetId)
return this.errorReply("Invalid player.");
const success = room.scavgame.eliminate(targetId);
if (success) {
this.addModAction(`User '${targetId}' has been kicked from the ${room.scavgame.name}.`);
this.modlog("SCAVENGERS", target, `kicked from the ${room.scavgame.name}`);
const game = room.getGame(ScavengerHunt);
if (game) {
game.eliminate(targetId);
}
} else {
this.errorReply(`Unable to kick user '${targetId}'.`);
}
},
points: "leaderboard",
score: "leaderboard",
scoreboard: "leaderboard",
async leaderboard(target, room, user) {
room = this.requireRoom();
if (!room.scavgame)
return this.errorReply(`There is no scavenger game currently running.`);
if (!room.scavgame.leaderboard)
return this.errorReply("This scavenger game does not have a leaderboard.");
if (!this.runBroadcast())
return false;
const html = await room.scavgame.leaderboard.htmlLadder();
this.sendReply(`|raw|${html}`);
},
async rank(target, room, user) {
room = this.requireRoom();
if (!room.scavgame)
return this.errorReply(`There is no scavenger game currently running.`);
if (!room.scavgame.leaderboard)
return this.errorReply("This scavenger game does not have a leaderboard.");
if (!this.runBroadcast())
return false;
const targetId = toID(target) || user.id;
const rank = await room.scavgame.leaderboard.visualize("points", targetId);
if (!rank) {
this.sendReplyBox(`User '${targetId}' does not have any points on the scavenger games leaderboard.`);
} else {
this.sendReplyBox(import_lib.Utils.html`User '${rank.name}' is #${rank.rank} on the scavenger games leaderboard with ${rank.points} points.`);
}
}
},
teamscavs: {
addteam: "createteam",
createteam(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
let [teamName, leader] = target.split(",");
teamName = teamName.trim();
if (game.teams[teamName])
return this.errorReply(`The team ${teamName} already exists.`);
const leaderUser = Users.get(leader);
if (!leaderUser)
return this.errorReply("The user you specified is currently not online");
if (game.getPlayerTeam(leaderUser))
return this.errorReply("The user is already a member of another team.");
game.teams[teamName] = { name: teamName, answers: [], players: [leaderUser.id], question: 1, completed: false };
game.announce(import_lib.Utils.html`A new team "${teamName}" has been created with ${leaderUser.name} as the leader.`);
},
deleteteam: "removeteam",
removeteam(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
if (!game.teams[target])
return this.errorReply(`The team ${target} does not exist.`);
delete game.teams[target];
game.announce(import_lib.Utils.html`The team "${target}" has been removed.`);
},
addplayer(target, room, user) {
room = this.requireRoom();
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
let userTeam;
for (const teamID in game.teams) {
const team = game.teams[teamID];
if (team.players[0] === user.id) {
userTeam = team;
break;
}
}
if (!userTeam)
return this.errorReply("You must be the leader of a team to add people into the team.");
const targetUsers = target.split(",").map((id) => Users.getExact(id)).filter((u) => u?.connected);
if (!targetUsers.length)
return this.errorReply("Please select a user that is currently online.");
const errors = [];
for (const targetUser of targetUsers) {
if (game.getPlayerTeam(targetUser))
errors.push(`${targetUser.name} is already in a team.`);
}
if (errors.length)
return this.sendReplyBox(errors.join(" "));
const playerIDs = targetUsers.map((u) => u.id);
userTeam.players.push(...playerIDs);
for (const targetUser of targetUsers) {
targetUser.sendTo(room, `You have joined ${userTeam.name}.`);
}
game.announce(import_lib.Utils.html`${Chat.toListString(targetUsers.map((u) => u.name))} ${targetUsers.length > 1 ? "have" : "has"} been added into ${userTeam.name}.`);
},
editplayers(target, room, user) {
room = this.requireRoom();
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
this.checkCan("mute", null, room);
const parts = target.split(",");
const teamName = parts[0].trim();
const playerchanges = parts.slice(1);
const team = game.teams[teamName];
if (!team)
return this.errorReply("Invalid team.");
for (const entry of playerchanges) {
const userid = toID(entry);
if (entry.trim().startsWith("-")) {
if (!team.players.includes(userid)) {
this.errorReply(`User "${userid}" is not in team "${team.name}."`);
continue;
} else if (team.players[0] === userid) {
this.errorReply(`You cannot remove "${userid}", who is the leader of "${team.name}".`);
continue;
}
team.players = team.players.filter((u) => u !== userid);
game.announce(`${userid} was removed from "${team.name}."`);
} else {
const targetUser = Users.getExact(userid);
if (!targetUser?.connected) {
this.errorReply(`User "${userid}" is not currently online.`);
continue;
}
const targetUserTeam = game.getPlayerTeam(targetUser);
if (team.players.includes(userid)) {
this.errorReply(`User "${userid}" is already part of "${team.name}."`);
continue;
} else if (targetUserTeam) {
this.errorReply(`User "${userid}" is already part of another team - "${targetUserTeam.name}".`);
continue;
}
team.players.push(userid);
game.announce(`${targetUser.name} was added to "${team.name}."`);
}
}
},
teams(target, room, user) {
if (!this.runBroadcast())
return false;
room = this.requireRoom();
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
const display = [];
for (const teamID in game.teams) {
const team = game.teams[teamID];
display.push(import_lib.Utils.html`${team.name} - ${team.players[0]}${team.players.length > 1 ? ", " + team.players.slice(1).join(", ") : ""}`);
}
this.sendReplyBox(display.join(" "));
},
guesses(target, room, user) {
room = this.requireRoom();
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
const team = game.getPlayerTeam(user);
if (!team)
return this.errorReply("You are not currently part of this Team Scavs game.");
this.sendReplyBox(import_lib.Utils.html`Question #${team.question} guesses: ${team.answers.sort().join(", ")}`);
},
chat: "note",
note(target, room, user) {
room = this.requireRoom();
const game = room.scavgame;
if (!game || game.id !== "teamscavs")
return this.errorReply("There is currently no game of Team Scavs going on.");
const team = game.getPlayerTeam(user);
if (!team)
return this.errorReply("You are not currently part of this Team Scavs game.");
if (!target)
return this.errorReply("Please include a message as the note.");
game.teamAnnounce(user, import_lib.Utils.html` Note from ${user.name}: ${target}`);
}
},
teamscavshelp: [
"/tscav createteam [team name], [leader name] - creates a new team for the current Team Scavs game. (Requires: % @ * # &)",
"/tscav deleteteam [team name] - deletes an existing team for the current Team Scavs game. (Requires: % @ * # &)",
"/tscav addplayer [user] - allows a team leader to add a player onto their team.",
"/tscav editplayers [team name], [added user | -removed user], [...] (use - preceding a user's name to remove a user) - Edits the players within an existing team. (Requires: % @ * # &)",
"/tscav teams - views the list of teams and the players on each team.",
"/tscav guesses - views the list of guesses already submitted by your team for the current question.",
"/tscav chat [message] - adds a message that can be seen by all of your teammates in the Team Scavs game."
],
/**
* Creation / Moderation commands
*/
createtwist: "create",
createtwistofficial: "create",
createtwistmini: "create",
createtwistpractice: "create",
createtwistunrated: "create",
createpractice: "create",
createofficial: "create",
createunrated: "create",
createmini: "create",
forcecreate: "create",
forcecreateunrated: "create",
createrecycled: "create",
create(target, room, user, connection, cmd) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("Scavenger hunts can only be created in the scavengers room.");
}
this.checkCan("mute", null, room);
if (room.game)
return this.errorReply(`There is already a game in this room - ${room.game.title}.`);
let gameType = "regular";
if (cmd.includes("practice")) {
gameType = "practice";
} else if (cmd.includes("official")) {
gameType = "official";
} else if (cmd.includes("mini")) {
gameType = "mini";
} else if (cmd.includes("unrated")) {
gameType = "unrated";
} else if (cmd.includes("recycled")) {
gameType = "recycled";
}
let mod;
let questions = target;
if (cmd.includes("twist")) {
const twistparts = target.split("|");
questions = twistparts.slice(1).join("|");
mod = twistparts[0].split(",");
}
if (!cmd.includes("force") && ["regular", "unrated", "recycled"].includes(gameType) && !mod && room.settings.scavQueue && room.settings.scavQueue.length && !room.scavgame) {
return this.errorReply(`There are currently hunts in the queue! If you would like to start the hunt anyways, use /forcestart${gameType === "regular" ? "hunt" : gameType}.`);
}
if (gameType === "recycled") {
if (ScavengerHuntDatabase.isEmpty()) {
return this.errorReply("There are no hunts in the database.");
}
let hunt;
if (questions) {
const huntNumber = parseInt(questions);
if (!ScavengerHuntDatabase.hasHunt(huntNumber))
return this.errorReply("You specified an invalid hunt number.");
hunt = scavengersData.recycledHunts[huntNumber - 1];
} else {
hunt = ScavengerHuntDatabase.getRecycledHuntFromDatabase();
}
questions = ScavengerHuntDatabase.getFullTextOfHunt(hunt);
}
let [hostsArray, ...params] = questions.split("|");
if (gameType === "recycled") {
hostsArray += `,${user.name}`;
}
const hosts = ScavengerHunt.parseHosts(
hostsArray.split(/[,;]/),
room,
gameType === "official" || gameType === "recycled"
);
if (!hosts.length) {
return this.errorReply("The user(s) you specified as the host is not online, or is not in the room.");
}
const res = ScavengerHunt.parseQuestions(params);
if (res.err)
return this.errorReply(res.err);
room.game = new ScavengerHunt(room, user, hosts, gameType, res.result, mod);
this.privateModAction(`A new scavenger hunt was created by ${user.name}.`);
this.modlog("SCAV NEW", null, `${gameType.toUpperCase()}: creators - ${hosts.map((h) => h.id)}`);
},
status(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
const elapsedMsg = Chat.toDurationString(Date.now() - game.startTime, { hhmmss: true });
const gameTypeMsg = game.gameType ? `${game.gameType} ` : "";
const hostersMsg = import_lib.Utils.escapeHTML(Chat.toListString(game.hosts.map((h) => h.name)));
const hostMsg = game.hosts.some((h) => h.id === game.staffHostId) ? "" : import_lib.Utils.html` (started by - ${game.staffHostName})`;
const finishers = import_lib.Utils.html`${game.completed.map((u) => u.name).join(", ")}`;
let buffer = `
The current ${gameTypeMsg}scavenger hunt by ${hostersMsg}${hostMsg} has been up for: ${elapsedMsg} ${!game.timerEnd ? "The timer is currently off." : `The hunt ends in: ${Chat.toDurationString(game.timerEnd - Date.now(), { hhmmss: true })}`} Completed (${game.completed.length}): ${finishers}
`;
if (game.modsList.includes("timetrial")) {
const finisher = game.completed.find((player) => player.id === user.id);
const timeTrialMsg = finisher ? `You finished the hunt in: ${finisher.time}.` : game.startTimes?.[user.id] ? `You joined the hunt ${Chat.toDurationString(Date.now() - game.startTimes[user.id], { hhmmss: true })} ago.` : "You have not joined the hunt.";
buffer = `
The current ${gameTypeMsg}scavenger hunt by ${hostersMsg}${hostMsg} has been up for: ${elapsedMsg} ${timeTrialMsg} ${!game.timerEnd ? "The timer is currently off." : `The hunt ends in: ${Chat.toDurationString(game.timerEnd - Date.now(), { hhmmss: true })}`} Completed (${game.completed.length}): ${finishers}
`;
}
if (game.hosts.some((h) => h.id === user.id) || game.staffHostId === user.id) {
let str = `
Question
Users on this Question
`;
for (let i = 0; i < game.questions.length; i++) {
const questionNum = i + 1;
const players = Object.values(game.playerTable).filter((player) => player.currentQuestion === i && !player.completed);
if (!players.length) {
str += `
${buffer}`);
}
this.sendReply(`|raw|${buffer}`);
},
hint(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if (!game.onSendQuestion(user, true))
this.errorReply("You are not currently participating in the hunt.");
},
timer(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
const minutes = toID(target) === "off" ? 0 : parseFloat(target);
if (isNaN(minutes) || minutes < 0 || minutes * 60 * 1e3 > Chat.MAX_TIMEOUT_DURATION) {
throw new Chat.ErrorMessage(`You must specify a timer length that is a postive number.`);
}
const result = game.setTimer(minutes);
const message = `The scavenger timer has been ${result === "off" ? "turned off" : `set to ${result} minutes`}`;
room.add(message + ".");
this.privateModAction(`${message} by ${user.name}.`);
this.modlog("SCAV TIMER", null, result === "off" ? "OFF" : `${result} minutes`);
},
inherit(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if (game.staffHostId === user.id)
return this.errorReply("You already have staff permissions for this hunt.");
game.staffHostId = "" + user.id;
game.staffHostName = "" + user.name;
game.eliminate(user.id);
game.cacheUserIps(user);
this.privateModAction(`${user.name} has inherited staff permissions for the current hunt.`);
this.modlog("SCAV INHERIT");
},
reset(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
game.onEnd(true, user);
this.privateModAction(`${user.name} has reset the scavenger hunt.`);
this.modlog("SCAV RESET");
},
resettoqueue(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
const hunt = {
hosts: game.hosts,
questions: [],
staffHostId: game.staffHostId,
staffHostName: game.StaffHostName,
gameType: game.gameType
};
for (const entry of game.questions) {
hunt.questions.push(...[entry.hint, entry.answer]);
}
if (!room.settings.scavQueue)
room.settings.scavQueue = [];
room.settings.scavQueue.push(hunt);
game.onEnd(true, user);
this.privateModAction(`${user.name} has reset the scavenger hunt, and placed it in the queue.`);
this.modlog("SCAV RESETTOQUEUE");
},
forceend: "end",
end(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
if (!room.game && room.scavgame)
return this.parse("/scav games end");
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
const completed = game.preCompleted ? game.preCompleted : game.completed;
if (!this.cmd.includes("force")) {
if (!completed.length) {
return this.errorReply("No one has finished the hunt yet. Use /forceendhunt if you want to end the hunt and reveal the answers.");
}
} else if (completed.length) {
return this.errorReply(`This hunt has ${Chat.count(completed, "finishers")}; use /endhunt`);
}
game.onEnd(false, user);
this.privateModAction(`${user.name} has ended the scavenger hunt.`);
this.modlog("SCAV END");
},
viewhunt(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if (!("onViewHunt" in game))
return this.errorReply("There is currently no hunt to be viewed.");
game.onViewHunt(user);
},
edithunt(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if ((!game.hosts.some((h) => h.id === user.id) || !user.can("show", null, room)) && game.staffHostId !== user.id) {
return this.errorReply("You cannot edit the hints and answers if you are not the host.");
}
const [question, type, ...value] = target.split(",");
if (!game.onEditQuestion(parseInt(question), toID(type), value.join(",").trim())) {
return this.sendReply("/scavengers edithunt [question number], [hint | answer], [value] - edits the current scavenger hunt.");
}
},
addhint: "spoiler",
spoiler(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if ((!game.hosts.some((h) => h.id === user.id) || !user.can("show", null, room)) && game.staffHostId !== user.id) {
return this.errorReply("You cannot add more hints if you are not the host.");
}
const parts = target.split(",");
const question = parseInt(parts[0]) - 1;
const hint = parts.slice(1).join(",");
if (!game.questions[question])
return this.errorReply(`Invalid question number.`);
if (!hint)
return this.errorReply("The hint cannot be left empty.");
game.questions[question].spoilers.push(hint);
room.addByUser(user, `Question #${question + 1} hint - spoiler: ${hint}`);
const playersOnQ = game.players.filter((player) => player.currentQuestion === question && !player.completed);
const notif = `|notify|Scavenger hint for Q${question + 1}`;
for (const player of playersOnQ) {
const playerObj = Users.get(player.id);
if (!playerObj?.connected)
continue;
room.sendUser(playerObj, notif);
}
},
deletehint: "removehint",
removehint(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if ((!game.hosts.some((h) => h.id === user.id) || !user.can("show", null, room)) && game.staffHostId !== user.id) {
return this.errorReply("You cannot remove hints if you are not the host.");
}
const parts = target.split(",");
const question = parseInt(parts[0]) - 1;
const hint = parseInt(parts[1]) - 1;
if (!game.questions[question])
return this.errorReply(`Invalid question number.`);
if (!game.questions[question].spoilers[hint])
return this.errorReply("Invalid hint number.");
game.questions[question].spoilers.splice(hint, 1);
return this.sendReply("Hint has been removed.");
},
modifyhint: "edithint",
edithint(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
if ((!game.hosts.some((h) => h.id === user.id) || !user.can("show", null, room)) && game.staffHostId !== user.id) {
return this.errorReply("You cannot edit hints if you are not the host.");
}
const parts = target.split(",");
const question = parseInt(parts[0]) - 1;
const hint = parseInt(parts[1]) - 1;
const value = parts.slice(2).join(",");
if (!game.questions[question])
return this.errorReply(`Invalid question number.`);
if (!game.questions[question].spoilers[hint])
return this.errorReply("Invalid hint number.");
if (!value)
return this.errorReply("The hint cannot be left empty.");
game.questions[question].spoilers[hint] = value;
room.addByUser(user, `Question #${question + 1} hint - spoiler: ${value}`);
const playersOnQ = game.players.filter((player) => player.currentQuestion === question && !player.completed);
const notif = `|notify|Scavenger hint for Q${question + 1}`;
for (const player of playersOnQ) {
const playerObj = Users.get(player.id);
if (!playerObj?.connected)
continue;
room.sendUser(playerObj, notif);
}
return this.sendReply("Hint has been modified.");
},
kick(target, room, user) {
room = this.requireRoom();
const game = room.getGame(ScavengerHunt);
if (!game)
return this.errorReply(`There is no scavenger hunt currently running.`);
const targetId = toID(target);
if (targetId === "constructor" || !targetId)
return this.errorReply("Invalid player.");
const success = game.eliminate(targetId);
if (success) {
this.modlog("SCAV KICK", targetId);
return this.privateModAction(`${user.name} has kicked '${targetId}' from the scavenger hunt.`);
}
this.errorReply(`Unable to kick '${targetId}' from the scavenger hunt.`);
},
/**
* Hunt queuing
*/
queueunrated: "queue",
queuerated: "queue",
queuerecycled: "queue",
queue(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
if (!target && this.cmd !== "queuerecycled") {
if (this.cmd === "queue") {
this.runBroadcast();
const commandHandler = ScavengerCommands.viewqueue;
commandHandler.call(this, target, room, user, this.connection, this.cmd, this.message);
return;
}
return this.parse("/scavhelp staff");
}
this.checkCan("mute", null, room);
if (this.cmd === "queuerecycled") {
if (ScavengerHuntDatabase.isEmpty()) {
return this.errorReply(`There are no hunts in the database.`);
}
if (!room.settings.scavQueue) {
room.settings.scavQueue = [];
}
let next;
if (target) {
const huntNumber = parseInt(target);
if (!ScavengerHuntDatabase.hasHunt(huntNumber))
return this.errorReply("You specified an invalid hunt number.");
next = scavengersData.recycledHunts[huntNumber - 1];
} else {
next = ScavengerHuntDatabase.getRecycledHuntFromDatabase();
}
const correctlyFormattedQuestions = next.questions.flatMap((question) => [question.text, question.answers]);
room.settings.scavQueue.push({
hosts: next.hosts,
questions: correctlyFormattedQuestions,
staffHostId: "scavengermanager",
staffHostName: "Scavenger Manager",
gameType: "unrated"
});
} else {
const [hostsArray, ...params] = target.split("|");
const hosts = ScavengerHunt.parseHosts(hostsArray.split(/[,;]/), room);
if (!hosts.length) {
return this.errorReply("The user(s) you specified as the host is not online, or is not in the room.");
}
const results = ScavengerHunt.parseQuestions(params);
if (results.err)
return this.errorReply(results.err);
if (!room.settings.scavQueue)
room.settings.scavQueue = [];
room.settings.scavQueue.push({
hosts,
questions: results.result,
staffHostId: user.id,
staffHostName: user.name,
gameType: this.cmd.includes("unrated") ? "unrated" : "regular"
});
}
this.privateModAction(`${user.name} has added a scavenger hunt to the queue.`);
room.saveSettings();
},
dequeue(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
const id = parseInt(target);
if (!room.settings.scavQueue || isNaN(id) || id < 0 || id >= room.settings.scavQueue.length)
return false;
const removed = room.settings.scavQueue.splice(id, 1)[0];
this.privateModAction(`${user.name} has removed a scavenger hunt created by [${removed.hosts.map((u) => u.id).join(", ")}] from the queue.`);
this.sendReply(`|uhtmlchange|scav-queue|${formatQueue(room.settings.scavQueue, user, room)}`);
room.saveSettings();
},
viewqueue(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
if (!this.runBroadcast())
return false;
this.sendReply(`|uhtml|scav-queue|${formatQueue(room.settings.scavQueue, user, room, this.broadcasting)}`);
},
next(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
if (!room.settings.scavQueue?.length) {
return this.errorReply("The scavenger hunt queue is currently empty.");
}
if (room.game)
return this.errorReply(`There is already a game in this room - ${room.game.title}.`);
const huntId = parseInt(target) || 0;
if (!room.settings.scavQueue[huntId])
return false;
const next = room.settings.scavQueue.splice(huntId, 1)[0];
room.game = new ScavengerHunt(
room,
{ id: next.staffHostId, name: next.staffHostName },
next.hosts,
next.gameType,
next.questions
);
if (huntId)
this.sendReply(`|uhtmlchange|scav-queue|${formatQueue(room.settings.scavQueue, user, room)}`);
this.modlog("SCAV NEW", null, `from queue: creators - ${next.hosts.map((h) => h.id)}`);
room.saveSettings();
},
enablequeue: "disablequeue",
disablequeue(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
const state = this.cmd === "disablequeue";
if ((room.settings.scavSettings.scavQueueDisabled || false) === state) {
return this.errorReply(`The queue is already ${state ? "disabled" : "enabled"}.`);
}
room.settings.scavSettings.scavQueueDisabled = state;
room.saveSettings();
this.sendReply(`|uhtmlchange|scav-queue|${formatQueue(room.settings.scavQueue, user, room)}`);
this.privateModAction(`The queue has been ${state ? "disabled" : "enabled"} by ${user.name}.`);
this.modlog("SCAV QUEUE", null, state ? "disabled" : "enabled");
},
defaulttimer(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("declare", null, room);
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
if (!target) {
const duration_string = room.settings.scavSettings.defaultScavTimer || DEFAULT_TIMER_DURATION;
return this.sendReply(`The default scavenger timer is currently set at: ${duration_string} minutes.`);
}
const duration = parseInt(target);
if (!duration || duration < 0) {
return this.errorReply("The default timer must be an integer greater than zero, in minutes.");
}
room.settings.scavSettings.defaultScavTimer = duration;
room.saveSettings();
this.privateModAction(`The default scavenger timer has been set to ${duration} minutes by ${user.name}.`);
this.modlog("SCAV DEFAULT TIMER", null, `${duration} minutes`);
},
/**
* Leaderboard Commands
*/
addpoints(target, room, user) {
room = this.requireRoom("scavengers");
this.checkCan("mute", null, room);
const parts = target.split(",");
const targetId = toID(parts[0]);
const points = parseInt(parts[1]);
if (!targetId || targetId === "constructor" || targetId.length > 18)
return this.errorReply("Invalid username.");
if (!points || points < 0 || points > 1e3)
return this.errorReply("Points must be an integer between 1 and 1000.");
Leaderboard.addPoints(targetId, "points", points, true).write();
this.privateModAction(`${targetId} was given ${points} points on the current scavengers ladder by ${user.name}.`);
this.modlog("SCAV ADDPOINTS", targetId, "" + points);
},
removepoints(target, room, user) {
room = this.requireRoom("scavengers");
this.checkCan("mute", null, room);
const parts = target.split(",");
const targetId = toID(parts[0]);
const points = parseInt(parts[1]);
if (!targetId || targetId === "constructor" || targetId.length > 18)
return this.errorReply("Invalid username.");
if (!points || points < 0 || points > 1e3)
return this.errorReply("Points must be an integer between 1 and 1000.");
Leaderboard.addPoints(targetId, "points", -points, true).write();
this.privateModAction(`${user.name} has taken ${points} points from ${targetId} on the current scavengers ladder.`);
this.modlog("SCAV REMOVEPOINTS", targetId, "" + points);
},
resetladder(target, room, user) {
room = this.requireRoom("scavengers");
this.checkCan("declare", null, room);
Leaderboard.reset().write();
this.privateModAction(`${user.name} has reset the current scavengers ladder.`);
this.modlog("SCAV RESETLADDER");
},
top: "ladder",
async ladder(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
if (!this.runBroadcast())
return false;
const isChange = !this.broadcasting && target;
const hideStaff = !this.broadcasting && this.meansNo(target);
const ladder = await Leaderboard.visualize("points");
this.sendReply(
`|uhtml${isChange ? "change" : ""}|scavladder|
`
);
},
async rank(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
if (!this.runBroadcast())
return false;
const targetId = toID(target) || user.id;
const rank = await Leaderboard.visualize("points", targetId);
if (!rank) {
this.sendReplyBox(`User '${targetId}' does not have any points on the scavengers leaderboard.`);
} else {
this.sendReplyBox(import_lib.Utils.html`User '${rank.name}' is #${rank.rank} on the scavengers leaderboard with ${rank.points} points.`);
}
},
/**
* Leaderboard Point Distribution Editing
*/
setblitz(target, room, user) {
room = this.requireRoom();
const scavsRoom = getScavsRoom(room);
if (!scavsRoom) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
if (!target) {
const points = [];
const source = Object.entries(Object.assign(DEFAULT_BLITZ_POINTS, room.settings.scavSettings.blitzPoints || {}));
for (const entry of source) {
points.push(`${entry[0]}: ${entry[1]}`);
}
return this.sendReplyBox(`The points rewarded for winning hunts within a minute is: ${points.join(" ")}`);
}
this.checkCan("declare", null, room);
const parts = target.split(",");
const blitzPoints = parseInt(parts[1]);
const gameType = toID(parts[0]);
if (!RATED_TYPES.includes(gameType))
return this.errorReply(`You cannot set blitz points for ${gameType} hunts.`);
if (isNaN(blitzPoints) || blitzPoints < 0 || blitzPoints > 1e3) {
return this.errorReply("The points value awarded for blitz must be an integer bewteen 0 and 1000.");
}
if (!room.settings.scavSettings.blitzPoints)
room.settings.scavSettings.blitzPoints = {};
room.settings.scavSettings.blitzPoints[gameType] = blitzPoints;
room.saveSettings();
this.privateModAction(`${user.name} has set the points awarded for blitz for ${gameType} hunts to ${blitzPoints}.`);
this.modlog("SCAV BLITZ", null, `${gameType}: ${blitzPoints}`);
if (room.parent && !room.persist && scavsRoom) {
scavsRoom.modlog({
action: "SCAV BLITZ",
loggedBy: user.id,
note: `${gameType}: ${blitzPoints}`
});
scavsRoom.sendMods(`(${user.name} has set the points awarded for blitz for ${gameType} hunts to ${blitzPoints} in <<${room.roomid}>>.)`);
scavsRoom.roomlog(`(${user.name} has set the points awarded for blitz for ${gameType} hunts to ${blitzPoints} in <<${room.roomid}>>.)`);
}
},
sethostpoints(target, room, user) {
room = this.requireRoom();
const scavsRoom = getScavsRoom(room);
if (!scavsRoom) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
if (!target) {
const pointSetting = Object.hasOwnProperty.call(room.settings.scavSettings, "hostPoints") ? room.settings.scavSettings.hostPoints : DEFAULT_HOST_POINTS;
return this.sendReply(`The points rewarded for hosting a regular hunt is ${pointSetting}.`);
}
this.checkCan("declare", null, room);
const points = parseInt(target);
if (isNaN(points))
return this.errorReply(`${target} is not a valid number of points.`);
room.settings.scavSettings.hostPoints = points;
room.saveSettings();
this.privateModAction(`${user.name} has set the points awarded for hosting regular scavenger hunts to ${points}`);
this.modlog("SCAV SETHOSTPOINTS", null, `${points}`);
if (room.parent && !room.persist) {
scavsRoom.modlog({
action: "SCAV SETHOSTPOINTS",
loggedBy: user.id,
note: `${points} [room: ${room.roomid}]`
});
scavsRoom.sendMods(`(${user.name} has set the points awarded for hosting regular scavenger hunts to - ${points} in <<${room.roomid}>>)`);
scavsRoom.roomlog(`(${user.name} has set the points awarded for hosting regular scavenger hunts to - ${points} in <<${room.roomid}>>)`);
}
},
setpoints(target, room, user) {
room = this.requireRoom();
const scavsRoom = getScavsRoom(room);
if (!scavsRoom) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
if (!target) {
const points = [];
const source = Object.entries({
...DEFAULT_POINTS,
...room.settings.scavSettings.winPoints || {}
});
for (const entry of source) {
points.push(`${entry[0]}: ${entry[1].map((p, i) => `(${i + 1}) ${p}`).join(", ")}`);
}
return this.sendReplyBox(`The points rewarded for winning hunts is: ${points.join(" ")}`);
}
this.checkCan("declare", null, room);
let [type, ...pointsSet] = target.split(",");
type = toID(type);
if (!RATED_TYPES.includes(type))
return this.errorReply(`You cannot set win points for ${type} hunts.`);
const winPoints = pointsSet.map((p) => parseInt(p));
if (winPoints.some((p) => isNaN(p) || p < 0 || p > 1e3) || !winPoints.length) {
return this.errorReply("The points value awarded for winning a scavenger hunt must be an integer between 0 and 1000.");
}
if (!room.settings.scavSettings.winPoints)
room.settings.scavSettings.winPoints = {};
room.settings.scavSettings.winPoints[type] = winPoints;
room.saveSettings();
const pointsDisplay = winPoints.map((p, i) => `(${i + 1}) ${p}`).join(", ");
this.privateModAction(`${user.name} has set the points awarded for winning ${type} scavenger hunts to - ${pointsDisplay}`);
this.modlog("SCAV SETPOINTS", null, `${type}: ${pointsDisplay}`);
if (room.parent && !room.persist) {
scavsRoom.modlog({
action: "SCAV SETPOINTS",
loggedBy: user.id,
note: `${pointsDisplay} [room: ${room.roomid}]`
});
scavsRoom.sendMods(`(${user.name} has set the points awarded for winning ${type} scavenger hunts to - ${pointsDisplay} in <<${room.roomid}>>)`);
scavsRoom.roomlog(`(${user.name} has set the points awarded for winning ${type} scavenger hunts to - ${pointsDisplay} in <<${room.roomid}>>)`);
}
},
resettwist: "settwist",
settwist(target, room, user) {
room = this.requireRoom();
const scavsRoom = getScavsRoom(room);
if (!scavsRoom) {
return this.errorReply("This command can only be used in the scavengers room.");
}
if (this.cmd.includes("reset"))
target = "RESET";
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
if (!target) {
const twist = room.settings.scavSettings.officialtwist || "none";
return this.sendReplyBox(`The current official twist is: ${twist}`);
}
this.checkCan("declare", null, room);
if (target === "RESET") {
room.settings.scavSettings.officialtwist = null;
} else {
const twist = toID(target);
if (!import_scavenger_games.ScavMods.twists[twist] || twist === "constructor")
return this.errorReply("Invalid twist.");
room.settings.scavSettings.officialtwist = twist;
room.saveSettings();
}
if (room.settings.scavSettings.officialtwist) {
this.privateModAction(`${user.name} has set the official twist to ${room.settings.scavSettings.officialtwist}`);
} else {
this.privateModAction(`${user.name} has removed the official twist.`);
}
this.modlog("SCAV TWIST", null, room.settings.scavSettings.officialtwist);
if (room.parent && !room.persist) {
if (room.settings.scavSettings.officialtwist) {
scavsRoom.modlog({
action: "SCAV TWIST",
loggedBy: user.id,
note: `${room.settings.scavSettings.officialtwist} [room: ${room.roomid}]`
});
scavsRoom.sendMods(`(${user.name} has set the official twist to - ${room.settings.scavSettings.officialtwist} in <<${room.roomid}>>)`);
scavsRoom.roomlog(`(${user.name} has set the official twist to - ${room.settings.scavSettings.officialtwist} in <<${room.roomid}>>)`);
} else {
scavsRoom.sendMods(`(${user.name} has reset the official twist in <<${room.roomid}>>)`);
scavsRoom.roomlog(`(${user.name} has reset the official twist in <<${room.roomid}>>)`);
}
}
},
twists(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
this.checkCan("mute", null, room);
if (!this.runBroadcast())
return false;
let buffer = `
`);
},
"ipcheck"(target, room, user) {
room = this.requireRoom();
if (!getScavsRoom(room))
return false;
this.checkCan("declare", null, room);
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
const settings = room.settings.scavSettings.scavmod || {};
target = toID(target);
const setting = {
"on": true,
"off": false,
"toggle": !settings.ipcheck
};
if (!(target in setting))
return this.sendReply("Invalid setting - ON, OFF, TOGGLE");
settings.ipcheck = setting[target];
room.settings.scavSettings.scavmod = settings;
room.saveSettings();
this.privateModAction(`${user.name} has set multiple connections verification to ${setting[target] ? "ON" : "OFF"}.`);
this.modlog("SCAV MODSETTINGS IPCHECK", null, setting[target] ? "ON" : "OFF");
return this.parse("/scav modsettings update");
}
},
/**
* Database Commands
*/
recycledhunts(target, room, user) {
room = this.requireRoom();
this.checkCan("mute", null, room);
if (!getScavsRoom(room)) {
return this.errorReply("Scavenger Hunts can only be added to the database in the scavengers room.");
}
let cmd;
[cmd, target] = import_lib.Utils.splitFirst(target, " ");
cmd = toID(cmd);
if (!["addhunt", "list", "removehunt", "addhint", "removehint", "autostart"].includes(cmd)) {
return this.parse(`/recycledhuntshelp`);
}
if (cmd === "addhunt") {
if (!target)
return this.errorReply(`Usage: ${cmd} Hunt Text`);
const [hostsArray, ...questions] = target.split("|");
const hosts = ScavengerHunt.parseHosts(hostsArray.split(/[,;]/), room, true);
if (!hosts.length) {
return this.errorReply("You need to specify a host.");
}
const result = ScavengerHunt.parseQuestions(questions);
if (result.err)
return this.errorReply(result.err);
ScavengerHuntDatabase.addRecycledHuntToDatabase(hosts, result.result);
return this.privateModAction(`A recycled hunt has been added to the database.`);
}
if (ScavengerHuntDatabase.isEmpty())
return this.errorReply("There are no hunts in the database.");
if (cmd === "list") {
return this.parse(`/join view-recycledHunts-${room}`);
}
const params = target.split(",").map((param) => param.trim()).filter((param) => param !== "");
const usageMessages = {
"removehunt": "Usage: removehunt hunt_number",
"addhint": "Usage: addhint hunt number, question number, hint text",
"removehint": "Usage: removehint hunt number, question number, hint text",
"autostart": "Usage: autostart on/off"
};
if (!params)
return this.errorReply(usageMessages[cmd]);
const numberOfRequiredParameters = {
"removehunt": 1,
"addhint": 3,
"removehint": 3,
"autostart": 1
};
if (params.length < numberOfRequiredParameters[cmd])
return this.errorReply(usageMessages[cmd]);
const [huntNumber, questionNumber, hintNumber] = params.map((param) => parseInt(param));
const cmdsNeedingHuntNumber = ["removehunt", "removehint", "addhint"];
if (cmdsNeedingHuntNumber.includes(cmd)) {
if (!ScavengerHuntDatabase.hasHunt(huntNumber))
return this.errorReply("You specified an invalid hunt number.");
}
const cmdsNeedingQuestionNumber = ["addhint", "removehint"];
if (cmdsNeedingQuestionNumber.includes(cmd)) {
if (isNaN(questionNumber) || questionNumber <= 0 || questionNumber > scavengersData.recycledHunts[huntNumber - 1].questions.length) {
return this.errorReply("You specified an invalid question number.");
}
}
const cmdsNeedingHintNumber = ["removehint"];
if (cmdsNeedingHintNumber.includes(cmd)) {
const numQuestions = scavengersData.recycledHunts[huntNumber - 1].questions.length;
if (isNaN(questionNumber) || questionNumber <= 0 || questionNumber > numQuestions) {
return this.errorReply("You specified an invalid hint number.");
}
}
if (cmd === "removehunt") {
ScavengerHuntDatabase.removeRecycledHuntFromDatabase(huntNumber);
return this.privateModAction(`Recycled hunt #${huntNumber} was removed from the database.`);
} else if (cmd === "addhint") {
const hintText = params[2];
ScavengerHuntDatabase.addHintToRecycledHunt(huntNumber, questionNumber, hintText);
return this.privateModAction(`Hint added to Recycled hunt #${huntNumber} question #${questionNumber}: ${hintText}.`);
} else if (cmd === "removehint") {
ScavengerHuntDatabase.removeHintToRecycledHunt(huntNumber, questionNumber, hintNumber);
return this.privateModAction(`Hint #${hintNumber} was removed from Recycled hunt #${huntNumber} question #${questionNumber}.`);
} else if (cmd === "autostart") {
if (!room.settings.scavSettings)
room.settings.scavSettings = {};
if (params[0] !== "on" && params[0] !== "off")
return this.errorReply(usageMessages[cmd]);
if (params[0] === "on" === !!room.settings.scavSettings.addRecycledHuntsToQueueAutomatically) {
return this.errorReply(`Autostarting recycled hunts is already ${room.settings.scavSettings.addRecycledHuntsToQueueAutomatically ? "on" : "off"}.`);
}
room.settings.scavSettings.addRecycledHuntsToQueueAutomatically = !room.settings.scavSettings.addRecycledHuntsToQueueAutomatically;
this.privateModAction(`Automatically adding recycled hunts to the queue is now ${room.settings.scavSettings.addRecycledHuntsToQueueAutomatically ? "on" : "off"}`);
if (params[0] === "on") {
return this.parse("/scav queuerecycled");
}
}
},
recycledhuntshelp() {
if (!this.runBroadcast())
return;
this.sendReplyBox([
"Help for Recycled Hunts",
"- addhunt <Hunt Text>: Adds a hunt to the database of recycled hunts.",
"- removehunt<Hunt Number>: Removes a hunt form the database of recycled hunts.",
"- list: Shows a list of hunts in the database along with their questions and hints.",
"- addhint <Hunt Number, Question Number, Hint Text>: Adds a hint to the specified question in the specified hunt.",
"- removehint <Hunt Number, Question Number, Hint Number>: Removes the specified hint from the specified question in the specified hunt.",
"- autostart <on/off>: Sets whether or not recycled hunts are automatically added to the queue when a hunt ends."
].join(" "));
}
};
const pages = {
recycledHunts(query, user, connection) {
this.title = "Recycled Hunts";
const room = this.requireRoom();
let buf = "";
if (!user.named)
return Rooms.RETRY_AFTER_LOGIN;
if (!room.persist)
return;
this.checkCan("mute", null, room);
buf += `
List of recycled Scavenger hunts
`;
buf += ``;
for (const hunt of scavengersData.recycledHunts) {
buf += `
`;
buf += `
By ${hunt.hosts.map((host) => host.name).join(", ")}
`;
for (const question of hunt.questions) {
buf += ``;
buf += `${question.text}`;
buf += `
`;
buf += `
Answers:
`;
for (const answer of question.answers) {
buf += `
${answer}
`;
}
buf += `
`;
if (question.hints.length) {
buf += `
`;
buf += `
Hints:
`;
for (const hint of question.hints) {
buf += `
${hint}
`;
}
buf += `
`;
}
buf += ``;
}
buf += `
`;
}
buf += ``;
buf += `
`;
return buf;
}
};
const commands = {
// general
scav: "scavengers",
scavengers: ScavengerCommands,
tscav: "teamscavs",
teamscavs: ScavengerCommands.teamscavs,
teamscavshelp: ScavengerCommands.teamscavshelp,
// old game aliases
scavenge: ScavengerCommands.guess,
startpracticehunt: "starthunt",
startofficialhunt: "starthunt",
startminihunt: "starthunt",
startunratedhunt: "starthunt",
startrecycledhunt: "starthunt",
starttwisthunt: "starthunt",
starttwistofficial: "starthunt",
starttwistpractice: "starthunt",
starttwistmini: "starthunt",
starttwistunrated: "starthunt",
forcestarthunt: "starthunt",
forcestartunrated: "starthunt",
forcestartpractice: "starthunt",
starthunt: ScavengerCommands.create,
joinhunt: ScavengerCommands.join,
leavehunt: ScavengerCommands.leave,
resethunt: ScavengerCommands.reset,
resethunttoqueue: ScavengerCommands.resettoqueue,
forceendhunt: "endhunt",
endhunt: ScavengerCommands.end,
edithunt: ScavengerCommands.edithunt,
viewhunt: ScavengerCommands.viewhunt,
inherithunt: ScavengerCommands.inherit,
scavengerstatus: ScavengerCommands.status,
scavengerhint: ScavengerCommands.hint,
nexthunt: ScavengerCommands.next,
// point aliases
scavaddpoints: "scavengeraddpoints",
scavengersaddpoints: ScavengerCommands.addpoints,
scavrmpoints: "scavengersremovepoints",
scavengersrmpoints: "scavengersremovepoints",
scavremovepoints: "scavengersremovepoints",
scavengersremovepoints: ScavengerCommands.addpoints,
scavresetlb: "scavengersresetlb",
scavengersresetlb: ScavengerCommands.resetladder,
recycledhunts: ScavengerCommands.recycledhunts,
recycledhuntshelp: ScavengerCommands.recycledhuntshelp,
scavrank: ScavengerCommands.rank,
scavladder: "scavtop",
scavtop: ScavengerCommands.ladder,
scavengerhelp: "scavengershelp",
scavhelp: "scavengershelp",
scavengershelp(target, room, user) {
if (!room || !getScavsRoom(room)) {
return this.errorReply("This command can only be used in the scavengers room.");
}
if (!this.runBroadcast())
return false;
const userCommands = [
"Player commands:",
"- /scavengers: Join the scavengers room.",
"- /joinhunt: Join the current scavenger hunt.",
"- /leavehunt: Leave the current scavenger hunt. Also resets your progress.",
"- /viewhunt: Show the ongoing hunt up to where you solved it.",
"- /scavenge [guess]: Submit your answer to the current hint.",
"- /scavengerstatus (or /scav status): Check your status in the current hunt.",
"- /scavengers queue (or /scav queue): Showcase the hunts currently in queue, with the answers hidden for any hunt that is not yours.",
"- /scavengerhint (or /scav hint): View your latest hint in the current game.",
"- /scavladder (or /scav top): View the current scavengers leaderboard.",
"- /scavrank [user]: View the rank of the user on the current scavenger leaderboard. Defaults to the user if no name is provided.",
"For a more in-depth overview, use /scavhelp staff."
].join(" ");
const staffCommands = [
"Staff and auth commands:",
"As a room voice (+), you can use the following Scavengers commands, on top of the regular commands (see /scavhelp):",
"- /scav edithunt [question number], [hint | answer], [value]: Edit the ongoing scavenger hunt. Only the host(s) can edit the hunt.",
"- /scav addhint [question number], [value]: Add a hint to a question in the ongoing scavenger hunt. Only the host(s) can add a hint.",
"- /scav edithint [question number], [hint number], [value]: Edit a hint to a question in the ongoing scavenger hunt. Only the host(s) can edit a hint.",
"- /scav removehint [question number], [hint number] (or /scav deletehint): Remove a hint from a question in the current scavenger hunt. Only the host(s) can remove a hint.",
"- /teamscavshelp: Explains the team scavs plugin.",
" As a room driver (%), you can also use the following Scavengers commands:",
"- /scav queue (unrated) [host(s)] | [hint] | [answer] | [hint] | [answer] | [hint] | [answer] | ...: Queue a scavenger hunt to be started after the current hunt is finished.",
"- /start(official/practice/mini/unrated)hunt [host] | [hint] | [answer] | [hint] | [answer] | [hint] | [answer] | ...: Create a new (official/practice/mini/unrated) scavenger hunt and start it immediately.",
"- /scav viewqueue (or /scav queue): Look at the list of queued scavenger hunts. Now also includes the option to remove hunts from the queue.",
"- /resethunt: Reset the current scavenger hunt without revealing the hints and answers, nor giving out points.",
"- /resethunttoqueue: Reset the ongoing scavenger hunt without revealing the hints and answers, nor giving out points. Then, add it directly to the queue.",
"- /scav timer [minutes]: Set a timer to automatically end the current hunt. Setting [minutes] to 0 turns off the timer.",
"- /endhunt: End the current scavenger hunt immediately and announce the winners and the answers.",
"- /nexthunt: Start the next hunt in the queue.",
"- /viewhunt: View the ongoing scavenger hunt. As a host, you can also view the hunt in its entirety.",
"- /inherithunt: Become the staff host, gaining staff permissions to the current hunt.",
"- /scav games create [game mode]: start a game of the given mode.",
" Game modes include: Jump Start, Point Rally, KO games, Scav games and team scavs.",
"- /scav games end: End the game of the given type.",
"- /starttwist(hunt / practice / official / mini /unrated) [twist] | [host] | [hint] | [answer] | [hint] | [answer] | [hint] | [answer] | \u2026 : Create and start a new scavenger hunt that uses a specified twist mode. This can be used inside a scavenger game mode.",
"- /scav twists: Show a list of all the twists that are available on the server.",
"- /scav settwist: View the current default official hunt twist that is in use.",
"- /scav setpoints: Show the current point distribution for officials, minis and regular hunts.",
"- /scav setblitz: Show the current points awarded for Blitzing an official, mini or regular hunt.",
"- /scav defaulttimer: Show the default timer applied to hunts started automatically from the queue.",
"- /scav addpoints [user], [amount]: Give the user the specified amount of points towards the current ladder.",
"- /scav removepoints [user], [amount]: Remove the specified amount of points from the user towards the current ladder.",
"- /recycledhunts: Modify the database of recycled hunts and enable/disable autoqueing them.",
"- /scav queuerecycled [number]: Queue a recycled hunt from the database. If [number] is left blank, then a random hunt is queued.",
"- /recycledhuntshelp: give more info about the recycled hunts.",
" As a room owner (#), you can also use the following scavengers commands:",
"- /scav resetladder: Reset the current scavenger leaderboard.",
"- /scav setpoints [1st place], [2nd place], [3rd place], [4th place], [5th place], ...: Set the point values for wins of officials, minis and regular hunts.",
"- /scav defaulttimer [value]: Set the default timer applied to automatically started hunts from the queue.",
"- /scav setblitz [value] ...: Set the blitz award to the given value.",
"- /scav settwist [twist name]: Set the default twist mode for all official hunts.",
"- /scav resettwist: Reset the default twist mode for all official hunts to nothing.",
"- /scav modsettings: Allow or disallow miscellaneous room settings"
].join(" ");
const gamesCommands = [
"Game commands:",
"- /scav game create [kogames | pointrally | scavengergames | jumpstart | teamscavs]: Start a new scripted scavenger game. (Requires: % @ * # &)",
"- /scav game end: End the current scavenger game. (Requires: % @ * # &)",
"- /scav game kick [user]: Kick the user from the current scavenger game. (Requires: % @ * # &)",
"- /scav game score: Show the current scoreboard for any game with a leaderboard.",
"- /scav game rank [user]: Show a user's rank in the current scavenger game leaderboard."
].join(" ");
target = toID(target);
const display = target === "all" ? `${userCommands}