2.0.0 RC1

RELEASE CANDIDATE FOR 2.0.0 - FOR EARLY ACCESS VOLUNTEERS ONLY

Upgrade Notes (PLEASE READ!!!!)

This is a major version upgrade:

• If you have community plugins, make sure that 2.0-compatible versions are available before you upgrade.
• If you have custom code do not upgrade until you have made the updates explained in the"Developer Notes" section below.

How to Upgrade Restart Required

After running the upgrade script, before you restart:

1. Log on to the server shell.
2. Go to the aresmush directory
3. Run bin/update_ruby
4. Go to the ares-webportal directory
5. Run bin/update_npm
6. Restart the server
7. Install 2.0-compatible versions of any community plugins using plugin/install in-game.

Features

• A new block system replaces the old page/ignore and also works on channels and on the web portal. See help block for details or the "Manage Blocks" screen available through your account settings (the cog icon in top right on the portal). Based on discussion/reports/suggestions from various Discord folks.
• The markdown editor on web portal pages now has a WYSIWYG style edit buttons. (suggested by Psywren)
• A new command pm/reply can reply to your most recent thread (use with caution in case another one comes in while you're typing!) or to a specific thread from your pm/review list (so you don't have to type out all the names).
• New "Admin" tab in character edit page now contains roles and reset password.
• New "FS3" tab in character edit page now contains XP and luck for those with the appropriate FS3 management roles.
• Ares now supports CloudFlare Turnstile in addition to Google Recaptcha. See Configuring Captcha for help.
• Ares now uses a new logging system, so your log files will look a little different.
• Mail messages in trash are now deleted periodically after a timeout rather than on disconnect. (This is mostly for web players who may never "log out" in the traditional sense and therefore never clear their mail.)
• You can now channel/announce with "all" as the channel name to do all channels at once.
• Improved layout of the active scenes list. (Based on what various games have done with their custom changes.)
• The MU-client style web client has been removed from the web portal.
• Ares now uses a dark theme by default, and has some new theme colors that will make it easier to customize light or dark themes.

Fixes

• Websocket timeouts on Firefox should be fixed, I hope. (reported by Cidward)
• Unread PMs were being hidden if you waited too long to read them. (reported by LB Heuschkel)
• The Play screen wasn't marking things read for alts correctly. (reported by various folks on Discord)
• Character "last online" updates better with web activity.
• Character search feature on the web portal now accounts for NPCs. (reported by Clockwork)
• Handles containing wumpus were rejected by discord and will now be shown as "wumpu5". (reported by Katiewumpus)

Little Things

• channel/clear did nothing after the web portal channel integration, and has now been removed. (reported by Clockwork)
• plugin/unload was impractical, and has now been removed.
• Error when setting an alias that already exists. (reported by Psywren)

AresCentral Changes

• Games are now removed from the list if they've been down for 45 days (previously was 90).
• Plugin installs should count more coherently. (reported by Ren)

Community Contribs

• KarmaBum has contributed a RP prompt/Bingo Card plugin.
• Blu has contributed a cool new theme: Basic Blu. Check out what it looks like and see the readme there for installation tips.

Developer Notes

Ares now uses Ruby-3.3.6 and Ember-5.12 to keep pace with security updates and deprecations.

If you have custom code or are the maintainer of a community plugin, you will need to make the following updates to your code to make it 2.0-compatible.

Web Portal Developer Upgrade Notes: Ember 5

Components Moved

The HBS and JS files for components now live side-by-side in /app/components

Actions

Actions (like in buttons) now work differently.

Old code:

<button class="btn btn-secondary" {{action 'removeOutfit' outfit.key}}>Remove Outfit</button>

actions: {
    removeOutfit: function(key) {
    ...
    }
}

New code:

<button class="btn btn-secondary" {{on 'click' (fn this.removeOutfit outfit.key)}}>Remove Outfit</button>

import { action } from '@ember/object';

@action
removeOutfit(key) {
  ...
}

Note: Make sure action methods are using this format: myMethod(param) not the function version myMethod: function(param)

For a normal 'action' keyword:

Old: <FileUploader @uploaded={{action "fileUploaded"}}

New: <FileUploader @uploaded={{this.fileUploaded}}

For button or link clicks:

