SunsetLabs-Game / Citizen-of-Arcanis-FrontEnd

Welcome to Citizen of Arcanis, a fully on-chain MMORPG
MIT License
2 stars 13 forks source link

Citizen of Arcanis

Citizen of Arcanis Banner

Welcome to Citizen of Arcanis, a fully on-chain MMORPG set in a vast cyberpunk universe where players control everything — from the economy to combat and survival. This repository contains the Unity Frontend for the game.

🌟 How to Contribute

We deeply appreciate your interest in contributing to the Citizen of Arcanis project! Below are the steps to help you get started effectively. Join our contributors' community by connecting with us on Telegram.

1. Issue Requests

To request or address issues:

2. Unity Experience

We prefer contributors with Unity experience. If you're a beginner but eager to learn, you're still welcome! In either case:

🔧 Getting Started

  1. Fork the Repository Fork the repository to your GitHub account.

  2. Clone Your Fork Clone the repository locally:

    git clone https://github.com/your-username/CitizenOfArcanisFrontend.git
    cd CitizenOfArcanisFrontend

    3. Create a New Branch

    Use our branch naming conventions:

Type Naming Convention Example
Bug fixes bugfix-issue-name bugfix-login-error
New features feat-feature-name feat-new-marketplace
Documentation docs-update-description docs-readme-update
Refactoring refactor-description refactor-ui-cleanup

Steps to create a branch:

  1. Use the appropriate naming convention.
  2. Example command:
    git checkout -b feat-new-marketplace

4. Running the Project in Unity

To run the project on your PC, follow these steps. Note that the project is intended for PC but is only tested within Unity’s Game window.

Install Unity:

  1. Download and install Unity.
  2. Use version 2022.3.28.f1 for compatibility.

    Open the Project in Unity Hub:

  3. Open Unity Hub and load the project folder.
  4. Make sure you’re using the specified Unity version: 2022.3.28.f1.

    Test in Unity

  5. Open the Game window within Unity’s editor to test the project.
  6. Interact with the game directly from the Game window (no external builds required).

    Troubleshooting

    If you experience any issues:

🔄 Making Changes

5. Implement Your Changes

In Citizen of Arcanis, the world isn’t just yours to explore—it’s yours to control!