README

A Laravel package for managing Steam application data in your database. This package provides functionality to import Steam apps, fetch detailed information, and retrieve news for Steam games.

Introduction

Laravel Steam Apps DB provides a set of tools to work with Steam application data in your Laravel application. It allows you to:

Import basic information about all Steam applications
Fetch detailed information about specific Steam games
Retrieve and store news articles for Steam games
Access Steam app data through Eloquent models

The package handles all the database schema creation and provides console commands to interact with the Steam API.

Installation

Requirements

PHP 8.0 or higher
Laravel 10.x, 11.x, or 12.x

Installation Steps

Install the package via Composer:

composer require artryazanov/laravel-steam-apps-db

The package will automatically register its service provider if you're using Laravel's package auto-discovery.
Publish and run the migrations:

php artisan migrate

Usage

Console Commands

The package provides three main console commands:

1. Import Steam Apps

This command imports basic information about all Steam applications from the Steam API.

php artisan steam:import-apps

This will fetch a list of all Steam applications and store them in the steam_apps table.

2. Fetch Steam App Details

This command fetches detailed information about Steam games and stores it in the database.

php artisan steam:fetch-app-details [count] [--appid=<appid>]

Parameters:

count (optional): Number of apps to process (default: 10)
--appid (optional): Steam application ID to fetch details for a specific app

The command prioritizes:

Apps that have never had details fetched
Apps with details older than a year

If the --appid option is provided, the command will only fetch details for the specified app, ignoring the count parameter and prioritization logic.

Examples:

# Fetch details for 50 Steam apps based on priority
php artisan steam:fetch-app-details 50

# Fetch details for a specific Steam app with ID 570 (DOTA 2)
php artisan steam:fetch-app-details --appid=570

This will fetch detailed information for the specified Steam app(s) and store it in various tables.

3. Fetch Steam App News

This command fetches the latest news for Steam apps and stores them in the database.

php artisan steam:fetch-app-news [count] [--appid=<appid>]

Parameters:

count (optional): Number of apps to process (default: 10)
--appid (optional): Steam application ID to fetch news for a specific app

The command prioritizes:

Apps that have never had news fetched
Apps with news older than a month

If the --appid option is provided, the command will only fetch news for the specified app, ignoring the count parameter and prioritization logic.

Examples:

# Fetch news for 20 Steam apps based on priority
php artisan steam:fetch-app-news 20

# Fetch news for a specific Steam app with ID 570 (DOTA 2)
php artisan steam:fetch-app-news --appid=570

This will fetch the latest news for the specified Steam app(s) and store it in the steam_app_news table.

Models

The package provides several Eloquent models to interact with the stored data:

Main Models

SteamApp: The core model representing a Steam application
SteamAppDetail: Detailed information about a Steam app
SteamAppNews: News articles for a Steam app

Related Models

SteamAppCategory: Categories for Steam apps
SteamAppGenre: Genres for Steam apps
SteamAppDeveloper: Developers of Steam apps
SteamAppPublisher: Publishers of Steam apps
SteamAppRequirement: System requirements for different platforms
SteamAppScreenshot: Screenshots for Steam apps
SteamAppMovie: Videos/trailers for Steam apps
SteamAppPriceInfo: Price information for Steam apps

Example Usage

use Artryazanov\LaravelSteamAppsDb\Models\SteamApp;

// Get all Steam apps
$apps = SteamApp::all();

// Get a specific app by Steam appid
$app = SteamApp::where('appid', 570)->first(); // DOTA 2

// Get detailed information
$details = $app->detail;

// Get system requirements
$requirements = $app->requirements;

// Get screenshots
$screenshots = $app->screenshots;

// Get categories
$categories = $app->categories;

// Get genres
$genres = $app->genres;

// Get developers
$developers = $app->developers;

// Get publishers
$publishers = $app->publishers;

// Get price information
$priceInfo = $app->priceInfo;

// Get news articles
$news = $app->news;

Database Schema

The package creates the following tables:

steam_apps - Main table with basic app info
steam_app_details - Detailed information about each app
steam_app_requirements - System requirements for different platforms
steam_app_screenshots - Screenshots for each app
steam_app_movies - Videos/trailers for each app
steam_app_categories - Categories reference table
steam_app_category - Pivot table for app-category relationship
steam_app_genres - Genres reference table
steam_app_genre - Pivot table for app-genre relationship
steam_app_developers - Developers reference table
steam_app_developer - Pivot table for app-developer relationship
steam_app_publishers - Publishers reference table
steam_app_publisher - Pivot table for app-publisher relationship
steam_app_price_info - Price information for each app
steam_app_news - News items for each app

Testing

The package includes tests for all its functionality. To run the tests, you can use either of the following methods:

# Using Composer script
composer test

# Using PHPUnit directly
vendor/bin/phpunit

License

This package is open-sourced software licensed under the Unlicense.

artryazanov / laravel-steam-apps-db

Maintainers

Details