Git Product home page Git Product logo

compendium-for-games's Introduction

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

Compendium for games
Compendium for games
Compendium for games
Compendium for games
Compendium for games
Compendium for games

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)

compendium-for-games's People

Contributors

ahsansn avatar minhajmoin avatar

Stargazers

 avatar

Watchers

 avatar  avatar

compendium-for-games's Issues

select exe name from database

Edit the "js/renderer.js", such that when a game is selected, the path of the selected game should not be dynamically made, but should be selected from "GamesDB.txt". Make necessary functions in database.js

Add .vs to .gitignore

I have tried literally everything but I cant get the .gitignore to ignore my .vs</code> folder. Serious help is needed here.

Get username of the loggedin user

Create a function getUsername() inside uploadGame.js that returns the computers username. This will later be used when uploading the game to the cloud using the software.

add gameRunning.html

Add another screen "gameRunning.html" that should run once an exe has started running. It should contain a return option that sends the user to "viewGames.html"

space for showing the screenshot

Edit the viewgames.css and viewgames.html such that the viewgames.html is divided into two vertical parts. One contains the list of games as in the present code, and the other will have space for 1 screenshot of the game.

Create shortcut on desktop

Create necessay file and functions that are run when the software is run. The file will check if there is a software's shortcut on the user's desktop. If not, it will create the exe's shortcut.

load all static files in beginning

Take advantage of asynchronous programming and load all static files (css/js) from main.js instead of the respective .html files. This should reduce the loading time of the software.

take screenshot as input

Edit uploadgame.html and uploadgame.js and add an option of uploading 1 screenshot image of the image. This image path should then be added to the database.

electron-db as the new database

Use "electron-db" as the software's database instead of GamesDB.txt. Replace all the present functions. Create a new file e-Database.js and dont edit the current database.js.

Escape html special characters

Escape all types of html special characters in the uploadgame.js such that Javascript and HTML injection is not possible.

Find .exe file in folder

Create a function inside "js/renderer.js" can takes a folder name as input, and returns the static path (C:/...) of the the .exe file present in it. You are told that the folder will always contain one and only one .exe file.

show screenshot in alloted space

(linked to issue 2)

Create a function in renderer.js that takes as input the path of an image file and shows it as the screenshot of the present game.

store screenshots in database

Edit the database.js such that now GamesDB.txt stores 4 values instead of 3. The new stored value (4th line in database)should be an image path. Make new functions if required.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.