Skip to content

Home

Jump to bottom
Ibnus Nahiyan Samit edited this page Apr 30, 2025 · 2 revisions

Steel Ascendant Development Wiki

📑 Table of Contents

  1. Project Overview
  2. Project Architecture
  3. Development Guidelines
  4. Additional Resources

Project Overview

Steel Ascendant is a 2.5D boss fight game set in a cyberpunk universe. The game features intense combat mechanics, unique boss encounters, and vertical gameplay using a jetpack system.

Key Features

  • 🚀 Vertical combat with jetpack mechanics
  • 🎯 Play as the Boss against escalating BNS agents
  • 🎨 Cyberpunk-inspired 2.5D visuals

Technologies Used

Technology Version/Details
Unity 6000.0.32f1
Blender 3D Modeling and UV Unwraping
Substance Painter Texturing 3D Models
Illustrator UI & Background Image Development
Mixamo Character Animation
Rider IDE
C# Programming Language
UIToolkit UI Development

Requirements to Run the Project

  • Unity 6000.0.32f1
  • Git installed (for install package)

🏗️ Project Architecture

Directory Structure

Assets/
├── AddressableAssetsData/
├── Animations/
├── Art/
├── Audio/
├── Cutscene/
├── Environment/
├── Extra/
├── Font/
├── JMO Assets/
├── Language/
├── Materials/
├── Models/
├── ObjectData/
├── PlayerControls.inputactions
├── Post-Processing/
├── Prefabs/
├── Resources/
├── Scenes/
├── Scripts/
│   ├── Animation/
│   ├── Audio/
│   ├── Camera/
│   ├── Characters/
│   ├── Combat/
│   ├── Dialogue/
│   ├── Environment/
│   ├── Game/
│   ├── Input/
│   ├── Interface/
│   ├── Scene/
│   ├── UI/
│   ├── Weapon/
├── Settings/
├── Shaders/
├── Sprite/
├── Textures/
├── UI/
├── UI Toolkit/

Core Systems Implementation

1. Character Systems

  • Boss (Player): Assets/Scripts/Characters/BossController.cs (or similar)
  • Heroes (AI):
    • Assets/Scripts/Characters/HeroAI.cs
  • Hero Base: Assets/Scripts/Characters/Hero.cs

2. Game Management

  • Game Manager: Assets/Scripts/Game/GameManager.cs
  • Level Manager: Assets/Scripts/Game/LevelManager.cs
  • Scene Management:
    • Assets/Scripts/Scene/SceneManager.cs
    • Assets/Scripts/Game/MainMenuLoader.cs
    • Assets/Scripts/Game/SplashScreenLoader.cs
  • Dialogue System
    • Assets/Scripts/Dialogue/DialogueManager.cs

3. Combat Systems

  • Shooting: Assets/Scripts/Combat/ShootingController.cs
  • Health: Assets/Scripts/Combat/Health.cs
  • Special Abilities:
    • Assets/Scripts/Combat/Shield.cs
    • Assets/Scripts/Combat/Dash.cs
  • Projectiles: Assets/Scripts/Combat/Bullet.cs

4. Input System

  • Input Manager: Assets/Scripts/Input/InputManager.cs
  • Input Actions: Assets/PlayerControls.inputactions
  • Input Switching: Assets/Scripts/Input/SwitchInput.cs

5. UI Systems

  • Crosshair: Assets/Scripts/Game/CrossHair.cs
  • HUD: Assets/Scripts/UI/HUD.cs
  • Main Menu: Assets/Scripts/UI/MainMenu.cs
  • Pause Menu: Assets/Scripts/UI/PauseMenu.cs
  • Options Menu: Assets/Scripts/UI/OptionsMenu.cs
  • Level Selection: Assets/Scripts/UI/LevelSelectMenu.cs
  • Game Over Menu: Assets/Scripts/UI/GameOver.cs
  • Game Win Menu: Assets/Scripts/UI/GameWin.cs

6. Audio System

  • Audio Manager: Assets/Scripts/Audio/SoundManager.cs

7. Environment

  • Environmental Scripts: Assets/Scripts/Environment/

8. Animation

  • Animation Controllers: Assets/Scripts/Animation/

9. Camera

  • Cinemachine Target: Assets/Scripts/Camera/

10. Weapon Systems

  • Weapon Data: Assets/Scripts/Weapon/

Code Style

// Class naming convention
public class PlayerController : MonoBehaviour
{
    // Private fields with underscore prefix
    private float _moveSpeed;
    
    // Public properties with PascalCase
    public float Health { get; private set; }
    
    // Method naming convention
    private void HandleMovement()
    {
        // Implementation
    }
}

Best Practices

  1. Component Organization

    • Keep components modular and single-responsibility
    • Implement proper dependency injection

  2. Performance Optimization

    • Use Addressable for Scene loading
    • Implement proper memory management
    • Optimize physics calculations

  3. Debugging

    • Use Unity's Debug.Log for development

Version Control

  • Branch naming: feature/, bugfix/, hotfix/

Asset Guidelines

  • Naming conventions
  • File organization
  • Import settings

Code Standards

  • C# coding conventions
  • Unity-specific best practices
  • Documentation requirements
  • Performance considerations

📚 Additional Resources

Documentation

Clone this wiki locally