Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ontrigger committed Jul 5, 2021
1 parent 5278dda commit 3fc5df7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Changes in 0.5.0

* Object pooling makes loading vegetation in new and old chunks much smoother

# Changes in 0.4.2

* Fixed incompatibility with EpicLoot
Expand Down
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,34 @@

Rendering, logic, and loading time optimizations for both client and server versions of Valheim.

## Changes in 0.4.2
You can use the mod on either the server or the client, or both, it should work regardless.

* Fixed incompatibility with EpicLoot
## New in 0.5.0

## New in 0.4.0
* Object pooling makes loading vegetation in new and old chunks much smoother

* Threaded terrain collision generation decreases stutters when loading chunks
* Smoke rendering performance improvements
Rest of the changes can be found in `CHANGELOG.md`

## Stats

* 5-10 ms faster GPU render times in bases (3 fps without the mod -> 15 fps with)
* General game stability improvements - less stutters in bases
* 20+ seconds faster world loading times, especially for big worlds (excluding the first launch)
* Less stutters when loading new terrain
* General game logic performance improvements (no concrete data on framerates)

## Development Setup
## Configuration

Create a file called `Environment.props` inside the project base and change the Valheim install path to your location.
The mod config is stored in the `dev.ontrigger.vpo.cfg` file.

Most optimizations done by the mod do not affect the gameplay in any way,
however some of its optimizations might cause compatibility issues with other mods.
If you see terrain or specific objects suddenly disappear, try disabling stuff in the config.

## Manually compiling the mod

In order to manually compile the source code of the mod,
create a file called `Environment.props` inside the project base and change the Valheim install path to your location.

```
<?xml version="1.0" encoding="utf-8"?>
Expand Down

0 comments on commit 3fc5df7

Please sign in to comment.