https://github.com/keyur-gondaliya/npm-3d-sun

3D Sun Model With Small Star System For website Background or Better Website Appearance.
https://github.com/keyur-gondaliya/npm-3d-sun

react threejs typescript

Last synced: 4 days ago
JSON representation

3D Sun Model With Small Star System For website Background or Better Website Appearance.

• Host: GitHub
• URL: https://github.com/keyur-gondaliya/npm-3d-sun
• Owner: Keyur-Gondaliya
• Created: 2023-10-01T04:56:29.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-07T17:20:23.000Z (about 1 year ago)
• Last Synced: 2024-10-31T19:52:38.320Z (15 days ago)
• Topics: react, threejs, typescript
• Language: TypeScript
• Homepage: https://codesandbox.io/s/cold-firefly-7msdd2
• Size: 1.53 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @keyur-gondaliya/3d-sun

3D Sun is a React component that renders an interactive 3D representation of the sun. You can also provide custom as per needed. It is Three.js Based package so make sure you have it installed already.

## Installation

```bash

npm install @keyur-gondaliya/3d-sun three

```

## Usage

```bash

import React from 'react';

import { ThreeScene }  from '@keyur-gondaliya/3d-sun';

const YourComponent = () => {

  return (

    


      

    

  );

};


export default YourComponent;

```

## Props

```bash

backgroundImage (string)

URL for the background image.

sunUVLayoutImage (string)

URL for the sun's UV layout image.

sunTextureImage (string)

URL for the sun's texture image.

disableBackground (boolean)

Default: false

Set to true to disable the background.

starCount (number)

Range: 0 to 100000

Number of stars to be displayed.

rotationSpeed (number)

Range: 0 to 1

Speed of the sun's rotation.

orbitColor (number)

Color input in the hexadecimal format. Example: 0xff0000 (Red)

```

## Example

```bash

```

Make sure to provide valid image URLs for backgroundImage, sunUVLayoutImage, and sunTextureImage.

For further customization and functionality, explore the props and their expected values.

### Happy coding!