Compendium-for-Games (BETA)

A SEGA type compendium where people can play game of their choice. The compendium contains many games and contains the feature to add new games - locally as well as globally to the server. It can also download new games from our cloud. The uploading of a game to the cloud through the software is managed by us to prevent uploading of infectious executable files.

Built on NodeJS using Electron.

Made by

1. Syed Ahsan Ahmed
2. Minhaj Ahmed Moin

Running the Software

For developers (compiling the Source Code)

1. cd [repo directory]
2. npm start the program should automatically start downloading node_modules inside the main directory.
3. If the program doesn't run and gives dependency error, use npm install [dependency]

For Users (non-developers) (running the software)

Download the Release Version.

Special instructions

1. Please don't change the contents in the text file as it has been used as a database for the software.
2. Dont rename the games in the "games" folder as it can cause the software to misbehave.
3. Don't seperate any file, including the software's exe, with the software folder.
4. If you want to place the software's exe on your desktop, place a shortcut of the software's exe.

Screenshots

Contributions

We are always open to contributions. If you want to become a Collaborator, send a pull request containing 10+ lines of scripting code.

Game Contributions

We want to collect as many games as possible for our software. So, if you have created a game, here is how you can add it to the software,

Instructions for contributing a game

1. Have a master folder named anything containing all the projects files (.exe, images, sprites, all media etc)
2. Compress the folder
3. fork this repository and add the compressed folder to this repository's "/games" folder.
4. Send a pull request.

Game Contributors

1. Minhaj Ahmed Moin (Bricrumble)