Skip to content

Commit

Permalink
Make ready for release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mvriel committed Jul 27, 2023
1 parent 1dd8eb3 commit 6635cf5
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this package will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [1.0.0] - 2023-07-27

### Added

Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Sun, Time of Day and Shadows

This package contains the means to add a near-realistic Day/Night cycle to your project. This will allow for
shadow simulations that reflect the time of day and day in a specific year.

Please note that this package is specific for the Universal Render Pipeline (URP) as the shadow manipulation
modifies your render pipeline to make the shadow length as realistic as possible.

## Installing

This package is provided through OpenUPM, to install it using the CLI you can perform the following:

```bash
$ openupm add eu.netherlands3d.sun
```

or, you have to add `https://package.openupm.com` as a scoped registry with, at least, the following scopes:

- `eu.netherlands3d`

## Usage

> Please note that for this package to work as expected, you need to have the Origin set up from the
> Coordinates package.
The easiest path is to use the Sun prefab that is included and

1. Hook up the Directional Light that is representing your sun to the Suntime script.
2. Hook up your UniversalRenderPipeline to the DynamicShadowDistance script.

After this, the script will automatically alter the Sun's position according to the specified date and time. These

When using real-world positions, please consult the Coordinates package how to configure the position of 0,0,0 in
worldspace to match a specific point in the real world.
3 changes: 3 additions & 0 deletions README.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
"netherlands3d"
],
"license": "EUPL-1.2",
"documentationUrl": "https://github.com/Amsterdam/Netherlands3D/blob/main/Packages/nl.netherlands3d.authentication/README.md",
"licensesUrl": "https://github.com/Amsterdam/Netherlands3D/blob/main/Packages/nl.netherlands3d.authentication/LICENSE.txt",
"changelogURL": "https://github.com/Amsterdam/Netherlands3D/blob/main/Packages/nl.netherlands3d.authentication/CHANGELOG.md",
"documentationUrl": "https://github.com/Netherlands3D/Sun/blob/main/README.md",
"licensesUrl": "https://github.com/Netherlands3D/Sun/blob/main/LICENSE.txt",
"changelogURL": "https://github.com/Netherlands3D/Sun/blob/main/CHANGELOG.md",
"author": {
"name": "Netherlands3D",
"url": "https://netherlands3d.eu"
Expand Down

0 comments on commit 6635cf5

Please sign in to comment.