Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.26 KB

README.md

File metadata and controls

63 lines (39 loc) · 2.26 KB

PixelDock

Dive into PixelDock, with a vast selection of games combined with community-driven enhancements. Experience seamless, secure gaming in a single universal hub.

PixelDock is built with the cutting-edge technology of Tauri and SvelteKit, PixelDock offers an unparalleled gaming experience that's fast, secure, and cross-platform.

Disclaimer

The project provided here is for educational purposes only.

Features

Whilst the project is still under the development, we have a lot of features in the works. Such as:

  • A variety of tools to organise your game collection
  • A built-in torrent client
  • Let you download games in
  • Library to save your downloaded games and launch it.
  • An API to allow the community to make third-party plugins
  • And much more in the future...

Getting Started

To get started with PixelDock, follow these steps:

  1. Clone the repository: git clone https://github.com/PixelDockTeam/PixelDock.git
  2. Follow the prerequisites for setting up Tauri and SvelteKit as outlined in the Tauri Getting Started Guide.
  3. Install dependencies: bun install
  4. Launch the development server: bun tauri dev

Environment Variables

To run PixelDock, you'll need to set up the following environment variables:

IGDB (Twitch)

Contributing

We welcome contributions to PixelDock! If you are looking for ways to contribute, here are some options:

  • Helping us write and improve the documentation
  • Writing code which you feel could improve the project
  • Helping us with bug-testing on pre-releases

If you can't help us with any of this, no worries! We just appreciate that you're here along for the ride :D

Acknowledgments

Thanks to everyone who helps us make this possible. A list of contributors can be found here.

Contact

For support, feature requests, or contributions, please visit our GitHub repository