Citizen of Arcanis

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:

• Explain your background and how you plan to resolve the issue.
• Provide an estimated timeframe for resolving the issue.
• For ODHacks, issue requests will only be considered through OnlyDust.

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:

• Clearly explain your proposed solution for any issue.
• Tasks will be assigned to those best suited to resolve them.

🔧 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:

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

Test in Unity

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

Troubleshooting

If you experience any issues:

• Double-check the Unity version.
• Verify the project settings in Edit > Project Settings.
• Contact the maintainers for further assistance.

🔄 Making Changes

5. Implement Your Changes

• Modify the codebase as needed.
• Test your changes to ensure the game works as expected.

6. Commit Your Changes

Stage and commit your changes with a descriptive message:

git add .
git commit -m "feat: added new cyberpunk map"

7. Push Your Changes

Push the branch to your fork:

git push origin branch-name

📤 Submitting a Pull Request

Once you're ready:

1. Open a Pull Request (PR) to the main repository.
2. Include:

• A descriptive title (match the issue name).
• A detailed explanation of your changes.
• References to related issues (if applicable).

Maintainers

Cristopher

Sebastian

Josué

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