Old: <button {{action 'loadLastPose'}}

New: <button {{on 'click' this.loadLastPose}}

For button or link clicks with a parameter:

Old: <a href="#" {{action 'changeSceneStatus' 'stop'}}

New: <a href="#" {{on 'click' (fn this.changeSceneStatus 'stop')}}

For uses of ‘mut’:

Old: <a href="#" {{action (mut this.confirmDeleteScene) true}}

New: <a href="#" {{on 'click' (fn this.setConfirmDeleteScene true)}}

Note: requires the creation of a setConfirmDeleteScene to wrap the flag:

  @action
  setConfirmDeleteScene(value) {
    this.set('confirmDeleteScene', value);
  },

Array Deprecations

Ember arrays no longer support certain operations like pushObject and removeObject. You can find substitute versions in the object-ext helper.

Old code:

this.charErrors.pushObject(error);

New code:

import { pushObject } from 'ares-webportal/helpers/object-ext';

pushObject(this.charErrors, error, this, 'charErrors')

Reload Char

In ProfileCustom, reloadChar changed to onReloadChar. For example:

  @action
  handleReload() {
    this.onReloadChar();
  }

Char Card

The default character card now uses a separate CharCardDemo component for the demographic info. This will hopefully make it easier if you want to create a custom card without duplicating all that info.

Game Developer Upgrade Notes: Ruby 3.3.6

Web Request Args

Web Request args use string lookup not symbol lookup.

Old: request.args[:data]

New: request.args['data']

That means CustomCharFields are now in “custom” not :custom

Old: chargen_data[:custom][:goals]

New: chargen_data['custom']['goals']

Find Client

find_client is now find_game_client

File Exists

File.exists is now File.exist

Theme Upgrade Notes

Table Views

Removed row/col styles from most components. This makes the display more flexible and easier to style, but will impact any custom styles you had.

New Theme Colors

$box-background-color and $box-words-color let you customize the background and text color in things like the scene log and profile info boxes, and blockquote/code blocks.

$secondary-words-color: lets you customize the text color on top of things using $secondary-color.

Version 1.7.2

Upgrade Notes

How to Upgrade (no restart required)

Fixes

• Version mismatch was erroneously showing for a minor patch difference. (reported by Ren and a bunch of others)
• "All" jobs filter wasn't returning results. (reported by Tat)

Version 1.7.1

Upgrade Notes

How to Upgrade (no restart required)

Fixes

• Error when describing rooms and exits. (reported by Clockwork)

Version 1.7.0

Upgrade Notes

How to Upgrade (no restart required)

Features

• Added tabs to the scene character cards. (contributed by Blu)
• Revamped the scene character card so you can more easily add new sections. Existing implementation will not be impacted.

Fixes

• Fixed mobile navbar being hard to read. (reported by LibraStar)
• Paging yourself via your alias no longer gives a weird response. (reported by KarmaBum).
• Prior desc is saved to a backup field, which admins can see via examine and restore if someone accidentally overwrites their desc. (suggested by Ren)

Version 1.6.0

Upgrade Notes

How to Upgrade (no restart required)

Features

• Notifications that used to show in the bottom right corner now show up as browser notifications. Also some general notification improvements to keeping the bell icon count accurate.
• Added a job filter for "archive". (suggested by Ren)
• Added a create scene button on the events page that will automatically invite anyone who RSVPed to the scene. There's also an event/scene command. Event scenes are automatically public and in a temp room.
• Install scripts are now targeted at Ubuntu 22.04, which is the new default install version for Ares. There's no need to upgrade existing games right now, but be aware that 20.04 will stop getting security updates in mid-2025. Major updates to your droplet OS can cause some issues, described in this guide. It may actually be easier to just create a new droplet and restore from backup.

Fixes

• Fix deleted scene ember error on unshared scenes page. (reported by Ren)

Little Things

