Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 5.19 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 5.19 KB
Raw

How to Contribute to PlaThyme

To integrate your Game into this platform. You need to add frontend part of your code to client folder and backend part of your code to server folder.

Build Your Game's Front End

Your game will certainly will have a frontend part to it. To integrate new game in this project. Follow these steps.

  1. Create New Folder with your Game_Name in Games folder. All game logic goes here. make sure this returns the game component to be displayed in GameRoom.

  2. Import your Game component in App.js.

  3. Add the Game Info in listofGames Dictionary present in App.js.

  4. Call your Game component inside renderGame switch case, present in App.js.

Build Your Game’s Back End

If your game is multiplayer, or requires a server to make decisions, keep score, relay messages between players, etc, you’ll need to build out a back end. For ease of game creation, we’ve made a class that your game can extend which you can use to encapsulate your game’s needs, as well as keeping our own server code clean. So I’ll cover all the changes each game must put in, and then I’ll cover the functionality of the Game class.

Detailed information about how Game class works and methods implemented in it can be found here

Below are the things required to be included in your game's back end.

1) ./server/index.js

There are only two changes you should make to this file. (For Example consider your game name is MyGame)

  • The first is to include your game's class from its javascript file. Which should be located in ./server/Games/ So in the include statements in the index.js file you sould include your file as such:
        const MyGame = require("./Games/MyGame");
  • The second is to add your game to the object creation switch statement. In the handleCreateGame function there is a switch statement where all game instances have their object created on the server side. So when someone creates a new instance of your game, the server creates an object and adds it to its tracking object. So what do you need to do? Using the gameId number that was created in the app.js file in the front end, switching on that gameId, create your game object. Example:
      case 5:
        games[roomCode] = new MyGameName(roomCode, socket, io, [data.name]);
        break;

The only thing you need to change about this statement is the case number (gameId), and the MyGameName must match the name of your game class. Of course, if you have additional parameters that need to be fed into your constructor, this is where that would be done.

2) ./server/Games/MyGame.js

Here's where you need to actually implement your back end.

  • This class must extend the Game class. So your first few lines should look like this:
     const Game = require("./Game");
     class MyGame extends Game {
       constructor(roomCode, socket, io, players) {
         super(roomCode, socket, io, players);
       }
       //add my game methods here
     }
     module.exports = MyGame;

So as you can see above, the MyGame class is extending the Game class, and calls its contructor. The rest of the actual game creation is up to you.

To aid you, the Game class has functionality to simplify communications, and integration with the rest of the site. The methods for that are described in the next section.

Detailed discription of Game.js methods is provided here.

Issues, Bug Report and Feature request

  • Go to Issues tab on top and click on new issue button. You will see two options, one for Bug report and other for Feature request click on your desired option and you can start typing. (you will find the desired Bug Report and Feature Request template, Please try to follow that, as it can help us clearly understand what you are saying)

How to do Pull Request

Have your own copy of PlaThyme. Fork the PlaThyme repo. Integrate your new game or modify the code to make it better, and when you are satisfied with your work and want us to integrate your work into PlaThyme. Come back to this original repo and follow these steps.

  • click on Pull requets tab present on top.

  • Click on New Request button

  • click on compare accross forks and you will find something like base repository: PlaThyme/PlaThyme base: PullRequest_Dev <-- head repository: your_name/PlaThyme compare: your_desired_branch and click on Create Pull Request button.

  • Congratulations you made your Pull Request Successfully

    Always choose base branch as PullRequest_Dev and not main

Disclaimer: You making pull request does not guarantee that we will add your code into PlaThyme. We will review it and test it and if we feel your changes are not conflicting anything on the base branch then we will let ypu know and integrate you changes or additions.

Code of Conduct

This project and everyone participating in it is governed by PlaThyme Code of Conduct. All contributors are required to follow it.