Skip to content

README.md

Latest commit

 

History

History
49 lines (33 loc) · 1.6 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.6 KB

3D Museum Project

A virtual 3D museum for displaying artwork, built with Unity URP.

Development Setup

  1. Install Unity 2021.3 LTS or later
  2. Clone this repository
  3. Open the project in Unity

CI/CD Pipeline

This project uses GitHub Actions for continuous integration and deployment:

Automated Builds

  • Push Builds: Triggered whenever code is pushed to the main branch
  • Nightly Builds: Run automatically at 2 AM UTC every day
  • Pull Request Checks: Test builds are performed for every pull request

Workflow Details

The automated pipeline:

  1. Checks out the latest code
  2. Builds the project for Windows (Standalone) and WebGL
  3. Archives the builds as artifacts
  4. Deploys WebGL builds to the hosting service (for main branch and nightly builds)

Setting up Unity License

To enable the Unity builds in GitHub Actions, you need to set up a Unity license:

  1. Generate a Unity license using Unity - How to activate Unity License
  2. Add the license to your GitHub repository as a secret named UNITY_LICENSE

Project Structure

  • Assets/Artworks/ - Storage for art pieces (2D paintings, 3D models)
  • Assets/Audio/ - Sound effects, ambient music, narration
  • Assets/Materials/ - Materials for 3D objects
  • Assets/Models/ - 3D models for the museum environment
  • Assets/Prefabs/ - Reusable objects
  • Assets/Scenes/ - Museum rooms and environments
  • Assets/Scripts/ - Code for museum functionality
  • Assets/UI/ - Interface elements for information displays

Deployment

WebGL builds are automatically deployed to [your-deployment-url-here].