|
| 1 | +# SteamDB Plugin for Millennium |
| 2 | + |
| 3 | +This plugin ports the functionality of the popular [SteamDB Browser Extension](https://github.com/SteamDatabase/BrowserExtension) to the Steam client using Millennium. |
| 4 | + |
| 5 | +## Features |
| 6 | +>Pretty much all of the SteamDB extension's features are included in this plugin. |
| 7 | + |
| 8 | +See the [SteamDB Browser Extension](https://github.com/SteamDatabase/BrowserExtension) for more details about each feature or SteamDB's [extension page](https://steamdb.info/extension/). |
| 9 | + |
| 10 | +## Installation |
| 11 | + |
| 12 | +1. Ensure you have at least version 2.16.0 of [Millennium](https://github.com/shdwmtr/millennium) installed on your Steam client |
| 13 | +2. Download the [latest release](https://github.com/tddebart/Steam-SteamDB-addon/releases) of this plugin |
| 14 | +3. Place the plugin files in your Millennium plugins directory (should be a plugins folder in your Steam client directory) |
| 15 | +4. Restart your Steam client |
| 16 | +5. Enable the SteamDB plugin in the Millennium plugin menu |
| 17 | + |
| 18 | +## Usage |
| 19 | + |
| 20 | +Once installed it should just work out of the box. |
| 21 | +<br> |
| 22 | +Make sure the the plugin folder is called exactly "SteamDB-plugin". Otherwise things like the styling or options page will break. |
| 23 | +<br> |
| 24 | +To see if the plugin is working you can go to any store app page and look for these icons |
| 25 | + |
| 26 | + |
| 27 | +## Configuration |
| 28 | + |
| 29 | +To configure the plugin: |
| 30 | + |
| 31 | +1. Open Steam and navigate to the main store page |
| 32 | +2. Click on "Your Store" in the top menu, then select "Preferences" |
| 33 | +3. Look for the "SteamDB Options" button and click it |
| 34 | + |
| 35 | +Alternatively, you can access the options page directly by entering this URL in your Steam client: |
| 36 | +https://store.steampowered.com/account/?steamdb=true |
| 37 | + |
| 38 | +Here you can customize various features and behaviors of the SteamDB plugin to suit your preferences. Just like in the SteamDB extension. |
| 39 | + |
| 40 | +## Contributing |
| 41 | + |
| 42 | +Contributions are welcome! Please feel free to submit a Pull Request. |
| 43 | + |
| 44 | +## Credits |
| 45 | + |
| 46 | +- Original SteamDB Browser Extension: [SteamDatabase](https://github.com/SteamDatabase) |
| 47 | +- [Millennium](https://github.com/shdwmtr/millennium) |
| 48 | + |
| 49 | +## License |
| 50 | + |
| 51 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
0 commit comments