• Revamped the way that wiki markdown helpers (like [[include]] or [[pagelist]] are rendered, to improve load speed.
• The config check will no longer warn you about the level 1 advantage cost if advantage XP is disabled. (suggested by Ren)

Version 1.5.0

Upgrade Notes

How to Upgrade Restart Required

Features

• The profile save custom code hook now accepts an enactor parameter. See developer note below for details.
• There's a new custom code hook for custom sidebar section.
• A new app/override command will submit & approve a character in one swoop, useful for rosters. (suggested by Tat and ExcelsiorAdmin)
• Overhauled the wiki export feature. Added FS3 info (suggested by Blu and Roadspike), achievements, and plots. Revamped how it works under the hood so hopefully it will no longer hog all the resources and potentially crash the game.

Fixes

• Bordered table template wasn't accounting for ansi in its string lengths. (report and fix contributed by Darc)
• Docker image now uses the appropriate NPM version. (reported by Darc and FallenLeavesGoCrunch)
• Fixed the default configuration for the discord_debug option. (reported by Colette)
• Restored the ability numbers to the FS3 sheet in screen reader mode. (reported by Ren)
• Game config will now warn you if your website/host has an inappropriate http prefix. (reported by Colette)

Little Things

• Added an extra warning about reboot times in the "your server wants a reboot" message. This is a feature of the OS, like when your PC says "please wait, installing updates" for ages.
• Fixed the order and display of wiki templates in the create page dropdown.
• Fixed the character icon border in Firefox.
• The game will no longer create a duplicate scene log history entry if you save a scene without actually changing the log.

Developer Notes

The profile save custom code hook now accepts an enactor parameter, so you can handle admin-only fields. By default, the new method save_fields_from_profile_edit2 just calls the old one (.save_fields_from_profile_edit), so existing code will be unaffected. If you want to use the new functionality, you can move your save code to the new method.

Version 1.4.0

Upgrade Notes

How to Upgrade (no restart required)

Features

• New commands: scene/addrelated and scene/removerelated. (suggested by Ren)
• Allow name with nickname in roster/chargen welcome messages using %{nick}. (suggested by Shipfish)
• Add idle icon legend to active scenes page. (suggested by Ren)
• Better FS3 sheet display in screen reader mode. (inspired by an article by Andruid from writing-games.com featuring work by Niamh)

Fixes

• Invalid markdown no longer breaks a wiki page. (reported by Devrex)
• Tweak aria tags on scene edit page for screen readers. Please let me know if this is still not enough. (reported by Ren)
• Sever info page on web portal was giving an error. (reported by Verdanthe)

Little Things

• The Ares development blog has been moved back to the main website after living in Wordpress for awhile: https://aresmush.com/blog
• Added a note about stacked shortcuts to help shortcuts. (reported by ZDL)

Version 1.3.2

Upgrade Notes

How to Upgrade (no restart required)

Fixes

• Improved the efficiency of the locations page display, which should help with performance on games with lots of locations.
• Tags were not showing up right in in-client event details. (reported by Ren)
• If the channel recall limit was lowered, messages were not being cleaned up properly. (reported by Blu)
• The game will give a more useful error if the configuration file is missing from a failed install.
• The cancel button on location create was a broken link.
• Clarified the necessary permissions in the building help tutorial.

Version 1.3.1

Upgrade Notes

How to Upgrade (no restart required)

Features

• You can now configure a max background length. It defaults to unlimited length. (suggested by Blu & Roz)

Fixes

• Parenting an area to itself could crash the game. (reported by Roz & Yam)
• Players no longer see the pre-canned job responses, unless they have a role giving them job access. (reported by Yam)
• Moving a forum topic was causing an error. (reported by Yam)
• You can now use scene/location on a stopped scene. (reported by Roz)
• An end-ansi mark right before a comma would add an extra space on the web portal markdown display. (reported by Yam)

Little Things

• Added an end-ansi mark to com titles in case you forget it. (suggested by Roz)

Version 1.3.0

Upgrade Notes

How to Upgrade (no restart required)

Features

• Custom Job Fields let you customize your job data entry. See config help for details.
• Scheduled Jobs let you create reminder jobs on a set schedule. See config help for details.
• You can now disable the post-approval job (by leaving the message blank) and welcome message (by leaving the arrival category blank). (requested by Tez)

Fixes

• Background color wasn't being picked up by bootstrap, which messed up tables and other things. (reported by Blu)
• App notes prompt wasn't parsing markdown. (reported by Roz)
• Web notifications for scene invites weren't working consistently.

Little Things

• Cleaned up styling on the jobs search and job edit screen.

For Coders

• You can now edit the custom routes file from the custom code screen on the web portal.