BEWARE: Project postponed indefinitely!

This project's main goal was to familiarize with Vue and that goal was achieved. We may one day return to this project and finish it. Although it is very unlikely.
If you want us to continue on this project, let us know, or contribute!

OGL | Open Gamers' Library

Lightweight game library to manage your DRM-free games in your computer.

Project goals

The final application should be:

• simple
• visually eye pleasing
• cross-platform
• customizable

Consumers should gain:

• cool-looking library for your games
• easily add your games
• organize and rate your games
• small portable or non-admin install
• easily backup your configs and metadata

Developers should gain:

• knowledge of electron
• knowledge of continuous integration (CI)
• knowledge of automatic artifacts releasing (CD)
• sense of pride and accomplishment 🏆

Installing

Follow link to Releases and follow instructions to download and install OGL for many platforms.

Supported platforms

• Windows
  • Exe setup
    • user-install to AppData (Admin rights NOT required)
    • machine-install to Program Files (All Users)
  • Portable exe
• macOS
  • DMG
  • Pkg
• Linux
  • AppImage
  • Flatpak
  • RPM
  • deb
  • snap
  • pacman
• All platforms
  • Zip
  • Source code

Updating

• Automatic updates for Windows (Exe installer) and Linux (AppImage)

• Download new version from Github

Using

• install/launch downloaded application and start using it!
• customize background colors/wallpaper
• select source games folder, insert metadata (manually or automatically)
• browse, filter, rate and play your games

For more information head over to Wiki

Contributing

As a user, you can contribute by posting ideas and feature requests to Github Issues

As a developer, you can contribute just like to any other project, simply by taking over some task in Github Issues, either feature requests, or fixing bugs.

Everyone has to read and follow our Code of conduct and Contributing guidance.

Source code is being linted upon Push or Pull requests and CI will fail if format breaks format rules. We follow StandardJS rules as they are standardized, quite simple and there are tools to easily format our code automatically.

Forking repo and developing

1. git clone https://github.com/houby-studio/open-gamers-library.git
2. sudo yarn global add @vue/cli
3. yarn install
4. vue add electron-builder
5. debug, build and contribute!