About
Cartridge is a convenient browser for your game collection with easy file downloads and automatically imported metadata and images. This project is designed to be self-hosted on your local server.
Roadmap
Cartridge is currently in development and not yet ready for use. Here's a rough to-do list for an alpha release:
Game importerGame browser & downloads- Game search
- User administration (create, edit, delete)
- Manual IGDB match fix
Development
Cartridge currently utilizes Laravel Sail for a convenient dev environment. By default, the app runs on port 80 and HMR runs on port 8080.
Requirements
- Composer
- Docker
- Docker Compose
- API key from IGDB
Instructions
- Clone the repository.
git clone https://github.com/jamjnsn/cartridge.git
- Install dependencies
composer install
- Create
.env
file.# Volumes GAMES_PATH=/path/to/roms # IGDB credentials TWITCH_CLIENT_ID=Your Client ID TWITCH_CLIENT_SECRET=Your Client Secret
- Start containers with Sail.
alias sail="bash vendor/bin/sail" # Optional: add alias to your shell profile sail up -d
- Initialize application.
sail artisan cart:init
- Start HMR.
sail npm run watch