Skip to content

README.md

Latest commit

 

History

History
60 lines (41 loc) · 2.64 KB

README.md

File metadata and controls

60 lines (41 loc) · 2.64 KB

Skrull

A simple card game built with Unity and Playroomkit. This project is inspired by ideas detailed in the Skrull GDD.

  • Project made with Unity 6000.0.27f1

Game Link:
https://skrull.playroom.gg

Overview

Skrull is designed as a straightforward card game experience implemented in Unity. It leverages Playroomkit for multiplayer. This repository contains all the source code, assets, and project settings needed to run and modify the game.

How to Use this Repository

  1. Clone the Repository

    git clone https://github.com/grayhatdevelopers/skrull-prototype.git

  2. Open the Project in Unity

    • Launch Unity Hub.
    • Click on Add and navigate to the cloned repository’s folder.
    • Note: Project is made with Unity 6000.0.27f1
    • Open the project using the Unity version specified in the repository (refer to the project settings if necessary).

  3. Install Dependencies

    • Ensure you have Playroomkit installed by following their documentation.
    • Project also uses UnityHFSM but it is optional, you can use any way to handle game flow.

  4. Run the Game

    • Open the Template scene which is in the _project/scenes folder
    • Click the Play button in the Unity Editor to test the game.
    • Use Unity’s build Settings to compile the project for your target platform.

The repository is organized as follows:

  • Assets/

    • _projects/
      This Folder contains everything about the project

      • Scripts/
        Contains the game logic and gameplay scripts. Each script includes inline comments documenting the code functionality.

      • Scenes/
        Contains the game scene, the template is in template.unity.

Deployment:

  • Create an account on the dev portal and sign in.
  • Create a new project on the dev portal, and to host just drag and drop the game build files in the hosting tab.
  • Make sure to follow the recommended settings before building the game .
  • For making a discord activity, check the discord activity tab in dev portal for your project for instructions.

Need more?

Happy Jaming!