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

Boilerplate for a Card Game built with Unity and PlayroomKit
https://github.com/grayhatdevelopers/skrull-prototype

boilerplate game game-development playroom playroom-kit playroomkit unity unity3d

Last synced: 9 months ago
JSON representation

Boilerplate for a Card Game built with Unity and PlayroomKit

• Host: GitHub
• URL: https://github.com/grayhatdevelopers/skrull-prototype
• Owner: grayhatdevelopers
• Created: 2025-02-03T10:20:01.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-16T13:49:57.000Z (11 months ago)
• Last Synced: 2025-04-16T15:36:41.518Z (11 months ago)
• Topics: boilerplate, game, game-development, playroom, playroom-kit, playroomkit, unity, unity3d
• Language: JavaScript
• Homepage:
• Size: 4.16 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Skrull 

A simple card game built with [Unity](https://unity.com/) and [Playroomkit](https://github.com/playroomkit/Playroomkit). This project is inspired by ideas detailed in the [Skrull GDD](https://gifted-punch-51c.notion.site/Skrull-GDD-1812d76eeeaa808aaca5fff530310cd9?pvs=74).

- 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**

    ```bash

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

    ```

2. **Open the Project in Unity**

    - Launch [Unity Hub](https://unity.com/download).

    - 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](https://github.com/playroomkit/unity) installed by following their documentation.

    - Project also uses [UnityHFSM](https://github.com/Inspiaaa/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](https://dev.joinplayroom.com) 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](https://docs.joinplayroom.com/usage/unity#4-exporting-to-webgl) before building the game .

- For making a discord activity, check the `discord activity` tab in dev portal for your project for instructions.

## Need more?

- Getting started with [Playroom Unity](https://docs.joinplayroom.com/usage/unity).

- Playroom Unity API ref: https://docs.joinplayroom.com/apidocs/unity

Happy Jaming!