Set Up a Score¶

This assumes you've already done the installation steps.

Using Backstage Web Interface (Recommended)¶

The easiest way to create and manage configurations is through the Backstage web interface:

./scripts/backstage.sh

Open http://localhost:5173 and use the Configuration Manager to create and edit .ini files through the browser.

Manual Configuration¶

If you prefer to edit configuration files directly, open your mastoscore.ini file (or whatever you named it) and edit it.

All the possible options are listed in the config module, and there is an example ini file you can look at. Here's the highlights.

Mandatory Options¶

In the [mastoscore] section, you have to define these options.

• cred_file: The credential file you set in Create a credential file.
• hashtag: What hashtag are you looking at? Omit the # character. If you're searching for #stuff, just write hashtag = stuff.
• api_base_url What server did is your credential file account on? Include the https:// in the URL. If your userid is mastoscore@example.social then your api_base_url is https://example.social.
• top_n: How many top toots do you want to report?
• timezone: This is important. All your times in all your toots and graphs will be localized to this time.
• botusername: When we post, we post with the hashtag. So that means our posts will also appear in the analysis. Set this to the name of your account, and you'll be excluded from the analysis. Set this to a bogus name, and nothing will be excluded.
• journaldir: directory where we write a bunch of JSON files
• journalfile: name for each json file. See the documentation in the config module

[fetch] Options¶

In the [fetch] section you may want to add:

• max = n: This is the maximum number of toots that we will download from any given server. It defaults to 2000.

[post] Options¶

It's worth noting that you can put a different cred_file and different api_base_url here so that you fetch using one userid and one server, and you post using a different user on a different server.

In the [post] section you may want to add:

• max = n: This is the maximum number of toots that we will download from any given server. It defaults to 2000.
• tag_users = False: This will stop us from generating toots that notify the mentioned users. Good for testing.

[graph] Options¶

In the [graph] section you may want to add:

• title: A title for the graph
• start_label: The words to annotate the event start line
• end_label: The words to annotate the event end line
• lookback: The number of hours? to look back? This is in a state of flux.
• graph_title: Kung Fu Saturday 16 Nov 2024

Run the analysis¶

When you think you've got your INI file right, go to run an analysis to actually do it!