Skip to content

Commit

Permalink
add language to readme code
Browse files Browse the repository at this point in the history
  • Loading branch information
Dezinater committed Oct 21, 2022
1 parent ad74c93 commit 3f54ffb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Install the RustWorldJS package into your project
npm install rustworld
```


## Usage

```
```javascript
import * as rustWorld from "rustworld";

import * as fs from "fs";
Expand All @@ -34,6 +35,7 @@ The package comes with Typescript definitions so if you are using Typescript you
- [get-terrainmap-info](https://github.com/Dezinater/RustWorldJS/tree/master/examples/get-terrainmap-info)
- [ice-walls](https://github.com/Dezinater/RustWorldJS/tree/master/examples/ice-walls)
## LZ4 Compression
The original [Rust.World SDK](https://github.com/Facepunch/Rust.World) and the game itself uses LZ4 compression for map reading and writing. They use a library called [lz4net](https://github.com/MiloszKrajewski/lz4net) which is now outdated and has a custom implementation of LZ4. RustWorldJS recreates and uses that same custom implementation of LZ4.
Expand Down

0 comments on commit 3f54ffb

Please sign in to comment.