<commit_before># Steam Buddy

## Description
Steam buddy is a small node bot that watches for Steam users to join a game. When a member starts playing a game, Steam Buddy sends out notifications to let all of their friends know they are starting to play. Steam Buddy is currently configured to integrate with slack chat, but there are plans to extend Steam Buddy's functionality to include other means of communication.


Get notified immediately when your friends begin playing a steam game!
![Steam Buddy Screenshot](/img/steam_buddy.png)

## Configuration
Steam Buddy currently uses a simple configuration file to store information like Slack channels and Steam usernames. An example configuration file:

    {
        "users": ["user_1", "Steam_User", "Sam_Sample123", "1234567890123456789"],
	    "channels": {
		    "general": ["User 1", "Steam User", "Sam Sample123"]
		}
	}

`users` - In this section, you should list all of the Steam IDs that you want Steam Buddy to monitor. Steam buddy will use this Steam ID to lookup the 64-bit ID as well as the users configured Steam Display Name when sending out notifications. The Steam ID should be the vanity url taht is configured for a user. To find the vanity url, simply go to a users profile page and take the last portion of the url: `http://steamcommunity.com/id/THE_VANITY_URL/`. This will either be a custom url set by the user or the users steam id. Either one will work.

`channels` - In this section you should list all channels that you want Steam Buddy to send out notifications on. The channels should be a JSON object with the channel name as the id, and a list of Steam Display Names that will be in the messages that are sent out.

## Todo
1. Break out some of the constants that are stored in plaintext
2. Clean up and modularize the code

## Future features
1. Allow users to open the steam game from the message
2. Allow easy addition of new steam users to watch
3. Allow easy configuration of steam users, steam games, and Slack channels
4. Upgrade to node 1.0.x

## License
The MIT License (MIT)

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy<commit_msg>Update readme with slack message options<commit_after># Steam Buddy

## Description
Steam buddy is a small node bot that watches for Steam users to join a game. When a member starts playing a game, Steam Buddy sends out notifications to let all of their friends know they are starting to play. Steam Buddy is currently configured to integrate with slack chat, but there are plans to extend Steam Buddy's functionality to include other means of communication.


Get notified immediately when your friends begin playing a steam game!
![Steam Buddy Screenshot](/img/steam_buddy.png)

## Configuration
Steam Buddy currently uses a simple configuration file to store information like Slack channels and Steam usernames. An example configuration file:

    {
      "users": ["user_1", "Steam_User", "Sam_Sample123", "1234567890123456789"],
	  "slack": {
	    "message": "#{player} is playing #{game}! Go join them!",
	    "channels": {
		  "general": ["User 1", "Steam User", "<NAME>"]
	    }
	  }	
	}

`users` - In this section, you should list all of the Steam IDs that you want Steam Buddy to monitor. Steam buddy will use this Steam ID to lookup the 64-bit ID as well as the users configured Steam Display Name when sending out notifications. The Steam ID should be the vanity url taht is configured for a user. To find the vanity url, simply go to a users profile page and take the last portion of the url: `http://steamcommunity.com/id/THE_VANITY_URL/`. This will either be a custom url set by the user or the users steam id. Either one will work.

`slack` - Identify a slack integration. You can configure various options for when sending out a slack notification in this section.

  `message` - The message that will be sent out to all slack channels Steam Buddy is in. The message must include the `#{player}` and `#{game}` tags. These tags will be replaced with the name of the user signing into a game, and the game that they have launched.

  `channels` - In this section you should list all channels that you want Steam Buddy to send out notifications on. The channels should be a JSON object with the channel name as the id, and a list of Steam Display Names that will be in the messages that are sent out.

## Todo
1. Break out some of the constants that are stored in plaintext
2. Clean up and modularize the code

## Future features
1. Allow users to open the steam game from the message
2. Allow easy addition of new steam users to watch
3. Allow easy configuration of steam users, steam games, and Slack channels
4. Upgrade to node 1.0.x

## License
The MIT License (MIT)

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy
{'fraction_non_alphanumeric': 0.05605381165919283, 'fraction_numerical': 0.014472075010191602, 'mean_word_length': 4.063983488132095, 'pattern_counts': {'":': 8, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4565062', 'n_tokens_mistral': 1310, 'n_tokens_neox': 1226, 'n_words': 779}