Metadata-Version: 2.1
Name: SteamPathFinder
Version: 0.0.2
Summary: A utility module for finding Steam paths
Home-page: https://github.com/21-ko/SteamPathFinder
Author: 21-ko
Author-email: dlwlghks8779@naver.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: vdf

## Steam Path Finder Module

The Steam Path Finder is a Python module designed to assist in locating the installation path of Steam, the installation paths of specific Steam applications, and the actual paths of specific games on a user's system. This module facilitates programmatic access to Steam games and applications.


## Installation

This documentation assumes that the module is distributed through PyPI. You can install it using the following command:

```command
pip install SteamPathFinder
```


## Basic Usage

Here's how you can use the Steam Path Finder module to find the Steam installation path, the path of a specific Steam application, and the path of a specific game:

```python
from SteamPathFinder import get_steam_path, get_app_path, get_game_path

def main():
    ##  Get the Steam installation path
    steam_path = get_steam_path()
    print(f"Steam path: {steam_path}")
    
    ##  Get the path for a specific application, e.g., a game's app id
    app_id = '1998340'  ##  The app id for the example game.
    game_name = 'Labyrinth of Galleria The Moon Society'  ##  The name of the game folder.

    app_path = get_app_path(steam_path, app_id)
    print(f"Application path: {app_path}")
    
    ##  Get the actual path of a specific game
    game_path = get_game_path(steam_path, app_id, game_name)
    print(f"Game path: {game_path}")

if __name__ == "__main__":
    main()
```


## Contributing

Interested in contributing to this project? Contributions are welcome! Here's how you can contribute:

1) Fork the project.
2) Create your feature branch (git checkout -b feature/AmazingFeature).
3) Commit your changes (git commit -m 'Add some AmazingFeature').
4) Push to the branch (git push origin feature/AmazingFeature).
5) Open a pull request.


## License

This project is licensed under the MIT License. For more details, see the LICENSE file.

## Contact

Email:
dlwlghks8779@naver.com
